Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / cloudsearch_v1.settings.searchapplications.html
blob: d7a4fc2d9cf16ec25bb2f95e472a5e41e24223b9 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Creates a search application. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Deletes a search application. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Gets the specified search application. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]90 <code><a href="#list">list(pageSize=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91<p class="firstline">Lists all search applications. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97<p class="firstline">Resets a search application to default settings. This will return an empty response. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100<p class="firstline">Updates a search application. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107<div class="method">
108 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
109 <pre>Creates a search application. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]110
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]112 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113 The object takes the form of:
114
115{ # SearchApplication
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]116 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
117 &quot;A String&quot;,
118 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]119 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
120 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
121 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
122 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]123 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations. The maximum number of elements is 10.
124 { # Restriction on Datasource.
125 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]126 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
127 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
128 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]129 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;. For now, schema specific filters cannot be used to filter suggestions.
130 { # Filter options to be applied on query.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]131 &quot;filter&quot;: { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
132 &quot;valueFilter&quot;: {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]133 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]134 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]135 &quot;doubleValue&quot;: 3.14,
136 &quot;timestampValue&quot;: &quot;A String&quot;,
137 &quot;booleanValue&quot;: True or False,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]138 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]139 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]140 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
141 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]142 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]143 &quot;integerValue&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]144 &quot;stringValue&quot;: &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]145 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]146 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]147 &quot;compositeFilter&quot;: {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]148 &quot;subFilters&quot;: [ # Sub filters.
149 # Object with schema name: Filter
150 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]151 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]152 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]153 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]154 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]155 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]156 ],
157 },
158 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]159 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
160 { # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
161 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
162 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]163 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]164 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]165 },
166 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]167 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application. The maximum length is 300 characters.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]168 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
169 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
170 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]171 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]172 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
173 { # Configurations for a source while processing a Search or Suggest request.
174 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
175 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
176 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
177 },
178 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the source.
179 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
180 },
181 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host &quot;crowd out&quot; other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. # The crowding configuration for the source.
182 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
183 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
184 },
185 },
186 ],
187 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application. Format: searchapplications/{application_id}.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]188 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189
190 x__xgafv: string, V1 error format.
191 Allowed values
192 1 - v1 error format
193 2 - v2 error format
194
195Returns:
196 An object of the form:
197
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]198 { # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]199 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]200 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]201 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]202 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]203 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]204 &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]205 },
206 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]207 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]208 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]209 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
210 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
211 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]212 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]213 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
214 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
215 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216 }</pre>
217</div>
218
219<div class="method">
220 <code class="details" id="delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]221 <pre>Deletes a search application. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]222
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]224 name: string, The name of the search application to be deleted. Format: applications/{application_id}. (required)
225 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 x__xgafv: string, V1 error format.
227 Allowed values
228 1 - v1 error format
229 2 - v2 error format
230
231Returns:
232 An object of the form:
233
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]234 { # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]235 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]236 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]237 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]238 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]239 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]240 &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]241 },
242 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]243 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]244 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]245 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
246 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
247 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]248 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]249 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
250 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
251 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252 }</pre>
253</div>
254
255<div class="method">
256 <code class="details" id="get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]257 <pre>Gets the specified search application. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]258
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]259Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]260 name: string, Name of the search application. Format: searchapplications/{application_id}. (required)
261 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262 x__xgafv: string, V1 error format.
263 Allowed values
264 1 - v1 error format
265 2 - v2 error format
266
267Returns:
268 An object of the form:
269
270 { # SearchApplication
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]271 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
272 &quot;A String&quot;,
273 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]274 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
275 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
276 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
277 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]278 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations. The maximum number of elements is 10.
279 { # Restriction on Datasource.
280 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]281 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
282 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
283 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]284 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;. For now, schema specific filters cannot be used to filter suggestions.
285 { # Filter options to be applied on query.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]286 &quot;filter&quot;: { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
287 &quot;valueFilter&quot;: {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]288 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]289 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]290 &quot;doubleValue&quot;: 3.14,
291 &quot;timestampValue&quot;: &quot;A String&quot;,
292 &quot;booleanValue&quot;: True or False,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]293 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]294 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]295 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
296 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]297 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]298 &quot;integerValue&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]299 &quot;stringValue&quot;: &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]300 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]301 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]302 &quot;compositeFilter&quot;: {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]303 &quot;subFilters&quot;: [ # Sub filters.
304 # Object with schema name: Filter
305 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]306 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]307 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]308 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]309 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]310 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]311 ],
312 },
313 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]314 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
315 { # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
316 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
317 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]318 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]319 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]320 },
321 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]322 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application. The maximum length is 300 characters.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]323 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
324 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
325 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]326 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]327 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
328 { # Configurations for a source while processing a Search or Suggest request.
329 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
330 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
331 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
332 },
333 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the source.
334 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
335 },
336 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host &quot;crowd out&quot; other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. # The crowding configuration for the source.
337 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
338 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
339 },
340 },
341 ],
342 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application. Format: searchapplications/{application_id}.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]343 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]344</div>
345
346<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]347 <code class="details" id="list">list(pageSize=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]348 <pre>Lists all search applications. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]349
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]350Args:
351 pageSize: integer, The maximum number of items to return.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]352 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]353 pageToken: string, The next_page_token value returned from a previous List request, if any. The default value is 10
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]354 x__xgafv: string, V1 error format.
355 Allowed values
356 1 - v1 error format
357 2 - v2 error format
358
359Returns:
360 An object of the form:
361
362 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]363 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]364 &quot;searchApplications&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]365 { # SearchApplication
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]366 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
367 &quot;A String&quot;,
368 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]369 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
370 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
371 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
372 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]373 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations. The maximum number of elements is 10.
374 { # Restriction on Datasource.
375 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]376 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
377 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
378 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]379 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;. For now, schema specific filters cannot be used to filter suggestions.
380 { # Filter options to be applied on query.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]381 &quot;filter&quot;: { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
382 &quot;valueFilter&quot;: {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]383 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]384 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]385 &quot;doubleValue&quot;: 3.14,
386 &quot;timestampValue&quot;: &quot;A String&quot;,
387 &quot;booleanValue&quot;: True or False,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]388 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]389 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]390 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
391 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]392 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]393 &quot;integerValue&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]394 &quot;stringValue&quot;: &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]395 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]396 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]397 &quot;compositeFilter&quot;: {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]398 &quot;subFilters&quot;: [ # Sub filters.
399 # Object with schema name: Filter
400 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]401 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]402 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]403 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]404 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]405 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]406 ],
407 },
408 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]409 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
410 { # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
411 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
412 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]413 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]414 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]415 },
416 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]417 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application. The maximum length is 300 characters.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]418 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
419 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
420 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]421 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]422 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
423 { # Configurations for a source while processing a Search or Suggest request.
424 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
425 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
426 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
427 },
428 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the source.
429 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
430 },
431 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host &quot;crowd out&quot; other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. # The crowding configuration for the source.
432 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
433 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
434 },
435 },
436 ],
437 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application. Format: searchapplications/{application_id}.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]438 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]439 ],
440 }</pre>
441</div>
442
443<div class="method">
444 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
445 <pre>Retrieves the next page of results.
446
447Args:
448 previous_request: The request for the previous page. (required)
449 previous_response: The response from the request for the previous page. (required)
450
451Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]452 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]453 page. Returns None if there are no more items in the collection.
454 </pre>
455</div>
456
457<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]458 <code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]459 <pre>Resets a search application to default settings. This will return an empty response. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]460
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]461Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]462 name: string, The name of the search application to be reset. Format: applications/{application_id}. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]463 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]464 The object takes the form of:
465
466{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]467 &quot;debugOptions&quot;: { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]468 &quot;enableDebugging&quot;: True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]469 },
470 }
471
472 x__xgafv: string, V1 error format.
473 Allowed values
474 1 - v1 error format
475 2 - v2 error format
476
477Returns:
478 An object of the form:
479
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]480 { # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]481 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]482 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]483 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]484 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]485 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]486 &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]487 },
488 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]489 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]490 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]491 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
492 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
493 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]494 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]495 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
496 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
497 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]498 }</pre>
499</div>
500
501<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]502 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]503 <pre>Updates a search application. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]504
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]505Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]506 name: string, Name of the Search Application. Format: searchapplications/{application_id}. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]507 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]508 The object takes the form of:
509
510{ # SearchApplication
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]511 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
512 &quot;A String&quot;,
513 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]514 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
515 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
516 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
517 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]518 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations. The maximum number of elements is 10.
519 { # Restriction on Datasource.
520 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]521 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
522 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
523 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]524 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;. For now, schema specific filters cannot be used to filter suggestions.
525 { # Filter options to be applied on query.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]526 &quot;filter&quot;: { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
527 &quot;valueFilter&quot;: {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]528 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]529 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]530 &quot;doubleValue&quot;: 3.14,
531 &quot;timestampValue&quot;: &quot;A String&quot;,
532 &quot;booleanValue&quot;: True or False,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]533 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]534 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]535 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
536 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]537 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]538 &quot;integerValue&quot;: &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]539 &quot;stringValue&quot;: &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]540 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]541 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]542 &quot;compositeFilter&quot;: {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]543 &quot;subFilters&quot;: [ # Sub filters.
544 # Object with schema name: Filter
545 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]546 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]547 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]548 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]549 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]550 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]551 ],
552 },
553 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]554 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
555 { # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
556 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
557 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]558 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]559 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]560 },
561 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]562 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application. The maximum length is 300 characters.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]563 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
564 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
565 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]566 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]567 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
568 { # Configurations for a source while processing a Search or Suggest request.
569 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
570 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
571 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
572 },
573 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the source.
574 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
575 },
576 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host &quot;crowd out&quot; other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. # The crowding configuration for the source.
577 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
578 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
579 },
580 },
581 ],
582 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application. Format: searchapplications/{application_id}.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]583 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]584
585 x__xgafv: string, V1 error format.
586 Allowed values
587 1 - v1 error format
588 2 - v2 error format
589
590Returns:
591 An object of the form:
592
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]593 { # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]594 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]595 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]596 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]597 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]598 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]599 &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]600 },
601 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]602 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]603 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]604 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
605 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
606 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]607 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]608 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
609 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
610 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]611 }</pre>
612</div>
613
614</body></html>