blob: 74f0aed5f2e1580a4a2630adb7944e946a2b5a1e [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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 -070078 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<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 -070087 <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 -070088<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 -070093 <code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<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 -070096 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<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 -0700100 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700101 <pre>Creates a search application.
102
Dan O'Mearadd494642020-05-01 07:42:23 -0700103**Note:** This API requires an admin account to execute.
104
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700105Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700106 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700107 The object takes the form of:
108
109{ # SearchApplication
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700110 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations.
111 # The maximum number of elements is 10.
112 { # Restriction on Datasource.
113 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters
114 # are present, they are grouped by object type before joining.
115 # Filters with the same object type are joined conjunctively, then
116 # the resulting expressions are joined disjunctively.
117 #
118 # The maximum number of elements is 20.
119 #
120 # NOTE: Suggest API supports only few filters at the moment:
121 # &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;.
122 # For now, schema specific filters cannot be used to filter suggestions.
123 { # Filter options to be applied on query.
124 &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`.
125 # approaches: &lt;br/&gt;&lt;br/&gt;
126 # **1. Setting a ValueFilter.** The name must match an operator_name defined in
127 # the schema for your data source.
128 # &lt;br/&gt;
129 # **2. Setting a CompositeFilter.** The filters are evaluated
130 # using the logical operator. The top-level operators can only be either an AND
131 # or a NOT. AND can appear only at the top-most level. OR can appear only under
132 # a top-level AND.
133 &quot;compositeFilter&quot;: {
134 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
135 &quot;subFilters&quot;: [ # Sub filters.
136 # Object with schema name: Filter
137 ],
138 },
139 &quot;valueFilter&quot;: {
140 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*.
141 # The filter can work against both types of filters defined in the schema
142 # for your data source:
143 # &lt;br/&gt;&lt;br/&gt;
144 # 1. `operator_name`, where the query filters results by the property
145 # that matches the value.
146 # &lt;br/&gt;
147 # 2. `greater_than_operator_name` or `less_than_operator_name` in your
148 # schema. The query filters the results for the property values that are
149 # greater than or less than the supplied value in the query.
150 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
151 &quot;integerValue&quot;: &quot;A String&quot;,
152 &quot;stringValue&quot;: &quot;A String&quot;,
153 &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.
154 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
155 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
156 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
157 },
158 &quot;doubleValue&quot;: 3.14,
159 &quot;timestampValue&quot;: &quot;A String&quot;,
160 &quot;booleanValue&quot;: True or False,
161 },
162 },
163 },
164 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should
165 # correspond to the name of the object that was registered within the
166 # definition of schema. The maximum length is 256 characters.
167 },
168 ],
169 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
170 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
171 # Indexing API.
172 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
173 },
174 },
175 ],
176 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
177 { # Configurations for a source while processing a
178 # Search or
179 # Suggest request.
180 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
181 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
182 # Indexing API.
183 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
184 },
185 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
186 # for a source.
187 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
188 },
189 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
190 # multiple results from the same source or host &quot;crowd out&quot; other results,
191 # diminishing the quality of search for users. To foster better search quality
192 # and source diversity in search results, you can set a condition to reduce
193 # repetitive results by source.
194 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source.
195 # No limits will be set on results if this value is less than or equal to 0.
196 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source.
197 # No limits will be set on results if this value is less than or equal to 0.
198 },
199 },
200 ],
201 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
202 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
203 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on.
204 # The corresponding property must be marked as
205 # sortable.
206 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700207 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application.
208 # The maximum length is 300 characters.
209 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results.
210 # The sources specified here also have been included in
211 # data_source_restrictions
212 # above.
213 { # Specifies operators to return facet results for. There will be one
214 # FacetResult for every source_name/object_type/operator_name combination.
215 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet.
216 # Defaults to 10.
217 # Maximum value is 100.
218 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id}
219 # If empty, all data sources will be used.
220 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see
221 # cloudsearch.SchemaPropertyOptions
222 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to
223 # compute facets. If empty, then all objects will be used to compute facets.
Dan O'Mearadd494642020-05-01 07:42:23 -0700224 },
225 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700226 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a # Configuration for ranking results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700227 # Search or
228 # Suggest request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700229 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will
230 # be used to boost results.
231 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used
Dan O'Mearadd494642020-05-01 07:42:23 -0700232 # as a ranking signal. Note that this setting is not available in the Admin
233 # UI.
Dan O'Mearadd494642020-05-01 07:42:23 -0700234 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700235 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application.
Dan O'Mearadd494642020-05-01 07:42:23 -0700236 # &lt;br /&gt;Format: searchapplications/{application_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700237 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
238 # schema. Output only field.
239 &quot;A String&quot;,
240 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700241}
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 -0700253 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700254 # 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 -0700261 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700262 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700263 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Dan O'Mearadd494642020-05-01 07:42:23 -0700264 # originally returns it. If you use the default HTTP mapping, the
265 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700266 &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 -0700267 # different programming environments, including REST APIs and RPC APIs. It is
268 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
269 # three pieces of data: error code, error message, and error details.
270 #
271 # You can find out more about this error model and how to work with it in the
272 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700273 &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 -0700274 # message types for APIs to use.
275 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700276 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700277 },
278 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700279 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
280 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
281 # user-facing error message should be localized and sent in the
282 # google.rpc.Status.details field, or localized by the client.
283 },
284 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
285 # contains progress information and common metadata such as create time.
286 # Some services might not provide such metadata. Any method that returns a
287 # long-running operation should document the metadata type, if any.
288 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700289 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700290 &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 -0700293 }</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 -0700300**Note:** This API requires an admin account to execute.
301
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700302Args:
303 name: string, The name of the search application to be deleted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700304&lt;br /&gt;Format: applications/{application_id}. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700305 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 -0700317 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700318 # 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 -0700325 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700326 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700327 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Dan O'Mearadd494642020-05-01 07:42:23 -0700328 # originally returns it. If you use the default HTTP mapping, the
329 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700330 &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 -0700331 # different programming environments, including REST APIs and RPC APIs. It is
332 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
333 # three pieces of data: error code, error message, and error details.
334 #
335 # You can find out more about this error model and how to work with it in the
336 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700337 &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 -0700338 # message types for APIs to use.
339 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700340 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700341 },
342 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700343 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
344 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
345 # user-facing error message should be localized and sent in the
346 # google.rpc.Status.details field, or localized by the client.
347 },
348 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
349 # contains progress information and common metadata such as create time.
350 # Some services might not provide such metadata. Any method that returns a
351 # long-running operation should document the metadata type, if any.
352 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700353 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700354 &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 -0700357 }</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 -0700364**Note:** This API requires an admin account to execute.
365
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700366Args:
367 name: string, Name of the search application.
Dan O'Mearadd494642020-05-01 07:42:23 -0700368&lt;br /&gt;Format: applications/{application_id}. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700369 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 Kim4ed7d3f2020-05-27 12:20:54 -0700380 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations.
381 # The maximum number of elements is 10.
382 { # Restriction on Datasource.
383 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters
384 # are present, they are grouped by object type before joining.
385 # Filters with the same object type are joined conjunctively, then
386 # the resulting expressions are joined disjunctively.
387 #
388 # The maximum number of elements is 20.
389 #
390 # NOTE: Suggest API supports only few filters at the moment:
391 # &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;.
392 # For now, schema specific filters cannot be used to filter suggestions.
393 { # Filter options to be applied on query.
394 &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`.
395 # approaches: &lt;br/&gt;&lt;br/&gt;
396 # **1. Setting a ValueFilter.** The name must match an operator_name defined in
397 # the schema for your data source.
398 # &lt;br/&gt;
399 # **2. Setting a CompositeFilter.** The filters are evaluated
400 # using the logical operator. The top-level operators can only be either an AND
401 # or a NOT. AND can appear only at the top-most level. OR can appear only under
402 # a top-level AND.
403 &quot;compositeFilter&quot;: {
404 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
405 &quot;subFilters&quot;: [ # Sub filters.
406 # Object with schema name: Filter
407 ],
408 },
409 &quot;valueFilter&quot;: {
410 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*.
411 # The filter can work against both types of filters defined in the schema
412 # for your data source:
413 # &lt;br/&gt;&lt;br/&gt;
414 # 1. `operator_name`, where the query filters results by the property
415 # that matches the value.
416 # &lt;br/&gt;
417 # 2. `greater_than_operator_name` or `less_than_operator_name` in your
418 # schema. The query filters the results for the property values that are
419 # greater than or less than the supplied value in the query.
420 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
421 &quot;integerValue&quot;: &quot;A String&quot;,
422 &quot;stringValue&quot;: &quot;A String&quot;,
423 &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.
424 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
425 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
426 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
427 },
428 &quot;doubleValue&quot;: 3.14,
429 &quot;timestampValue&quot;: &quot;A String&quot;,
430 &quot;booleanValue&quot;: True or False,
431 },
432 },
433 },
434 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should
435 # correspond to the name of the object that was registered within the
436 # definition of schema. The maximum length is 256 characters.
437 },
438 ],
439 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
440 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
441 # Indexing API.
442 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
443 },
444 },
445 ],
446 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
447 { # Configurations for a source while processing a
448 # Search or
449 # Suggest request.
450 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
451 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
452 # Indexing API.
453 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
454 },
455 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
456 # for a source.
457 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
458 },
459 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
460 # multiple results from the same source or host &quot;crowd out&quot; other results,
461 # diminishing the quality of search for users. To foster better search quality
462 # and source diversity in search results, you can set a condition to reduce
463 # repetitive results by source.
464 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source.
465 # No limits will be set on results if this value is less than or equal to 0.
466 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source.
467 # No limits will be set on results if this value is less than or equal to 0.
468 },
469 },
470 ],
471 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
472 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
473 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on.
474 # The corresponding property must be marked as
475 # sortable.
476 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700477 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application.
478 # The maximum length is 300 characters.
479 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results.
480 # The sources specified here also have been included in
481 # data_source_restrictions
482 # above.
483 { # Specifies operators to return facet results for. There will be one
484 # FacetResult for every source_name/object_type/operator_name combination.
485 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet.
486 # Defaults to 10.
487 # Maximum value is 100.
488 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id}
489 # If empty, all data sources will be used.
490 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see
491 # cloudsearch.SchemaPropertyOptions
492 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to
493 # compute facets. If empty, then all objects will be used to compute facets.
Dan O'Mearadd494642020-05-01 07:42:23 -0700494 },
495 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700496 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a # Configuration for ranking results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700497 # Search or
498 # Suggest request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700499 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will
500 # be used to boost results.
501 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used
Dan O'Mearadd494642020-05-01 07:42:23 -0700502 # as a ranking signal. Note that this setting is not available in the Admin
503 # UI.
Dan O'Mearadd494642020-05-01 07:42:23 -0700504 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700505 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application.
Dan O'Mearadd494642020-05-01 07:42:23 -0700506 # &lt;br /&gt;Format: searchapplications/{application_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700507 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
508 # schema. Output only field.
509 &quot;A String&quot;,
510 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700511 }</pre>
512</div>
513
514<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700515 <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 -0700516 <pre>Lists all search applications.
517
Dan O'Mearadd494642020-05-01 07:42:23 -0700518**Note:** This API requires an admin account to execute.
519
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700520Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700521 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 -0700523 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 -0700525 pageSize: integer, The maximum number of items to return.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700526 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 Kim65020912020-05-20 12:08:20 -0700535 &quot;searchApplications&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700536 { # SearchApplication
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700537 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations.
538 # The maximum number of elements is 10.
539 { # Restriction on Datasource.
540 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters
541 # are present, they are grouped by object type before joining.
542 # Filters with the same object type are joined conjunctively, then
543 # the resulting expressions are joined disjunctively.
544 #
545 # The maximum number of elements is 20.
546 #
547 # NOTE: Suggest API supports only few filters at the moment:
548 # &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;.
549 # For now, schema specific filters cannot be used to filter suggestions.
550 { # Filter options to be applied on query.
551 &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`.
552 # approaches: &lt;br/&gt;&lt;br/&gt;
553 # **1. Setting a ValueFilter.** The name must match an operator_name defined in
554 # the schema for your data source.
555 # &lt;br/&gt;
556 # **2. Setting a CompositeFilter.** The filters are evaluated
557 # using the logical operator. The top-level operators can only be either an AND
558 # or a NOT. AND can appear only at the top-most level. OR can appear only under
559 # a top-level AND.
560 &quot;compositeFilter&quot;: {
561 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
562 &quot;subFilters&quot;: [ # Sub filters.
563 # Object with schema name: Filter
564 ],
565 },
566 &quot;valueFilter&quot;: {
567 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*.
568 # The filter can work against both types of filters defined in the schema
569 # for your data source:
570 # &lt;br/&gt;&lt;br/&gt;
571 # 1. `operator_name`, where the query filters results by the property
572 # that matches the value.
573 # &lt;br/&gt;
574 # 2. `greater_than_operator_name` or `less_than_operator_name` in your
575 # schema. The query filters the results for the property values that are
576 # greater than or less than the supplied value in the query.
577 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
578 &quot;integerValue&quot;: &quot;A String&quot;,
579 &quot;stringValue&quot;: &quot;A String&quot;,
580 &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.
581 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
582 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
583 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
584 },
585 &quot;doubleValue&quot;: 3.14,
586 &quot;timestampValue&quot;: &quot;A String&quot;,
587 &quot;booleanValue&quot;: True or False,
588 },
589 },
590 },
591 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should
592 # correspond to the name of the object that was registered within the
593 # definition of schema. The maximum length is 256 characters.
594 },
595 ],
596 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
597 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
598 # Indexing API.
599 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
600 },
601 },
602 ],
603 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
604 { # Configurations for a source while processing a
605 # Search or
606 # Suggest request.
607 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
608 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
609 # Indexing API.
610 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
611 },
612 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
613 # for a source.
614 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
615 },
616 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
617 # multiple results from the same source or host &quot;crowd out&quot; other results,
618 # diminishing the quality of search for users. To foster better search quality
619 # and source diversity in search results, you can set a condition to reduce
620 # repetitive results by source.
621 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source.
622 # No limits will be set on results if this value is less than or equal to 0.
623 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source.
624 # No limits will be set on results if this value is less than or equal to 0.
625 },
626 },
627 ],
628 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
629 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
630 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on.
631 # The corresponding property must be marked as
632 # sortable.
633 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700634 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application.
635 # The maximum length is 300 characters.
636 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results.
637 # The sources specified here also have been included in
638 # data_source_restrictions
639 # above.
640 { # Specifies operators to return facet results for. There will be one
641 # FacetResult for every source_name/object_type/operator_name combination.
642 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet.
643 # Defaults to 10.
644 # Maximum value is 100.
645 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id}
646 # If empty, all data sources will be used.
647 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see
648 # cloudsearch.SchemaPropertyOptions
649 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to
650 # compute facets. If empty, then all objects will be used to compute facets.
Dan O'Mearadd494642020-05-01 07:42:23 -0700651 },
652 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700653 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a # Configuration for ranking results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700654 # Search or
655 # Suggest request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700656 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will
657 # be used to boost results.
658 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used
Dan O'Mearadd494642020-05-01 07:42:23 -0700659 # as a ranking signal. Note that this setting is not available in the Admin
660 # UI.
Dan O'Mearadd494642020-05-01 07:42:23 -0700661 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700662 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application.
Dan O'Mearadd494642020-05-01 07:42:23 -0700663 # &lt;br /&gt;Format: searchapplications/{application_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700664 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
665 # schema. Output only field.
666 &quot;A String&quot;,
667 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700668 },
669 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700670 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
671 # more results in the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700672 }</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 -0700684 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700685 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 -0700690 <code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700691 <pre>Resets a search application to default settings. This will return an empty
692response.
693
Dan O'Mearadd494642020-05-01 07:42:23 -0700694**Note:** This API requires an admin account to execute.
695
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700696Args:
697 name: string, The name of the search application to be reset.
Dan O'Mearadd494642020-05-01 07:42:23 -0700698&lt;br /&gt;Format: applications/{application_id}. (required)
699 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700700 The object takes the form of:
701
702{
Bu Sun Kim65020912020-05-20 12:08:20 -0700703 &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 -0700705 # 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 -0700719 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700720 # 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 -0700727 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700728 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700729 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Dan O'Mearadd494642020-05-01 07:42:23 -0700730 # originally returns it. If you use the default HTTP mapping, the
731 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700732 &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 -0700733 # different programming environments, including REST APIs and RPC APIs. It is
734 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
735 # three pieces of data: error code, error message, and error details.
736 #
737 # You can find out more about this error model and how to work with it in the
738 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700739 &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 -0700740 # message types for APIs to use.
741 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700742 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700743 },
744 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700745 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
746 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
747 # user-facing error message should be localized and sent in the
748 # google.rpc.Status.details field, or localized by the client.
749 },
750 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
751 # contains progress information and common metadata such as create time.
752 # Some services might not provide such metadata. Any method that returns a
753 # long-running operation should document the metadata type, if any.
754 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700755 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700756 &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 -0700759 }</pre>
760</div>
761
762<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700763 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700764 <pre>Updates a search application.
765
Dan O'Mearadd494642020-05-01 07:42:23 -0700766**Note:** This API requires an admin account to execute.
767
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700768Args:
769 name: string, Name of the Search Application.
Dan O'Mearadd494642020-05-01 07:42:23 -0700770&lt;br /&gt;Format: searchapplications/{application_id}. (required)
771 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700772 The object takes the form of:
773
774{ # SearchApplication
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700775 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations.
776 # The maximum number of elements is 10.
777 { # Restriction on Datasource.
778 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters
779 # are present, they are grouped by object type before joining.
780 # Filters with the same object type are joined conjunctively, then
781 # the resulting expressions are joined disjunctively.
782 #
783 # The maximum number of elements is 20.
784 #
785 # NOTE: Suggest API supports only few filters at the moment:
786 # &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;.
787 # For now, schema specific filters cannot be used to filter suggestions.
788 { # Filter options to be applied on query.
789 &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`.
790 # approaches: &lt;br/&gt;&lt;br/&gt;
791 # **1. Setting a ValueFilter.** The name must match an operator_name defined in
792 # the schema for your data source.
793 # &lt;br/&gt;
794 # **2. Setting a CompositeFilter.** The filters are evaluated
795 # using the logical operator. The top-level operators can only be either an AND
796 # or a NOT. AND can appear only at the top-most level. OR can appear only under
797 # a top-level AND.
798 &quot;compositeFilter&quot;: {
799 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
800 &quot;subFilters&quot;: [ # Sub filters.
801 # Object with schema name: Filter
802 ],
803 },
804 &quot;valueFilter&quot;: {
805 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*.
806 # The filter can work against both types of filters defined in the schema
807 # for your data source:
808 # &lt;br/&gt;&lt;br/&gt;
809 # 1. `operator_name`, where the query filters results by the property
810 # that matches the value.
811 # &lt;br/&gt;
812 # 2. `greater_than_operator_name` or `less_than_operator_name` in your
813 # schema. The query filters the results for the property values that are
814 # greater than or less than the supplied value in the query.
815 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
816 &quot;integerValue&quot;: &quot;A String&quot;,
817 &quot;stringValue&quot;: &quot;A String&quot;,
818 &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.
819 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
820 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
821 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
822 },
823 &quot;doubleValue&quot;: 3.14,
824 &quot;timestampValue&quot;: &quot;A String&quot;,
825 &quot;booleanValue&quot;: True or False,
826 },
827 },
828 },
829 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should
830 # correspond to the name of the object that was registered within the
831 # definition of schema. The maximum length is 256 characters.
832 },
833 ],
834 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
835 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
836 # Indexing API.
837 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
838 },
839 },
840 ],
841 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
842 { # Configurations for a source while processing a
843 # Search or
844 # Suggest request.
845 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
846 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the
847 # Indexing API.
848 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
849 },
850 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
851 # for a source.
852 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
853 },
854 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
855 # multiple results from the same source or host &quot;crowd out&quot; other results,
856 # diminishing the quality of search for users. To foster better search quality
857 # and source diversity in search results, you can set a condition to reduce
858 # repetitive results by source.
859 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source.
860 # No limits will be set on results if this value is less than or equal to 0.
861 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source.
862 # No limits will be set on results if this value is less than or equal to 0.
863 },
864 },
865 ],
866 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
867 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
868 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on.
869 # The corresponding property must be marked as
870 # sortable.
871 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700872 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application.
873 # The maximum length is 300 characters.
874 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results.
875 # The sources specified here also have been included in
876 # data_source_restrictions
877 # above.
878 { # Specifies operators to return facet results for. There will be one
879 # FacetResult for every source_name/object_type/operator_name combination.
880 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet.
881 # Defaults to 10.
882 # Maximum value is 100.
883 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id}
884 # If empty, all data sources will be used.
885 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see
886 # cloudsearch.SchemaPropertyOptions
887 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to
888 # compute facets. If empty, then all objects will be used to compute facets.
Dan O'Mearadd494642020-05-01 07:42:23 -0700889 },
890 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700891 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a # Configuration for ranking results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700892 # Search or
893 # Suggest request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700894 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will
895 # be used to boost results.
896 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used
Dan O'Mearadd494642020-05-01 07:42:23 -0700897 # as a ranking signal. Note that this setting is not available in the Admin
898 # UI.
Dan O'Mearadd494642020-05-01 07:42:23 -0700899 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700900 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application.
Dan O'Mearadd494642020-05-01 07:42:23 -0700901 # &lt;br /&gt;Format: searchapplications/{application_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700902 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
903 # schema. Output only field.
904 &quot;A String&quot;,
905 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700906}
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 -0700918 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700919 # 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 -0700926 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700927 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700928 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Dan O'Mearadd494642020-05-01 07:42:23 -0700929 # originally returns it. If you use the default HTTP mapping, the
930 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700931 &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 -0700932 # different programming environments, including REST APIs and RPC APIs. It is
933 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
934 # three pieces of data: error code, error message, and error details.
935 #
936 # You can find out more about this error model and how to work with it in the
937 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700938 &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 -0700939 # message types for APIs to use.
940 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700941 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700942 },
943 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700944 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
945 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
946 # user-facing error message should be localized and sent in the
947 # google.rpc.Status.details field, or localized by the client.
948 },
949 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
950 # contains progress information and common metadata such as create time.
951 # Some services might not provide such metadata. Any method that returns a
952 # long-running operation should document the metadata type, if any.
953 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700954 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700955 &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 -0700958 }</pre>
959</div>
960
961</body></html>