docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/cloudsearch_v1.settings.searchapplications.html b/docs/dyn/cloudsearch_v1.settings.searchapplications.html
index 2b489d8..be050c6 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(pageSize=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(pageToken=None, pageSize=None, debugOptions_enableDebugging=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,48 +107,44 @@
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.
- },
+ "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
+ # above.
+ { # Specifies operators to return facet results for. There will be one
+ # FacetResult for every source_name/object_type/operator_name combination.
+ "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.
},
],
- "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
+ "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
+ "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.
- "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.
+ "name": "A String", # Name of the Search Application.
# <br />Format: searchapplications/{application_id}.
- "dataSourceRestrictions": [ # Retrictions applied to the configurations.
+ "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
+ # 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
+ "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.
@@ -156,10 +152,10 @@
# The maximum number of elements is 20.
#
# NOTE: Suggest API supports only few filters at the moment:
- # "objecttype", "type" and "mimetype".
+ # "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`.
+ "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.
@@ -168,14 +164,8 @@
# 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": {
- "subFilters": [ # Sub filters.
- # Object with schema name: Filter
- ],
- "logicOperator": "A String", # The logic operator of the sub filter.
- },
- "valueFilter": {
- "operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*.
+ "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/>
@@ -185,59 +175,69 @@
# 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.
- "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.
- "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.
+ "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.
},
- "stringValue": "A String",
- "booleanValue": True or False,
- "integerValue": "A String",
+ "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
+ "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
+ "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.
},
},
],
- "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
- # schema. Output only field.
- "A String",
- ],
- "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
- },
- "defaultFacetOptions": [ # The default fields for returning facet results.
- # The sources specified here also have been included in
- # data_source_restrictions
- # above.
- { # Specifies operators to return facet results for. There will be one
- # FacetResult for every source_name/object_type/operator_name combination.
- "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}
- # If empty, all data sources will be used.
- "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet.
- # Defaults to 10.
- # Maximum value is 100.
- "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.
+ "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,16 +250,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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.
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "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
+ "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
@@ -267,28 +261,34 @@
# 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.
+ "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
+ "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.
+ "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
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
+ },
+ "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.
},
}</pre>
</div>
@@ -314,16 +314,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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.
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "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
+ "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
@@ -331,28 +325,34 @@
# 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.
+ "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
+ "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.
+ "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
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
+ },
+ "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.
},
}</pre>
</div>
@@ -377,48 +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.
- },
+ "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
+ # above.
+ { # Specifies operators to return facet results for. There will be one
+ # FacetResult for every source_name/object_type/operator_name combination.
+ "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.
},
],
- "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
+ "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
+ "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.
- "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.
+ "name": "A String", # Name of the Search Application.
# <br />Format: searchapplications/{application_id}.
- "dataSourceRestrictions": [ # Retrictions applied to the configurations.
+ "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
+ # 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
+ "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.
@@ -426,10 +422,10 @@
# The maximum number of elements is 20.
#
# NOTE: Suggest API supports only few filters at the moment:
- # "objecttype", "type" and "mimetype".
+ # "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`.
+ "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.
@@ -438,14 +434,8 @@
# 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": {
- "subFilters": [ # Sub filters.
- # Object with schema name: Filter
- ],
- "logicOperator": "A String", # The logic operator of the sub filter.
- },
- "valueFilter": {
- "operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*.
+ "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/>
@@ -455,74 +445,84 @@
# 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.
- "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.
- "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.
+ "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.
},
- "stringValue": "A String",
- "booleanValue": True or False,
- "integerValue": "A String",
+ "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
+ "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
+ "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.
},
},
],
- "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
- # schema. Output only field.
- "A String",
- ],
- "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
- },
- "defaultFacetOptions": [ # The default fields for returning facet results.
- # The sources specified here also have been included in
- # data_source_restrictions
- # above.
- { # Specifies operators to return facet results for. There will be one
- # FacetResult for every source_name/object_type/operator_name combination.
- "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}
- # If empty, all data sources will be used.
- "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet.
- # Defaults to 10.
- # Maximum value is 100.
- "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.
+ "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(pageSize=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(pageToken=None, pageSize=None, debugOptions_enableDebugging=None, x__xgafv=None)</code>
<pre>Lists all search applications.
**Note:** This API requires an admin account to execute.
Args:
+ 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.
- pageToken: string, The next_page_token value returned from a previous List request, if any.
-<br/> The default value is 10
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -532,52 +532,48 @@
An object of the form:
{
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
# more results in the list.
- "searchApplications": [
+ "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.
- },
+ "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
+ # above.
+ { # Specifies operators to return facet results for. There will be one
+ # FacetResult for every source_name/object_type/operator_name combination.
+ "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.
},
],
- "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
+ "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
+ "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.
- "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.
+ "name": "A String", # Name of the Search Application.
# <br />Format: searchapplications/{application_id}.
- "dataSourceRestrictions": [ # Retrictions applied to the configurations.
+ "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
+ # 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
+ "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.
@@ -585,10 +581,10 @@
# The maximum number of elements is 20.
#
# NOTE: Suggest API supports only few filters at the moment:
- # "objecttype", "type" and "mimetype".
+ # "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`.
+ "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.
@@ -597,14 +593,8 @@
# 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": {
- "subFilters": [ # Sub filters.
- # Object with schema name: Filter
- ],
- "logicOperator": "A String", # The logic operator of the sub filter.
- },
- "valueFilter": {
- "operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*.
+ "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/>
@@ -614,59 +604,69 @@
# 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.
- "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.
- "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.
+ "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.
},
- "stringValue": "A String",
- "booleanValue": True or False,
- "integerValue": "A String",
+ "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
+ "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
+ "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.
},
},
],
- "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
- # schema. Output only field.
- "A String",
- ],
- "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
- },
- "defaultFacetOptions": [ # The default fields for returning facet results.
- # The sources specified here also have been included in
- # data_source_restrictions
- # above.
- { # Specifies operators to return facet results for. There will be one
- # FacetResult for every source_name/object_type/operator_name combination.
- "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}
- # If empty, all data sources will be used.
- "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet.
- # Defaults to 10.
- # Maximum value is 100.
- "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.
+ "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>
@@ -681,7 +681,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -700,8 +700,8 @@
The object takes the form of:
{
- "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
- "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
+ "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
+ "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
# Otherwise, ignore this field.
},
}
@@ -716,16 +716,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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.
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "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
+ "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
@@ -733,28 +727,34 @@
# 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.
+ "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
+ "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.
+ "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
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
+ },
+ "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.
},
}</pre>
</div>
@@ -772,48 +772,44 @@
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.
- },
+ "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
+ # above.
+ { # Specifies operators to return facet results for. There will be one
+ # FacetResult for every source_name/object_type/operator_name combination.
+ "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.
},
],
- "scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.
+ "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
+ "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.
- "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.
+ "name": "A String", # Name of the Search Application.
# <br />Format: searchapplications/{application_id}.
- "dataSourceRestrictions": [ # Retrictions applied to the configurations.
+ "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
+ # 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
+ "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.
@@ -821,10 +817,10 @@
# The maximum number of elements is 20.
#
# NOTE: Suggest API supports only few filters at the moment:
- # "objecttype", "type" and "mimetype".
+ # "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`.
+ "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.
@@ -833,14 +829,8 @@
# 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": {
- "subFilters": [ # Sub filters.
- # Object with schema name: Filter
- ],
- "logicOperator": "A String", # The logic operator of the sub filter.
- },
- "valueFilter": {
- "operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*.
+ "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/>
@@ -850,59 +840,69 @@
# 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.
- "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.
- "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.
+ "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.
},
- "stringValue": "A String",
- "booleanValue": True or False,
- "integerValue": "A String",
+ "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
+ "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
+ "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.
},
},
],
- "operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this
- # schema. Output only field.
- "A String",
- ],
- "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
- },
- "defaultFacetOptions": [ # The default fields for returning facet results.
- # The sources specified here also have been included in
- # data_source_restrictions
- # above.
- { # Specifies operators to return facet results for. There will be one
- # FacetResult for every source_name/object_type/operator_name combination.
- "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}
- # If empty, all data sources will be used.
- "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet.
- # Defaults to 10.
- # Maximum value is 100.
- "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.
+ "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,16 +915,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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.
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "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
+ "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
@@ -932,28 +926,34 @@
# 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.
+ "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
+ "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.
+ "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
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
+ },
+ "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.
},
}</pre>
</div>