chore: regens API reference docs (#889)
diff --git a/docs/dyn/cloudsearch_v1.settings.searchapplications.html b/docs/dyn/cloudsearch_v1.settings.searchapplications.html
index 75226f9..2b489d8 100644
--- a/docs/dyn/cloudsearch_v1.settings.searchapplications.html
+++ b/docs/dyn/cloudsearch_v1.settings.searchapplications.html
@@ -75,7 +75,7 @@
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a search application.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
@@ -90,21 +90,61 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#reset">reset(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Resets a search application to default settings. This will return an empty</p>
<p class="toc_element">
- <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a search application.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(body, x__xgafv=None)</code>
+ <code class="details" id="create">create(body=None, x__xgafv=None)</code>
<pre>Creates a search application.
+**Note:** This API requires an admin account to execute.
+
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # SearchApplication
+ "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
+ { # Configurations for a source while processing a
+ # Search or
+ # Suggest request.
+ "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
+ # for a source.
+ "sourceImportance": "A String", # Importance of the source.
+ },
+ "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ "name": "A String", # Source name for content indexed by the
+ # Indexing API.
+ },
+ "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
+ # multiple results from the same source or host "crowd out" 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.
+ "numResults": 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.
+ "numSuggestions": 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.
+ },
+ },
+ ],
+ "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
+ # Search or
+ # Suggest request.
+ "disableFreshness": 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.
+ "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will
+ # be used to boost results.
+ },
+ "displayName": "A String", # Display name of the Search Application.
+ # The maximum length is 300 characters.
+ "name": "A String", # Name of the Search Application.
+ # <br />Format: searchapplications/{application_id}.
"dataSourceRestrictions": [ # Retrictions applied to the configurations.
# The maximum number of elements is 10.
{ # Restriction on Datasource.
@@ -120,10 +160,10 @@
# For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
"filter": { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
- # approaches: <br/><br/>
+ # approaches: <br/><br/>
# **1. Setting a ValueFilter.** The name must match an operator_name defined in
# the schema for your data source.
- # <br/>
+ # <br/>
# **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
@@ -138,10 +178,10 @@
"operatorName": "A String", # 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:
- # <br/><br/>
+ # <br/><br/>
# 1. `operator_name`, where the query filters results by the property
# that matches the value.
- # <br/>
+ # <br/>
# 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.
@@ -149,9 +189,9 @@
"timestampValue": "A String",
"doubleValue": 3.14,
"dateValue": { # 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.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
"stringValue": "A String",
"booleanValue": True or False,
@@ -171,55 +211,10 @@
},
},
],
- "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
+ "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
# schema. Output only field.
"A String",
],
- "displayName": "A String", # Display name of the Search Application.
- # The maximum length is 300 characters.
- "name": "A String", # Name of the Search Application.
- # <br />Format: searchapplications/{application_id}.
- "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
- { # Configurations for a source while processing a
- # Search or
- # Suggest request.
- "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
- # for a source.
- "sourceImportance": "A String", # Importance of the source.
- },
- "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
- # multiple results from the same source or host "crowd out" 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.
- "numResults": 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.
- "field": "A String", # Use a field to control results crowding. For example, if you want to
- # control overly similar results from Gmail topics, use `thread_id`.
- # For similar pages from Google Sites, you can use `webspace_id`.
- # When matching query results contain the same field value in
- # `GenericMetadata`, crowding limits are set on those records.
- "numSuggestions": 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.
- "source": True or False, # Control results by content source. This option limits the total number
- # of results from a given source and ignores field-based crowding control.
- },
- "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
- "predefinedSource": "A String", # Predefined content source for Google Apps.
- "name": "A String", # Source name for content indexed by the
- # Indexing API.
- },
- },
- ],
- "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
- # Search or
- # Suggest request.
- "disableFreshness": 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.
- "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will
- # be used to boost results.
- },
"defaultSortOptions": { # The default options for sorting the search results
"operatorName": "A String", # Name of the operator corresponding to the field to sort on.
# The corresponding property must be marked as
@@ -261,6 +256,22 @@
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "done": 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.
+ "response": { # 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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # 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}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -279,22 +290,6 @@
},
],
},
- "done": 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.
- "response": { # 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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # 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}`.
}</pre>
</div>
@@ -302,9 +297,11 @@
<code class="details" id="delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
<pre>Deletes a search application.
+**Note:** This API requires an admin account to execute.
+
Args:
name: string, The name of the search application to be deleted.
-<br />Format: applications/{application_id}. (required)
+<br />Format: applications/{application_id}. (required)
debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
Otherwise, ignore this field.
x__xgafv: string, V1 error format.
@@ -323,6 +320,22 @@
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "done": 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.
+ "response": { # 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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # 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}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -341,22 +354,6 @@
},
],
},
- "done": 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.
- "response": { # 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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # 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}`.
}</pre>
</div>
@@ -364,9 +361,11 @@
<code class="details" id="get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
<pre>Gets the specified search application.
+**Note:** This API requires an admin account to execute.
+
Args:
name: string, Name of the search application.
-<br />Format: applications/{application_id}. (required)
+<br />Format: applications/{application_id}. (required)
debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
Otherwise, ignore this field.
x__xgafv: string, V1 error format.
@@ -378,6 +377,44 @@
An object of the form:
{ # SearchApplication
+ "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
+ { # Configurations for a source while processing a
+ # Search or
+ # Suggest request.
+ "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
+ # for a source.
+ "sourceImportance": "A String", # Importance of the source.
+ },
+ "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ "name": "A String", # Source name for content indexed by the
+ # Indexing API.
+ },
+ "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
+ # multiple results from the same source or host "crowd out" 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.
+ "numResults": 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.
+ "numSuggestions": 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.
+ },
+ },
+ ],
+ "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
+ # Search or
+ # Suggest request.
+ "disableFreshness": 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.
+ "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will
+ # be used to boost results.
+ },
+ "displayName": "A String", # Display name of the Search Application.
+ # The maximum length is 300 characters.
+ "name": "A String", # Name of the Search Application.
+ # <br />Format: searchapplications/{application_id}.
"dataSourceRestrictions": [ # Retrictions applied to the configurations.
# The maximum number of elements is 10.
{ # Restriction on Datasource.
@@ -393,10 +430,10 @@
# For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
"filter": { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
- # approaches: <br/><br/>
+ # approaches: <br/><br/>
# **1. Setting a ValueFilter.** The name must match an operator_name defined in
# the schema for your data source.
- # <br/>
+ # <br/>
# **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
@@ -411,10 +448,10 @@
"operatorName": "A String", # 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:
- # <br/><br/>
+ # <br/><br/>
# 1. `operator_name`, where the query filters results by the property
# that matches the value.
- # <br/>
+ # <br/>
# 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.
@@ -422,9 +459,9 @@
"timestampValue": "A String",
"doubleValue": 3.14,
"dateValue": { # 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.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
"stringValue": "A String",
"booleanValue": True or False,
@@ -444,55 +481,10 @@
},
},
],
- "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
+ "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
# schema. Output only field.
"A String",
],
- "displayName": "A String", # Display name of the Search Application.
- # The maximum length is 300 characters.
- "name": "A String", # Name of the Search Application.
- # <br />Format: searchapplications/{application_id}.
- "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
- { # Configurations for a source while processing a
- # Search or
- # Suggest request.
- "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
- # for a source.
- "sourceImportance": "A String", # Importance of the source.
- },
- "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
- # multiple results from the same source or host "crowd out" 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.
- "numResults": 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.
- "field": "A String", # Use a field to control results crowding. For example, if you want to
- # control overly similar results from Gmail topics, use `thread_id`.
- # For similar pages from Google Sites, you can use `webspace_id`.
- # When matching query results contain the same field value in
- # `GenericMetadata`, crowding limits are set on those records.
- "numSuggestions": 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.
- "source": True or False, # Control results by content source. This option limits the total number
- # of results from a given source and ignores field-based crowding control.
- },
- "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
- "predefinedSource": "A String", # Predefined content source for Google Apps.
- "name": "A String", # Source name for content indexed by the
- # Indexing API.
- },
- },
- ],
- "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
- # Search or
- # Suggest request.
- "disableFreshness": 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.
- "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will
- # be used to boost results.
- },
"defaultSortOptions": { # The default options for sorting the search results
"operatorName": "A String", # Name of the operator corresponding to the field to sort on.
# The corresponding property must be marked as
@@ -523,12 +515,14 @@
<code class="details" id="list">list(pageSize=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all search applications.
+**Note:** This API requires an admin account to execute.
+
Args:
pageSize: integer, The maximum number of items to return.
debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
Otherwise, ignore this field.
pageToken: string, The next_page_token value returned from a previous List request, if any.
-<br/> The default value is 10
+<br/> The default value is 10
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -542,6 +536,44 @@
# more results in the list.
"searchApplications": [
{ # SearchApplication
+ "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
+ { # Configurations for a source while processing a
+ # Search or
+ # Suggest request.
+ "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
+ # for a source.
+ "sourceImportance": "A String", # Importance of the source.
+ },
+ "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ "name": "A String", # Source name for content indexed by the
+ # Indexing API.
+ },
+ "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
+ # multiple results from the same source or host "crowd out" 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.
+ "numResults": 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.
+ "numSuggestions": 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.
+ },
+ },
+ ],
+ "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
+ # Search or
+ # Suggest request.
+ "disableFreshness": 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.
+ "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will
+ # be used to boost results.
+ },
+ "displayName": "A String", # Display name of the Search Application.
+ # The maximum length is 300 characters.
+ "name": "A String", # Name of the Search Application.
+ # <br />Format: searchapplications/{application_id}.
"dataSourceRestrictions": [ # Retrictions applied to the configurations.
# The maximum number of elements is 10.
{ # Restriction on Datasource.
@@ -557,10 +589,10 @@
# For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
"filter": { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
- # approaches: <br/><br/>
+ # approaches: <br/><br/>
# **1. Setting a ValueFilter.** The name must match an operator_name defined in
# the schema for your data source.
- # <br/>
+ # <br/>
# **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
@@ -575,10 +607,10 @@
"operatorName": "A String", # 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:
- # <br/><br/>
+ # <br/><br/>
# 1. `operator_name`, where the query filters results by the property
# that matches the value.
- # <br/>
+ # <br/>
# 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.
@@ -586,9 +618,9 @@
"timestampValue": "A String",
"doubleValue": 3.14,
"dateValue": { # 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.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
"stringValue": "A String",
"booleanValue": True or False,
@@ -608,55 +640,10 @@
},
},
],
- "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
+ "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
# schema. Output only field.
"A String",
],
- "displayName": "A String", # Display name of the Search Application.
- # The maximum length is 300 characters.
- "name": "A String", # Name of the Search Application.
- # <br />Format: searchapplications/{application_id}.
- "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
- { # Configurations for a source while processing a
- # Search or
- # Suggest request.
- "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
- # for a source.
- "sourceImportance": "A String", # Importance of the source.
- },
- "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
- # multiple results from the same source or host "crowd out" 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.
- "numResults": 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.
- "field": "A String", # Use a field to control results crowding. For example, if you want to
- # control overly similar results from Gmail topics, use `thread_id`.
- # For similar pages from Google Sites, you can use `webspace_id`.
- # When matching query results contain the same field value in
- # `GenericMetadata`, crowding limits are set on those records.
- "numSuggestions": 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.
- "source": True or False, # Control results by content source. This option limits the total number
- # of results from a given source and ignores field-based crowding control.
- },
- "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
- "predefinedSource": "A String", # Predefined content source for Google Apps.
- "name": "A String", # Source name for content indexed by the
- # Indexing API.
- },
- },
- ],
- "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
- # Search or
- # Suggest request.
- "disableFreshness": 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.
- "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will
- # be used to boost results.
- },
"defaultSortOptions": { # The default options for sorting the search results
"operatorName": "A String", # Name of the operator corresponding to the field to sort on.
# The corresponding property must be marked as
@@ -700,14 +687,16 @@
</div>
<div class="method">
- <code class="details" id="reset">reset(name, body, x__xgafv=None)</code>
+ <code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
<pre>Resets a search application to default settings. This will return an empty
response.
+**Note:** This API requires an admin account to execute.
+
Args:
name: string, The name of the search application to be reset.
-<br />Format: applications/{application_id}. (required)
- body: object, The request body. (required)
+<br />Format: applications/{application_id}. (required)
+ body: object, The request body.
The object takes the form of:
{
@@ -733,6 +722,22 @@
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "done": 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.
+ "response": { # 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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # 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}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -751,36 +756,60 @@
},
],
},
- "done": 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.
- "response": { # 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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # 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}`.
}</pre>
</div>
<div class="method">
- <code class="details" id="update">update(name, body, x__xgafv=None)</code>
+ <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
<pre>Updates a search application.
+**Note:** This API requires an admin account to execute.
+
Args:
name: string, Name of the Search Application.
-<br />Format: searchapplications/{application_id}. (required)
- body: object, The request body. (required)
+<br />Format: searchapplications/{application_id}. (required)
+ body: object, The request body.
The object takes the form of:
{ # SearchApplication
+ "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
+ { # Configurations for a source while processing a
+ # Search or
+ # Suggest request.
+ "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
+ # for a source.
+ "sourceImportance": "A String", # Importance of the source.
+ },
+ "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ "name": "A String", # Source name for content indexed by the
+ # Indexing API.
+ },
+ "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
+ # multiple results from the same source or host "crowd out" 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.
+ "numResults": 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.
+ "numSuggestions": 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.
+ },
+ },
+ ],
+ "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
+ # Search or
+ # Suggest request.
+ "disableFreshness": 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.
+ "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will
+ # be used to boost results.
+ },
+ "displayName": "A String", # Display name of the Search Application.
+ # The maximum length is 300 characters.
+ "name": "A String", # Name of the Search Application.
+ # <br />Format: searchapplications/{application_id}.
"dataSourceRestrictions": [ # Retrictions applied to the configurations.
# The maximum number of elements is 10.
{ # Restriction on Datasource.
@@ -796,10 +825,10 @@
# For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
"filter": { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
- # approaches: <br/><br/>
+ # approaches: <br/><br/>
# **1. Setting a ValueFilter.** The name must match an operator_name defined in
# the schema for your data source.
- # <br/>
+ # <br/>
# **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
@@ -814,10 +843,10 @@
"operatorName": "A String", # 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:
- # <br/><br/>
+ # <br/><br/>
# 1. `operator_name`, where the query filters results by the property
# that matches the value.
- # <br/>
+ # <br/>
# 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.
@@ -825,9 +854,9 @@
"timestampValue": "A String",
"doubleValue": 3.14,
"dateValue": { # 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.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
"stringValue": "A String",
"booleanValue": True or False,
@@ -847,55 +876,10 @@
},
},
],
- "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
+ "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
# schema. Output only field.
"A String",
],
- "displayName": "A String", # Display name of the Search Application.
- # The maximum length is 300 characters.
- "name": "A String", # Name of the Search Application.
- # <br />Format: searchapplications/{application_id}.
- "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
- { # Configurations for a source while processing a
- # Search or
- # Suggest request.
- "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.
- # for a source.
- "sourceImportance": "A String", # Importance of the source.
- },
- "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.
- # multiple results from the same source or host "crowd out" 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.
- "numResults": 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.
- "field": "A String", # Use a field to control results crowding. For example, if you want to
- # control overly similar results from Gmail topics, use `thread_id`.
- # For similar pages from Google Sites, you can use `webspace_id`.
- # When matching query results contain the same field value in
- # `GenericMetadata`, crowding limits are set on those records.
- "numSuggestions": 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.
- "source": True or False, # Control results by content source. This option limits the total number
- # of results from a given source and ignores field-based crowding control.
- },
- "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
- "predefinedSource": "A String", # Predefined content source for Google Apps.
- "name": "A String", # Source name for content indexed by the
- # Indexing API.
- },
- },
- ],
- "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
- # Search or
- # Suggest request.
- "disableFreshness": 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.
- "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will
- # be used to boost results.
- },
"defaultSortOptions": { # The default options for sorting the search results
"operatorName": "A String", # Name of the operator corresponding to the field to sort on.
# The corresponding property must be marked as
@@ -937,6 +921,22 @@
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "done": 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.
+ "response": { # 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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # 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}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -955,22 +955,6 @@
},
],
},
- "done": 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.
- "response": { # 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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # 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}`.
}</pre>
</div>