Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / cloudsearch_v1.settings.searchapplications.html
blob: 5673be7a599d940ad63860237bd6ec6b96e93fb9 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.settings.html">settings</a> . <a href="cloudsearch_v1.settings.searchapplications.html">searchapplications</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Creates a search application.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a search application.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the specified search application.</p>
86<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]87 <code><a href="#list">list(debugOptions_enableDebugging=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Lists all search applications.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Resets a search application to default settings. This will return an empty</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Updates a search application.</p>
98<h3>Method Details</h3>
99<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]100 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101 <pre>Creates a search application.
102
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103**Note:** This API requires an admin account to execute.
104
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107 The object takes the form of:
108
109{ # SearchApplication
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]110 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
111 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on.
112 # The corresponding property must be marked as
113 # sortable.
114 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
115 },
116 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application.
117 # &lt;br /&gt;Format: searchapplications/{application_id}.
118 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
119 # schema. Output only field.
120 &quot;A String&quot;,
121 ],
122 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application.
123 # The maximum length is 300 characters.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]124 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations.
125 # The maximum number of elements is 10.
126 { # Restriction on Datasource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]127 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
128 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
129 # Indexing API.
130 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
131 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]132 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters
133 # are present, they are grouped by object type before joining.
134 # Filters with the same object type are joined conjunctively, then
135 # the resulting expressions are joined disjunctively.
136 #
137 # The maximum number of elements is 20.
138 #
139 # NOTE: Suggest API supports only few filters at the moment:
140 # &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;.
141 # For now, schema specific filters cannot be used to filter suggestions.
142 { # Filter options to be applied on query.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]143 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should
144 # correspond to the name of the object that was registered within the
145 # definition of schema. The maximum length is 256 characters.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]146 &quot;filter&quot;: { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
147 # approaches: &lt;br/&gt;&lt;br/&gt;
148 # **1. Setting a ValueFilter.** The name must match an operator_name defined in
149 # the schema for your data source.
150 # &lt;br/&gt;
151 # **2. Setting a CompositeFilter.** The filters are evaluated
152 # using the logical operator. The top-level operators can only be either an AND
153 # or a NOT. AND can appear only at the top-most level. OR can appear only under
154 # a top-level AND.
155 &quot;compositeFilter&quot;: {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]156 &quot;subFilters&quot;: [ # Sub filters.
157 # Object with schema name: Filter
158 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]159 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]160 },
161 &quot;valueFilter&quot;: {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]162 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
163 &quot;integerValue&quot;: &quot;A String&quot;,
164 &quot;stringValue&quot;: &quot;A String&quot;,
165 &quot;booleanValue&quot;: True or False,
166 &quot;dateValue&quot;: { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
167 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
168 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
169 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
170 },
171 &quot;timestampValue&quot;: &quot;A String&quot;,
172 &quot;doubleValue&quot;: 3.14,
173 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]174 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*.
175 # The filter can work against both types of filters defined in the schema
176 # for your data source:
177 # &lt;br/&gt;&lt;br/&gt;
178 # 1. `operator_name`, where the query filters results by the property
179 # that matches the value.
180 # &lt;br/&gt;
181 # 2. `greater_than_operator_name` or `less_than_operator_name` in your
182 # schema. The query filters the results for the property values that are
183 # greater than or less than the supplied value in the query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]184 },
185 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]186 },
187 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]188 },
189 ],
190 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
191 { # Configurations for a source while processing a
192 # Search or
193 # Suggest request.
194 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
195 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
196 # Indexing API.
197 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
198 },
199 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
200 # for a source.
201 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
202 },
203 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
204 # multiple results from the same source or host &quot;crowd out&quot; other results,
205 # diminishing the quality of search for users. To foster better search quality
206 # and source diversity in search results, you can set a condition to reduce
207 # repetitive results by source.
208 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source.
209 # No limits will be set on results if this value is less than or equal to 0.
210 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source.
211 # No limits will be set on results if this value is less than or equal to 0.
212 },
213 },
214 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]215 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a # Configuration for ranking results.
216 # Search or
217 # Suggest request.
218 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used
219 # as a ranking signal. Note that this setting is not available in the Admin
220 # UI.
221 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will
222 # be used to boost results.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]223 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]224 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results.
225 # The sources specified here also have been included in
226 # data_source_restrictions
227 # above.
228 { # Specifies operators to return facet results for. There will be one
229 # FacetResult for every source_name/object_type/operator_name combination.
230 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet.
231 # Defaults to 10.
232 # Maximum value is 100.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]233 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see
234 # cloudsearch.SchemaPropertyOptions
235 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to
236 # compute facets. If empty, then all objects will be used to compute facets.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]237 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id}
238 # If empty, all data sources will be used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]239 },
240 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241}
242
243 x__xgafv: string, V1 error format.
244 Allowed values
245 1 - v1 error format
246 2 - v2 error format
247
248Returns:
249 An object of the form:
250
251 { # This resource represents a long-running operation that is the result of a
252 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]253 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]254 # method returns no data on success, such as `Delete`, the response is
255 # `google.protobuf.Empty`. If the original method is standard
256 # `Get`/`Create`/`Update`, the response should be the resource. For other
257 # methods, the response should have the type `XxxResponse`, where `Xxx`
258 # is the original method name. For example, if the original method name
259 # is `TakeSnapshot()`, the inferred response type is
260 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]261 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]262 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]263 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
264 # contains progress information and common metadata such as create time.
265 # Some services might not provide such metadata. Any method that returns a
266 # long-running operation should document the metadata type, if any.
267 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
268 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]269 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]270 # different programming environments, including REST APIs and RPC APIs. It is
271 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
272 # three pieces of data: error code, error message, and error details.
273 #
274 # You can find out more about this error model and how to work with it in the
275 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]276 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]277 # message types for APIs to use.
278 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]279 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]280 },
281 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]282 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
283 # user-facing error message should be localized and sent in the
284 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]285 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]286 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]287 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
288 # originally returns it. If you use the default HTTP mapping, the
289 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]290 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
291 # If `true`, the operation is completed, and either `error` or `response` is
292 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]293 }</pre>
294</div>
295
296<div class="method">
297 <code class="details" id="delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
298 <pre>Deletes a search application.
299
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]300**Note:** This API requires an admin account to execute.
301
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]302Args:
303 name: string, The name of the search application to be deleted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]304&lt;br /&gt;Format: applications/{application_id}. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]305 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
306Otherwise, ignore this field.
307 x__xgafv: string, V1 error format.
308 Allowed values
309 1 - v1 error format
310 2 - v2 error format
311
312Returns:
313 An object of the form:
314
315 { # This resource represents a long-running operation that is the result of a
316 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]317 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]318 # method returns no data on success, such as `Delete`, the response is
319 # `google.protobuf.Empty`. If the original method is standard
320 # `Get`/`Create`/`Update`, the response should be the resource. For other
321 # methods, the response should have the type `XxxResponse`, where `Xxx`
322 # is the original method name. For example, if the original method name
323 # is `TakeSnapshot()`, the inferred response type is
324 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]325 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]326 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]327 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
328 # contains progress information and common metadata such as create time.
329 # Some services might not provide such metadata. Any method that returns a
330 # long-running operation should document the metadata type, if any.
331 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
332 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]333 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 # different programming environments, including REST APIs and RPC APIs. It is
335 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
336 # three pieces of data: error code, error message, and error details.
337 #
338 # You can find out more about this error model and how to work with it in the
339 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]340 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]341 # message types for APIs to use.
342 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]343 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]344 },
345 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]346 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
347 # user-facing error message should be localized and sent in the
348 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]349 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]350 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]351 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
352 # originally returns it. If you use the default HTTP mapping, the
353 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]354 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
355 # If `true`, the operation is completed, and either `error` or `response` is
356 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357 }</pre>
358</div>
359
360<div class="method">
361 <code class="details" id="get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
362 <pre>Gets the specified search application.
363
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]364**Note:** This API requires an admin account to execute.
365
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]366Args:
367 name: string, Name of the search application.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]368&lt;br /&gt;Format: searchapplications/{application_id}. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]369 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
370Otherwise, ignore this field.
371 x__xgafv: string, V1 error format.
372 Allowed values
373 1 - v1 error format
374 2 - v2 error format
375
376Returns:
377 An object of the form:
378
379 { # SearchApplication
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]380 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
381 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on.
382 # The corresponding property must be marked as
383 # sortable.
384 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
385 },
386 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application.
387 # &lt;br /&gt;Format: searchapplications/{application_id}.
388 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
389 # schema. Output only field.
390 &quot;A String&quot;,
391 ],
392 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application.
393 # The maximum length is 300 characters.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]394 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations.
395 # The maximum number of elements is 10.
396 { # Restriction on Datasource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]397 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
398 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
399 # Indexing API.
400 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
401 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]402 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters
403 # are present, they are grouped by object type before joining.
404 # Filters with the same object type are joined conjunctively, then
405 # the resulting expressions are joined disjunctively.
406 #
407 # The maximum number of elements is 20.
408 #
409 # NOTE: Suggest API supports only few filters at the moment:
410 # &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;.
411 # For now, schema specific filters cannot be used to filter suggestions.
412 { # Filter options to be applied on query.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]413 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should
414 # correspond to the name of the object that was registered within the
415 # definition of schema. The maximum length is 256 characters.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]416 &quot;filter&quot;: { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
417 # approaches: &lt;br/&gt;&lt;br/&gt;
418 # **1. Setting a ValueFilter.** The name must match an operator_name defined in
419 # the schema for your data source.
420 # &lt;br/&gt;
421 # **2. Setting a CompositeFilter.** The filters are evaluated
422 # using the logical operator. The top-level operators can only be either an AND
423 # or a NOT. AND can appear only at the top-most level. OR can appear only under
424 # a top-level AND.
425 &quot;compositeFilter&quot;: {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]426 &quot;subFilters&quot;: [ # Sub filters.
427 # Object with schema name: Filter
428 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]429 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]430 },
431 &quot;valueFilter&quot;: {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]432 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
433 &quot;integerValue&quot;: &quot;A String&quot;,
434 &quot;stringValue&quot;: &quot;A String&quot;,
435 &quot;booleanValue&quot;: True or False,
436 &quot;dateValue&quot;: { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
437 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
438 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
439 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
440 },
441 &quot;timestampValue&quot;: &quot;A String&quot;,
442 &quot;doubleValue&quot;: 3.14,
443 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]444 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*.
445 # The filter can work against both types of filters defined in the schema
446 # for your data source:
447 # &lt;br/&gt;&lt;br/&gt;
448 # 1. `operator_name`, where the query filters results by the property
449 # that matches the value.
450 # &lt;br/&gt;
451 # 2. `greater_than_operator_name` or `less_than_operator_name` in your
452 # schema. The query filters the results for the property values that are
453 # greater than or less than the supplied value in the query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]454 },
455 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]456 },
457 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]458 },
459 ],
460 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
461 { # Configurations for a source while processing a
462 # Search or
463 # Suggest request.
464 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
465 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
466 # Indexing API.
467 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
468 },
469 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
470 # for a source.
471 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
472 },
473 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
474 # multiple results from the same source or host &quot;crowd out&quot; other results,
475 # diminishing the quality of search for users. To foster better search quality
476 # and source diversity in search results, you can set a condition to reduce
477 # repetitive results by source.
478 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source.
479 # No limits will be set on results if this value is less than or equal to 0.
480 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source.
481 # No limits will be set on results if this value is less than or equal to 0.
482 },
483 },
484 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]485 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a # Configuration for ranking results.
486 # Search or
487 # Suggest request.
488 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used
489 # as a ranking signal. Note that this setting is not available in the Admin
490 # UI.
491 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will
492 # be used to boost results.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]493 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]494 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results.
495 # The sources specified here also have been included in
496 # data_source_restrictions
497 # above.
498 { # Specifies operators to return facet results for. There will be one
499 # FacetResult for every source_name/object_type/operator_name combination.
500 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet.
501 # Defaults to 10.
502 # Maximum value is 100.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]503 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see
504 # cloudsearch.SchemaPropertyOptions
505 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to
506 # compute facets. If empty, then all objects will be used to compute facets.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]507 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id}
508 # If empty, all data sources will be used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]509 },
510 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]511 }</pre>
512</div>
513
514<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]515 <code class="details" id="list">list(debugOptions_enableDebugging=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]516 <pre>Lists all search applications.
517
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]518**Note:** This API requires an admin account to execute.
519
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]520Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]521 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
522Otherwise, ignore this field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]523 pageToken: string, The next_page_token value returned from a previous List request, if any.
524&lt;br/&gt; The default value is 10
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]525 pageSize: integer, The maximum number of items to return.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]526 x__xgafv: string, V1 error format.
527 Allowed values
528 1 - v1 error format
529 2 - v2 error format
530
531Returns:
532 An object of the form:
533
534 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]535 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
536 # more results in the list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]537 &quot;searchApplications&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]538 { # SearchApplication
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]539 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
540 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on.
541 # The corresponding property must be marked as
542 # sortable.
543 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
544 },
545 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application.
546 # &lt;br /&gt;Format: searchapplications/{application_id}.
547 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
548 # schema. Output only field.
549 &quot;A String&quot;,
550 ],
551 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application.
552 # The maximum length is 300 characters.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]553 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations.
554 # The maximum number of elements is 10.
555 { # Restriction on Datasource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]556 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
557 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
558 # Indexing API.
559 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
560 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]561 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters
562 # are present, they are grouped by object type before joining.
563 # Filters with the same object type are joined conjunctively, then
564 # the resulting expressions are joined disjunctively.
565 #
566 # The maximum number of elements is 20.
567 #
568 # NOTE: Suggest API supports only few filters at the moment:
569 # &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;.
570 # For now, schema specific filters cannot be used to filter suggestions.
571 { # Filter options to be applied on query.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]572 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should
573 # correspond to the name of the object that was registered within the
574 # definition of schema. The maximum length is 256 characters.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]575 &quot;filter&quot;: { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
576 # approaches: &lt;br/&gt;&lt;br/&gt;
577 # **1. Setting a ValueFilter.** The name must match an operator_name defined in
578 # the schema for your data source.
579 # &lt;br/&gt;
580 # **2. Setting a CompositeFilter.** The filters are evaluated
581 # using the logical operator. The top-level operators can only be either an AND
582 # or a NOT. AND can appear only at the top-most level. OR can appear only under
583 # a top-level AND.
584 &quot;compositeFilter&quot;: {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]585 &quot;subFilters&quot;: [ # Sub filters.
586 # Object with schema name: Filter
587 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]588 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]589 },
590 &quot;valueFilter&quot;: {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]591 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
592 &quot;integerValue&quot;: &quot;A String&quot;,
593 &quot;stringValue&quot;: &quot;A String&quot;,
594 &quot;booleanValue&quot;: True or False,
595 &quot;dateValue&quot;: { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
596 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
597 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
598 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
599 },
600 &quot;timestampValue&quot;: &quot;A String&quot;,
601 &quot;doubleValue&quot;: 3.14,
602 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]603 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*.
604 # The filter can work against both types of filters defined in the schema
605 # for your data source:
606 # &lt;br/&gt;&lt;br/&gt;
607 # 1. `operator_name`, where the query filters results by the property
608 # that matches the value.
609 # &lt;br/&gt;
610 # 2. `greater_than_operator_name` or `less_than_operator_name` in your
611 # schema. The query filters the results for the property values that are
612 # greater than or less than the supplied value in the query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]613 },
614 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]615 },
616 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]617 },
618 ],
619 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
620 { # Configurations for a source while processing a
621 # Search or
622 # Suggest request.
623 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
624 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
625 # Indexing API.
626 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
627 },
628 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
629 # for a source.
630 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
631 },
632 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
633 # multiple results from the same source or host &quot;crowd out&quot; other results,
634 # diminishing the quality of search for users. To foster better search quality
635 # and source diversity in search results, you can set a condition to reduce
636 # repetitive results by source.
637 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source.
638 # No limits will be set on results if this value is less than or equal to 0.
639 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source.
640 # No limits will be set on results if this value is less than or equal to 0.
641 },
642 },
643 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]644 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a # Configuration for ranking results.
645 # Search or
646 # Suggest request.
647 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used
648 # as a ranking signal. Note that this setting is not available in the Admin
649 # UI.
650 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will
651 # be used to boost results.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]652 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]653 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results.
654 # The sources specified here also have been included in
655 # data_source_restrictions
656 # above.
657 { # Specifies operators to return facet results for. There will be one
658 # FacetResult for every source_name/object_type/operator_name combination.
659 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet.
660 # Defaults to 10.
661 # Maximum value is 100.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]662 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see
663 # cloudsearch.SchemaPropertyOptions
664 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to
665 # compute facets. If empty, then all objects will be used to compute facets.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]666 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id}
667 # If empty, all data sources will be used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]668 },
669 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]670 },
671 ],
672 }</pre>
673</div>
674
675<div class="method">
676 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
677 <pre>Retrieves the next page of results.
678
679Args:
680 previous_request: The request for the previous page. (required)
681 previous_response: The response from the request for the previous page. (required)
682
683Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]684 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]685 page. Returns None if there are no more items in the collection.
686 </pre>
687</div>
688
689<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]690 <code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]691 <pre>Resets a search application to default settings. This will return an empty
692response.
693
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]694**Note:** This API requires an admin account to execute.
695
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]696Args:
697 name: string, The name of the search application to be reset.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]698&lt;br /&gt;Format: applications/{application_id}. (required)
699 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]700 The object takes the form of:
701
702{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]703 &quot;debugOptions&quot;: { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
704 &quot;enableDebugging&quot;: True or False, # If you are asked by Google to help with debugging, set this field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]705 # Otherwise, ignore this field.
706 },
707 }
708
709 x__xgafv: string, V1 error format.
710 Allowed values
711 1 - v1 error format
712 2 - v2 error format
713
714Returns:
715 An object of the form:
716
717 { # This resource represents a long-running operation that is the result of a
718 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]719 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]720 # method returns no data on success, such as `Delete`, the response is
721 # `google.protobuf.Empty`. If the original method is standard
722 # `Get`/`Create`/`Update`, the response should be the resource. For other
723 # methods, the response should have the type `XxxResponse`, where `Xxx`
724 # is the original method name. For example, if the original method name
725 # is `TakeSnapshot()`, the inferred response type is
726 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]727 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]728 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]729 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
730 # contains progress information and common metadata such as create time.
731 # Some services might not provide such metadata. Any method that returns a
732 # long-running operation should document the metadata type, if any.
733 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
734 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]735 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]736 # different programming environments, including REST APIs and RPC APIs. It is
737 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
738 # three pieces of data: error code, error message, and error details.
739 #
740 # You can find out more about this error model and how to work with it in the
741 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]742 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]743 # message types for APIs to use.
744 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]745 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]746 },
747 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]748 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
749 # user-facing error message should be localized and sent in the
750 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]751 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]752 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]753 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
754 # originally returns it. If you use the default HTTP mapping, the
755 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]756 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
757 # If `true`, the operation is completed, and either `error` or `response` is
758 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]759 }</pre>
760</div>
761
762<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]763 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]764 <pre>Updates a search application.
765
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]766**Note:** This API requires an admin account to execute.
767
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]768Args:
769 name: string, Name of the Search Application.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]770&lt;br /&gt;Format: searchapplications/{application_id}. (required)
771 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]772 The object takes the form of:
773
774{ # SearchApplication
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]775 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
776 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on.
777 # The corresponding property must be marked as
778 # sortable.
779 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
780 },
781 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application.
782 # &lt;br /&gt;Format: searchapplications/{application_id}.
783 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
784 # schema. Output only field.
785 &quot;A String&quot;,
786 ],
787 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application.
788 # The maximum length is 300 characters.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]789 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations.
790 # The maximum number of elements is 10.
791 { # Restriction on Datasource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]792 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
793 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
794 # Indexing API.
795 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
796 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]797 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters
798 # are present, they are grouped by object type before joining.
799 # Filters with the same object type are joined conjunctively, then
800 # the resulting expressions are joined disjunctively.
801 #
802 # The maximum number of elements is 20.
803 #
804 # NOTE: Suggest API supports only few filters at the moment:
805 # &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;.
806 # For now, schema specific filters cannot be used to filter suggestions.
807 { # Filter options to be applied on query.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]808 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should
809 # correspond to the name of the object that was registered within the
810 # definition of schema. The maximum length is 256 characters.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]811 &quot;filter&quot;: { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
812 # approaches: &lt;br/&gt;&lt;br/&gt;
813 # **1. Setting a ValueFilter.** The name must match an operator_name defined in
814 # the schema for your data source.
815 # &lt;br/&gt;
816 # **2. Setting a CompositeFilter.** The filters are evaluated
817 # using the logical operator. The top-level operators can only be either an AND
818 # or a NOT. AND can appear only at the top-most level. OR can appear only under
819 # a top-level AND.
820 &quot;compositeFilter&quot;: {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]821 &quot;subFilters&quot;: [ # Sub filters.
822 # Object with schema name: Filter
823 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]824 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]825 },
826 &quot;valueFilter&quot;: {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]827 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
828 &quot;integerValue&quot;: &quot;A String&quot;,
829 &quot;stringValue&quot;: &quot;A String&quot;,
830 &quot;booleanValue&quot;: True or False,
831 &quot;dateValue&quot;: { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
832 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
833 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
834 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
835 },
836 &quot;timestampValue&quot;: &quot;A String&quot;,
837 &quot;doubleValue&quot;: 3.14,
838 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]839 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*.
840 # The filter can work against both types of filters defined in the schema
841 # for your data source:
842 # &lt;br/&gt;&lt;br/&gt;
843 # 1. `operator_name`, where the query filters results by the property
844 # that matches the value.
845 # &lt;br/&gt;
846 # 2. `greater_than_operator_name` or `less_than_operator_name` in your
847 # schema. The query filters the results for the property values that are
848 # greater than or less than the supplied value in the query.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]849 },
850 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]851 },
852 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]853 },
854 ],
855 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
856 { # Configurations for a source while processing a
857 # Search or
858 # Suggest request.
859 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
860 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
861 # Indexing API.
862 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
863 },
864 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
865 # for a source.
866 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
867 },
868 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
869 # multiple results from the same source or host &quot;crowd out&quot; other results,
870 # diminishing the quality of search for users. To foster better search quality
871 # and source diversity in search results, you can set a condition to reduce
872 # repetitive results by source.
873 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source.
874 # No limits will be set on results if this value is less than or equal to 0.
875 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source.
876 # No limits will be set on results if this value is less than or equal to 0.
877 },
878 },
879 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]880 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a # Configuration for ranking results.
881 # Search or
882 # Suggest request.
883 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used
884 # as a ranking signal. Note that this setting is not available in the Admin
885 # UI.
886 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will
887 # be used to boost results.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]888 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]889 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results.
890 # The sources specified here also have been included in
891 # data_source_restrictions
892 # above.
893 { # Specifies operators to return facet results for. There will be one
894 # FacetResult for every source_name/object_type/operator_name combination.
895 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet.
896 # Defaults to 10.
897 # Maximum value is 100.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]898 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see
899 # cloudsearch.SchemaPropertyOptions
900 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to
901 # compute facets. If empty, then all objects will be used to compute facets.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]902 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id}
903 # If empty, all data sources will be used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]904 },
905 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]906}
907
908 x__xgafv: string, V1 error format.
909 Allowed values
910 1 - v1 error format
911 2 - v2 error format
912
913Returns:
914 An object of the form:
915
916 { # This resource represents a long-running operation that is the result of a
917 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]918 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]919 # method returns no data on success, such as `Delete`, the response is
920 # `google.protobuf.Empty`. If the original method is standard
921 # `Get`/`Create`/`Update`, the response should be the resource. For other
922 # methods, the response should have the type `XxxResponse`, where `Xxx`
923 # is the original method name. For example, if the original method name
924 # is `TakeSnapshot()`, the inferred response type is
925 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]926 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]927 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]928 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
929 # contains progress information and common metadata such as create time.
930 # Some services might not provide such metadata. Any method that returns a
931 # long-running operation should document the metadata type, if any.
932 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
933 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]934 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]935 # different programming environments, including REST APIs and RPC APIs. It is
936 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
937 # three pieces of data: error code, error message, and error details.
938 #
939 # You can find out more about this error model and how to work with it in the
940 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]941 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]942 # message types for APIs to use.
943 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]944 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]945 },
946 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]947 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
948 # user-facing error message should be localized and sent in the
949 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]950 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]951 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]952 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
953 # originally returns it. If you use the default HTTP mapping, the
954 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]955 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
956 # If `true`, the operation is completed, and either `error` or `response` is
957 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]958 }</pre>
959</div>
960
961</body></html>