docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/cloudsearch_v1.settings.searchapplications.html b/docs/dyn/cloudsearch_v1.settings.searchapplications.html
index be050c6..74f0aed 100644
--- a/docs/dyn/cloudsearch_v1.settings.searchapplications.html
+++ b/docs/dyn/cloudsearch_v1.settings.searchapplications.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified search application.</p>
<p class="toc_element">
- <code><a href="#list">list(pageToken=None, pageSize=None, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(debugOptions_enableDebugging=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all search applications.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -107,6 +107,103 @@
The object takes the form of:
{ # SearchApplication
+ "dataSourceRestrictions": [ # Retrictions applied to the configurations.
+ # The maximum number of elements is 10.
+ { # Restriction on Datasource.
+ "filterOptions": [ # 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:
+ # "objecttype", "type" and "mimetype".
+ # 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/>
+ # **1. Setting a ValueFilter.** The name must match an operator_name defined in
+ # the schema for your data source.
+ # <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
+ # a top-level AND.
+ "compositeFilter": {
+ "logicOperator": "A String", # The logic operator of the sub filter.
+ "subFilters": [ # Sub filters.
+ # Object with schema name: Filter
+ ],
+ },
+ "valueFilter": {
+ "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/>
+ # 1. `operator_name`, where the query filters results by the property
+ # that matches the value.
+ # <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.
+ "value": { # Definition of a single value with generic type. # The value to be compared with.
+ "integerValue": "A String",
+ "stringValue": "A String",
+ "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.
+ },
+ "doubleValue": 3.14,
+ "timestampValue": "A String",
+ "booleanValue": True or False,
+ },
+ },
+ },
+ "objectType": "A String", # 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.
+ },
+ ],
+ "source": { # Defines sources for the suggest/search APIs. # The source of restriction.
+ "name": "A String", # Source name for content indexed by the
+ # Indexing API.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ },
+ },
+ ],
+ "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
+ { # Configurations for a source while processing a
+ # Search or
+ # Suggest request.
+ "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
+ "name": "A String", # Source name for content indexed by the
+ # Indexing API.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ },
+ "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.
+ "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.
+ "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.
+ },
+ },
+ ],
+ "defaultSortOptions": { # The default options for sorting the search results
+ "sortOrder": "A String", # Ascending is the default sort order
+ "operatorName": "A String", # Name of the operator corresponding to the field to sort on.
+ # The corresponding property must be marked as
+ # sortable.
+ },
"displayName": "A String", # Display name of the Search Application.
# The maximum length is 300 characters.
"defaultFacetOptions": [ # The default fields for returning facet results.
@@ -141,103 +238,6 @@
# schema. Output only field.
"A String",
],
- "dataSourceRestrictions": [ # Retrictions applied to the configurations.
- # The maximum number of elements is 10.
- { # Restriction on Datasource.
- "filterOptions": [ # 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:
- # "objecttype", "type" and "mimetype".
- # 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/>
- # **1. Setting a ValueFilter.** The name must match an operator_name defined in
- # the schema for your data source.
- # <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
- # a top-level AND.
- "valueFilter": {
- "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/>
- # 1. `operator_name`, where the query filters results by the property
- # that matches the value.
- # <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.
- "value": { # Definition of a single value with generic type. # The value to be compared with.
- "integerValue": "A String",
- "stringValue": "A String",
- "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.
- "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.
- "month": 42, # Month of date. Must be from 1 to 12.
- },
- "doubleValue": 3.14,
- "timestampValue": "A String",
- "booleanValue": True or False,
- },
- },
- "compositeFilter": {
- "logicOperator": "A String", # The logic operator of the sub filter.
- "subFilters": [ # Sub filters.
- # Object with schema name: Filter
- ],
- },
- },
- "objectType": "A String", # 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.
- },
- ],
- "source": { # Defines sources for the suggest/search APIs. # The source of restriction.
- "predefinedSource": "A String", # Predefined content source for Google Apps.
- "name": "A String", # Source name for content indexed by the
- # Indexing API.
- },
- },
- ],
- "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
- { # Configurations for a source while processing a
- # Search or
- # Suggest request.
- "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": { # 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.
- "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.
- "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.
- },
- },
- ],
- "defaultSortOptions": { # The default options for sorting the search results
- "sortOrder": "A String", # Ascending is the default sort order
- "operatorName": "A String", # Name of the operator corresponding to the field to sort on.
- # The corresponding property must be marked as
- # sortable.
- },
}
x__xgafv: string, V1 error format.
@@ -250,9 +250,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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
@@ -290,6 +287,9 @@
# 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.
}</pre>
</div>
@@ -314,9 +314,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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
@@ -354,6 +351,9 @@
# 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.
}</pre>
</div>
@@ -377,6 +377,103 @@
An object of the form:
{ # SearchApplication
+ "dataSourceRestrictions": [ # Retrictions applied to the configurations.
+ # The maximum number of elements is 10.
+ { # Restriction on Datasource.
+ "filterOptions": [ # 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:
+ # "objecttype", "type" and "mimetype".
+ # 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/>
+ # **1. Setting a ValueFilter.** The name must match an operator_name defined in
+ # the schema for your data source.
+ # <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
+ # a top-level AND.
+ "compositeFilter": {
+ "logicOperator": "A String", # The logic operator of the sub filter.
+ "subFilters": [ # Sub filters.
+ # Object with schema name: Filter
+ ],
+ },
+ "valueFilter": {
+ "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/>
+ # 1. `operator_name`, where the query filters results by the property
+ # that matches the value.
+ # <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.
+ "value": { # Definition of a single value with generic type. # The value to be compared with.
+ "integerValue": "A String",
+ "stringValue": "A String",
+ "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.
+ },
+ "doubleValue": 3.14,
+ "timestampValue": "A String",
+ "booleanValue": True or False,
+ },
+ },
+ },
+ "objectType": "A String", # 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.
+ },
+ ],
+ "source": { # Defines sources for the suggest/search APIs. # The source of restriction.
+ "name": "A String", # Source name for content indexed by the
+ # Indexing API.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ },
+ },
+ ],
+ "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
+ { # Configurations for a source while processing a
+ # Search or
+ # Suggest request.
+ "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
+ "name": "A String", # Source name for content indexed by the
+ # Indexing API.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ },
+ "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.
+ "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.
+ "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.
+ },
+ },
+ ],
+ "defaultSortOptions": { # The default options for sorting the search results
+ "sortOrder": "A String", # Ascending is the default sort order
+ "operatorName": "A String", # Name of the operator corresponding to the field to sort on.
+ # The corresponding property must be marked as
+ # sortable.
+ },
"displayName": "A String", # Display name of the Search Application.
# The maximum length is 300 characters.
"defaultFacetOptions": [ # The default fields for returning facet results.
@@ -411,118 +508,21 @@
# schema. Output only field.
"A String",
],
- "dataSourceRestrictions": [ # Retrictions applied to the configurations.
- # The maximum number of elements is 10.
- { # Restriction on Datasource.
- "filterOptions": [ # 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:
- # "objecttype", "type" and "mimetype".
- # 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/>
- # **1. Setting a ValueFilter.** The name must match an operator_name defined in
- # the schema for your data source.
- # <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
- # a top-level AND.
- "valueFilter": {
- "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/>
- # 1. `operator_name`, where the query filters results by the property
- # that matches the value.
- # <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.
- "value": { # Definition of a single value with generic type. # The value to be compared with.
- "integerValue": "A String",
- "stringValue": "A String",
- "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.
- "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.
- "month": 42, # Month of date. Must be from 1 to 12.
- },
- "doubleValue": 3.14,
- "timestampValue": "A String",
- "booleanValue": True or False,
- },
- },
- "compositeFilter": {
- "logicOperator": "A String", # The logic operator of the sub filter.
- "subFilters": [ # Sub filters.
- # Object with schema name: Filter
- ],
- },
- },
- "objectType": "A String", # 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.
- },
- ],
- "source": { # Defines sources for the suggest/search APIs. # The source of restriction.
- "predefinedSource": "A String", # Predefined content source for Google Apps.
- "name": "A String", # Source name for content indexed by the
- # Indexing API.
- },
- },
- ],
- "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
- { # Configurations for a source while processing a
- # Search or
- # Suggest request.
- "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": { # 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.
- "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.
- "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.
- },
- },
- ],
- "defaultSortOptions": { # The default options for sorting the search results
- "sortOrder": "A String", # Ascending is the default sort order
- "operatorName": "A String", # Name of the operator corresponding to the field to sort on.
- # The corresponding property must be marked as
- # sortable.
- },
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(pageToken=None, pageSize=None, debugOptions_enableDebugging=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(debugOptions_enableDebugging=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists all search applications.
**Note:** This API requires an admin account to execute.
Args:
+ 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
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -532,10 +532,105 @@
An object of the form:
{
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
"searchApplications": [
{ # SearchApplication
+ "dataSourceRestrictions": [ # Retrictions applied to the configurations.
+ # The maximum number of elements is 10.
+ { # Restriction on Datasource.
+ "filterOptions": [ # 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:
+ # "objecttype", "type" and "mimetype".
+ # 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/>
+ # **1. Setting a ValueFilter.** The name must match an operator_name defined in
+ # the schema for your data source.
+ # <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
+ # a top-level AND.
+ "compositeFilter": {
+ "logicOperator": "A String", # The logic operator of the sub filter.
+ "subFilters": [ # Sub filters.
+ # Object with schema name: Filter
+ ],
+ },
+ "valueFilter": {
+ "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/>
+ # 1. `operator_name`, where the query filters results by the property
+ # that matches the value.
+ # <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.
+ "value": { # Definition of a single value with generic type. # The value to be compared with.
+ "integerValue": "A String",
+ "stringValue": "A String",
+ "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.
+ },
+ "doubleValue": 3.14,
+ "timestampValue": "A String",
+ "booleanValue": True or False,
+ },
+ },
+ },
+ "objectType": "A String", # 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.
+ },
+ ],
+ "source": { # Defines sources for the suggest/search APIs. # The source of restriction.
+ "name": "A String", # Source name for content indexed by the
+ # Indexing API.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ },
+ },
+ ],
+ "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
+ { # Configurations for a source while processing a
+ # Search or
+ # Suggest request.
+ "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
+ "name": "A String", # Source name for content indexed by the
+ # Indexing API.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ },
+ "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.
+ "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.
+ "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.
+ },
+ },
+ ],
+ "defaultSortOptions": { # The default options for sorting the search results
+ "sortOrder": "A String", # Ascending is the default sort order
+ "operatorName": "A String", # Name of the operator corresponding to the field to sort on.
+ # The corresponding property must be marked as
+ # sortable.
+ },
"displayName": "A String", # Display name of the Search Application.
# The maximum length is 300 characters.
"defaultFacetOptions": [ # The default fields for returning facet results.
@@ -570,105 +665,10 @@
# schema. Output only field.
"A String",
],
- "dataSourceRestrictions": [ # Retrictions applied to the configurations.
- # The maximum number of elements is 10.
- { # Restriction on Datasource.
- "filterOptions": [ # 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:
- # "objecttype", "type" and "mimetype".
- # 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/>
- # **1. Setting a ValueFilter.** The name must match an operator_name defined in
- # the schema for your data source.
- # <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
- # a top-level AND.
- "valueFilter": {
- "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/>
- # 1. `operator_name`, where the query filters results by the property
- # that matches the value.
- # <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.
- "value": { # Definition of a single value with generic type. # The value to be compared with.
- "integerValue": "A String",
- "stringValue": "A String",
- "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.
- "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.
- "month": 42, # Month of date. Must be from 1 to 12.
- },
- "doubleValue": 3.14,
- "timestampValue": "A String",
- "booleanValue": True or False,
- },
- },
- "compositeFilter": {
- "logicOperator": "A String", # The logic operator of the sub filter.
- "subFilters": [ # Sub filters.
- # Object with schema name: Filter
- ],
- },
- },
- "objectType": "A String", # 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.
- },
- ],
- "source": { # Defines sources for the suggest/search APIs. # The source of restriction.
- "predefinedSource": "A String", # Predefined content source for Google Apps.
- "name": "A String", # Source name for content indexed by the
- # Indexing API.
- },
- },
- ],
- "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
- { # Configurations for a source while processing a
- # Search or
- # Suggest request.
- "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": { # 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.
- "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.
- "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.
- },
- },
- ],
- "defaultSortOptions": { # The default options for sorting the search results
- "sortOrder": "A String", # Ascending is the default sort order
- "operatorName": "A String", # Name of the operator corresponding to the field to sort on.
- # The corresponding property must be marked as
- # sortable.
- },
},
],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ # more results in the list.
}</pre>
</div>
@@ -716,9 +716,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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
@@ -756,6 +753,9 @@
# 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.
}</pre>
</div>
@@ -772,6 +772,103 @@
The object takes the form of:
{ # SearchApplication
+ "dataSourceRestrictions": [ # Retrictions applied to the configurations.
+ # The maximum number of elements is 10.
+ { # Restriction on Datasource.
+ "filterOptions": [ # 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:
+ # "objecttype", "type" and "mimetype".
+ # 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/>
+ # **1. Setting a ValueFilter.** The name must match an operator_name defined in
+ # the schema for your data source.
+ # <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
+ # a top-level AND.
+ "compositeFilter": {
+ "logicOperator": "A String", # The logic operator of the sub filter.
+ "subFilters": [ # Sub filters.
+ # Object with schema name: Filter
+ ],
+ },
+ "valueFilter": {
+ "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/>
+ # 1. `operator_name`, where the query filters results by the property
+ # that matches the value.
+ # <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.
+ "value": { # Definition of a single value with generic type. # The value to be compared with.
+ "integerValue": "A String",
+ "stringValue": "A String",
+ "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.
+ },
+ "doubleValue": 3.14,
+ "timestampValue": "A String",
+ "booleanValue": True or False,
+ },
+ },
+ },
+ "objectType": "A String", # 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.
+ },
+ ],
+ "source": { # Defines sources for the suggest/search APIs. # The source of restriction.
+ "name": "A String", # Source name for content indexed by the
+ # Indexing API.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ },
+ },
+ ],
+ "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
+ { # Configurations for a source while processing a
+ # Search or
+ # Suggest request.
+ "source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
+ "name": "A String", # Source name for content indexed by the
+ # Indexing API.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ },
+ "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.
+ "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.
+ "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.
+ },
+ },
+ ],
+ "defaultSortOptions": { # The default options for sorting the search results
+ "sortOrder": "A String", # Ascending is the default sort order
+ "operatorName": "A String", # Name of the operator corresponding to the field to sort on.
+ # The corresponding property must be marked as
+ # sortable.
+ },
"displayName": "A String", # Display name of the Search Application.
# The maximum length is 300 characters.
"defaultFacetOptions": [ # The default fields for returning facet results.
@@ -806,103 +903,6 @@
# schema. Output only field.
"A String",
],
- "dataSourceRestrictions": [ # Retrictions applied to the configurations.
- # The maximum number of elements is 10.
- { # Restriction on Datasource.
- "filterOptions": [ # 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:
- # "objecttype", "type" and "mimetype".
- # 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/>
- # **1. Setting a ValueFilter.** The name must match an operator_name defined in
- # the schema for your data source.
- # <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
- # a top-level AND.
- "valueFilter": {
- "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/>
- # 1. `operator_name`, where the query filters results by the property
- # that matches the value.
- # <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.
- "value": { # Definition of a single value with generic type. # The value to be compared with.
- "integerValue": "A String",
- "stringValue": "A String",
- "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.
- "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.
- "month": 42, # Month of date. Must be from 1 to 12.
- },
- "doubleValue": 3.14,
- "timestampValue": "A String",
- "booleanValue": True or False,
- },
- },
- "compositeFilter": {
- "logicOperator": "A String", # The logic operator of the sub filter.
- "subFilters": [ # Sub filters.
- # Object with schema name: Filter
- ],
- },
- },
- "objectType": "A String", # 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.
- },
- ],
- "source": { # Defines sources for the suggest/search APIs. # The source of restriction.
- "predefinedSource": "A String", # Predefined content source for Google Apps.
- "name": "A String", # Source name for content indexed by the
- # Indexing API.
- },
- },
- ],
- "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
- { # Configurations for a source while processing a
- # Search or
- # Suggest request.
- "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": { # 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.
- "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.
- "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.
- },
- },
- ],
- "defaultSortOptions": { # The default options for sorting the search results
- "sortOrder": "A String", # Ascending is the default sort order
- "operatorName": "A String", # Name of the operator corresponding to the field to sort on.
- # The corresponding property must be marked as
- # sortable.
- },
}
x__xgafv: string, V1 error format.
@@ -915,9 +915,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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
@@ -955,6 +952,9 @@
# 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.
}</pre>
</div>