docs: update generated docs (#981)
diff --git a/docs/dyn/cloudsearch_v1.settings.searchapplications.html b/docs/dyn/cloudsearch_v1.settings.searchapplications.html
index 74f0aed..5673be7 100644
--- a/docs/dyn/cloudsearch_v1.settings.searchapplications.html
+++ b/docs/dyn/cloudsearch_v1.settings.searchapplications.html
@@ -107,9 +107,28 @@
The object takes the form of:
{ # SearchApplication
+ "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
+ # sortable.
+ "sortOrder": "A String", # Ascending is the default sort order
+ },
+ "name": "A String", # Name of the Search Application.
+ # <br />Format: searchapplications/{application_id}.
+ "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.
"dataSourceRestrictions": [ # Retrictions applied to the configurations.
# The maximum number of elements is 10.
{ # Restriction on Datasource.
+ "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.
+ },
"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
@@ -121,6 +140,9 @@
# "objecttype", "type" and "mimetype".
# For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
+ "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.
"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
@@ -131,12 +153,24 @@
# 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
],
+ "logicOperator": "A String", # The logic operator of the sub filter.
},
"valueFilter": {
+ "value": { # Definition of a single value with generic type. # The value to be compared with.
+ "integerValue": "A String",
+ "stringValue": "A String",
+ "booleanValue": True or False,
+ "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.
+ "year": 42, # Year of date. Must be from 1 to 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.
+ },
+ "timestampValue": "A String",
+ "doubleValue": 3.14,
+ },
"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:
@@ -147,30 +181,10 @@
# 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.
@@ -198,14 +212,15 @@
},
},
],
- "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.
+ "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.
"defaultFacetOptions": [ # The default fields for returning facet results.
# The sources specified here also have been included in
# data_source_restrictions
@@ -215,29 +230,14 @@
"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet.
# Defaults to 10.
# Maximum value is 100.
- "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}
- # If empty, all data sources will be used.
"operatorName": "A String", # Name of the operator chosen for faceting. @see
# cloudsearch.SchemaPropertyOptions
"objectType": "A String", # If object_type is set, only those objects of that type will be used to
# compute facets. If empty, then all objects will be used to compute facets.
+ "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}
+ # If empty, all data sources will be used.
},
],
- "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
- # Search or
- # Suggest request.
- "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will
- # be used to boost results.
- "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.
- },
- "name": "A String", # Name of the Search Application.
- # <br />Format: searchapplications/{application_id}.
- "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
- # schema. Output only field.
- "A String",
- ],
}
x__xgafv: string, V1 error format.
@@ -260,9 +260,12 @@
# `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}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"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
@@ -276,17 +279,14 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "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}`.
"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.
@@ -324,9 +324,12 @@
# `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}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"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
@@ -340,17 +343,14 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "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}`.
"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.
@@ -365,7 +365,7 @@
Args:
name: string, Name of the search application.
-<br />Format: applications/{application_id}. (required)
+<br />Format: searchapplications/{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.
@@ -377,9 +377,28 @@
An object of the form:
{ # SearchApplication
+ "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
+ # sortable.
+ "sortOrder": "A String", # Ascending is the default sort order
+ },
+ "name": "A String", # Name of the Search Application.
+ # <br />Format: searchapplications/{application_id}.
+ "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.
"dataSourceRestrictions": [ # Retrictions applied to the configurations.
# The maximum number of elements is 10.
{ # Restriction on Datasource.
+ "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.
+ },
"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
@@ -391,6 +410,9 @@
# "objecttype", "type" and "mimetype".
# For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
+ "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.
"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
@@ -401,12 +423,24 @@
# 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
],
+ "logicOperator": "A String", # The logic operator of the sub filter.
},
"valueFilter": {
+ "value": { # Definition of a single value with generic type. # The value to be compared with.
+ "integerValue": "A String",
+ "stringValue": "A String",
+ "booleanValue": True or False,
+ "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.
+ "year": 42, # Year of date. Must be from 1 to 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.
+ },
+ "timestampValue": "A String",
+ "doubleValue": 3.14,
+ },
"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:
@@ -417,30 +451,10 @@
# 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.
@@ -468,14 +482,15 @@
},
},
],
- "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.
+ "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.
"defaultFacetOptions": [ # The default fields for returning facet results.
# The sources specified here also have been included in
# data_source_restrictions
@@ -485,29 +500,14 @@
"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet.
# Defaults to 10.
# Maximum value is 100.
- "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}
- # If empty, all data sources will be used.
"operatorName": "A String", # Name of the operator chosen for faceting. @see
# cloudsearch.SchemaPropertyOptions
"objectType": "A String", # If object_type is set, only those objects of that type will be used to
# compute facets. If empty, then all objects will be used to compute facets.
+ "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}
+ # If empty, all data sources will be used.
},
],
- "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
- # Search or
- # Suggest request.
- "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will
- # be used to boost results.
- "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.
- },
- "name": "A String", # Name of the Search Application.
- # <br />Format: searchapplications/{application_id}.
- "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
- # schema. Output only field.
- "A String",
- ],
}</pre>
</div>
@@ -532,11 +532,32 @@
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
+ "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
+ # sortable.
+ "sortOrder": "A String", # Ascending is the default sort order
+ },
+ "name": "A String", # Name of the Search Application.
+ # <br />Format: searchapplications/{application_id}.
+ "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.
"dataSourceRestrictions": [ # Retrictions applied to the configurations.
# The maximum number of elements is 10.
{ # Restriction on Datasource.
+ "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.
+ },
"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
@@ -548,6 +569,9 @@
# "objecttype", "type" and "mimetype".
# For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
+ "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.
"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
@@ -558,12 +582,24 @@
# 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
],
+ "logicOperator": "A String", # The logic operator of the sub filter.
},
"valueFilter": {
+ "value": { # Definition of a single value with generic type. # The value to be compared with.
+ "integerValue": "A String",
+ "stringValue": "A String",
+ "booleanValue": True or False,
+ "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.
+ "year": 42, # Year of date. Must be from 1 to 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.
+ },
+ "timestampValue": "A String",
+ "doubleValue": 3.14,
+ },
"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:
@@ -574,30 +610,10 @@
# 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.
@@ -625,14 +641,15 @@
},
},
],
- "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.
+ "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.
"defaultFacetOptions": [ # The default fields for returning facet results.
# The sources specified here also have been included in
# data_source_restrictions
@@ -642,33 +659,16 @@
"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet.
# Defaults to 10.
# Maximum value is 100.
- "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}
- # If empty, all data sources will be used.
"operatorName": "A String", # Name of the operator chosen for faceting. @see
# cloudsearch.SchemaPropertyOptions
"objectType": "A String", # If object_type is set, only those objects of that type will be used to
# compute facets. If empty, then all objects will be used to compute facets.
+ "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}
+ # If empty, all data sources will be used.
},
],
- "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
- # Search or
- # Suggest request.
- "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will
- # be used to boost results.
- "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.
- },
- "name": "A String", # Name of the Search Application.
- # <br />Format: searchapplications/{application_id}.
- "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
- # schema. Output only field.
- "A String",
- ],
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
}</pre>
</div>
@@ -726,9 +726,12 @@
# `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}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"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
@@ -742,17 +745,14 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "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}`.
"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.
@@ -772,9 +772,28 @@
The object takes the form of:
{ # SearchApplication
+ "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
+ # sortable.
+ "sortOrder": "A String", # Ascending is the default sort order
+ },
+ "name": "A String", # Name of the Search Application.
+ # <br />Format: searchapplications/{application_id}.
+ "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.
"dataSourceRestrictions": [ # Retrictions applied to the configurations.
# The maximum number of elements is 10.
{ # Restriction on Datasource.
+ "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.
+ },
"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
@@ -786,6 +805,9 @@
# "objecttype", "type" and "mimetype".
# For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
+ "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.
"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
@@ -796,12 +818,24 @@
# 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
],
+ "logicOperator": "A String", # The logic operator of the sub filter.
},
"valueFilter": {
+ "value": { # Definition of a single value with generic type. # The value to be compared with.
+ "integerValue": "A String",
+ "stringValue": "A String",
+ "booleanValue": True or False,
+ "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.
+ "year": 42, # Year of date. Must be from 1 to 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.
+ },
+ "timestampValue": "A String",
+ "doubleValue": 3.14,
+ },
"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:
@@ -812,30 +846,10 @@
# 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.
@@ -863,14 +877,15 @@
},
},
],
- "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.
+ "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.
"defaultFacetOptions": [ # The default fields for returning facet results.
# The sources specified here also have been included in
# data_source_restrictions
@@ -880,29 +895,14 @@
"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet.
# Defaults to 10.
# Maximum value is 100.
- "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}
- # If empty, all data sources will be used.
"operatorName": "A String", # Name of the operator chosen for faceting. @see
# cloudsearch.SchemaPropertyOptions
"objectType": "A String", # If object_type is set, only those objects of that type will be used to
# compute facets. If empty, then all objects will be used to compute facets.
+ "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}
+ # If empty, all data sources will be used.
},
],
- "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
- # Search or
- # Suggest request.
- "disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will
- # be used to boost results.
- "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.
- },
- "name": "A String", # Name of the Search Application.
- # <br />Format: searchapplications/{application_id}.
- "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
- # schema. Output only field.
- "A String",
- ],
}
x__xgafv: string, V1 error format.
@@ -925,9 +925,12 @@
# `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}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"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
@@ -941,17 +944,14 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "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}`.
"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.