docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/cloudsearch_v1.settings.searchapplications.html b/docs/dyn/cloudsearch_v1.settings.searchapplications.html
index 0323530..60a0e6c 100644
--- a/docs/dyn/cloudsearch_v1.settings.searchapplications.html
+++ b/docs/dyn/cloudsearch_v1.settings.searchapplications.html
@@ -87,7 +87,7 @@
<code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified search application. **Note:** This API requires an admin account to execute.</p>
<p class="toc_element">
- <code><a href="#list">list(pageToken=None, pageSize=None, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(pageSize=None, pageToken=None, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all search applications. **Note:** This API requires an admin account to execute.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -113,79 +113,79 @@
The object takes the form of:
{ # SearchApplication
- "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.
- "operatorName": "A String", # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
- "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.
- "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.
- },
- ],
- "name": "A String", # Name of the Search Application. Format: searchapplications/{application_id}.
- "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.
+ "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.
+ "operatorName": "A String", # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
+ "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
+ "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.
},
- "filterOptions": [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
- { # Filter options to be applied on query.
- "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 approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
- "compositeFilter": {
- "logicOperator": "A String", # The logic operator of the sub filter.
- "subFilters": [ # Sub filters.
- # Object with schema name: Filter
- ],
- },
- "valueFilter": {
- "value": { # Definition of a single value with generic type. # The value to be compared with.
- "timestampValue": "A String",
- "stringValue": "A String",
- "booleanValue": True or False,
- "integerValue": "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.
- "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.
+ ],
+ "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
+ { # Configurations for a source while processing a Search or Suggest request.
+ "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which 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. # The crowding configuration for the 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.
+ },
+ "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the 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.
+ "name": "A String", # Source name for content indexed by the Indexing API.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ },
+ },
+ ],
+ "name": "A String", # Name of the Search Application. 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.
+ "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.
+ },
+ "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 the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
+ { # Filter options to be applied on query.
+ "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 approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
+ "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: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
+ "value": { # Definition of a single value with generic type. # The value to be compared with.
+ "integerValue": "A String",
+ "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.
+ "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.
+ },
+ "booleanValue": True or False,
+ "stringValue": "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: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
+ "compositeFilter": {
+ "logicOperator": "A String", # The logic operator of the sub filter.
+ "subFilters": [ # Sub filters.
+ # Object with schema name: Filter
+ ],
+ },
},
},
- },
- ],
+ ],
+ },
+ ],
+ "scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking 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.
},
- ],
- "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.
- "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
- },
- "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
- { # Configurations for a source while processing a Search or Suggest request.
- "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which 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. # The crowding configuration for the source.
- "numResults": 42, # Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
- "numSuggestions": 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
- },
- "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the 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.
- "name": "A String", # Source name for content indexed by the Indexing API.
- "predefinedSource": "A String", # Predefined content source for Google Apps.
- },
- },
- ],
- "scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
- "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.
- },
-}
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -197,13 +197,6 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
- "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.
- },
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -213,6 +206,13 @@
"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.
},
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "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>
@@ -233,13 +233,6 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
- "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.
- },
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -249,6 +242,13 @@
"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.
},
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "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>
@@ -268,88 +268,88 @@
An object of the form:
{ # SearchApplication
- "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.
- "operatorName": "A String", # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
- "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.
- "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.
- },
- ],
- "name": "A String", # Name of the Search Application. Format: searchapplications/{application_id}.
- "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.
+ "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.
+ "operatorName": "A String", # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
+ "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
+ "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.
},
- "filterOptions": [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
- { # Filter options to be applied on query.
- "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 approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
- "compositeFilter": {
- "logicOperator": "A String", # The logic operator of the sub filter.
- "subFilters": [ # Sub filters.
- # Object with schema name: Filter
- ],
- },
- "valueFilter": {
- "value": { # Definition of a single value with generic type. # The value to be compared with.
- "timestampValue": "A String",
- "stringValue": "A String",
- "booleanValue": True or False,
- "integerValue": "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.
- "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.
+ ],
+ "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
+ { # Configurations for a source while processing a Search or Suggest request.
+ "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which 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. # The crowding configuration for the 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.
+ },
+ "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the 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.
+ "name": "A String", # Source name for content indexed by the Indexing API.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ },
+ },
+ ],
+ "name": "A String", # Name of the Search Application. 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.
+ "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.
+ },
+ "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 the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
+ { # Filter options to be applied on query.
+ "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 approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
+ "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: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
+ "value": { # Definition of a single value with generic type. # The value to be compared with.
+ "integerValue": "A String",
+ "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.
+ "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.
+ },
+ "booleanValue": True or False,
+ "stringValue": "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: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
+ "compositeFilter": {
+ "logicOperator": "A String", # The logic operator of the sub filter.
+ "subFilters": [ # Sub filters.
+ # Object with schema name: Filter
+ ],
+ },
},
},
- },
- ],
+ ],
+ },
+ ],
+ "scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking 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.
},
- ],
- "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.
- "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
- },
- "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
- { # Configurations for a source while processing a Search or Suggest request.
- "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which 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. # The crowding configuration for the source.
- "numResults": 42, # Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
- "numSuggestions": 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
- },
- "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the 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.
- "name": "A String", # Source name for content indexed by the Indexing API.
- "predefinedSource": "A String", # Predefined content source for Google Apps.
- },
- },
- ],
- "scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
- "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.
- },
- }</pre>
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(pageToken=None, pageSize=None, debugOptions_enableDebugging=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(pageSize=None, pageToken=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. The default value is 10
pageSize: integer, The maximum number of items to return.
+ pageToken: string, The next_page_token value returned from a previous List request, if any. The default value is 10
debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
x__xgafv: string, V1 error format.
Allowed values
@@ -363,79 +363,79 @@
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"searchApplications": [
{ # SearchApplication
- "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.
- "operatorName": "A String", # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
- "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.
- "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.
- },
- ],
- "name": "A String", # Name of the Search Application. Format: searchapplications/{application_id}.
- "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.
+ "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.
+ "operatorName": "A String", # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
+ "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
+ "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.
},
- "filterOptions": [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
- { # Filter options to be applied on query.
- "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 approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
- "compositeFilter": {
- "logicOperator": "A String", # The logic operator of the sub filter.
- "subFilters": [ # Sub filters.
- # Object with schema name: Filter
- ],
- },
- "valueFilter": {
- "value": { # Definition of a single value with generic type. # The value to be compared with.
- "timestampValue": "A String",
- "stringValue": "A String",
- "booleanValue": True or False,
- "integerValue": "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.
- "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.
+ ],
+ "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
+ { # Configurations for a source while processing a Search or Suggest request.
+ "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which 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. # The crowding configuration for the 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.
+ },
+ "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the 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.
+ "name": "A String", # Source name for content indexed by the Indexing API.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ },
+ },
+ ],
+ "name": "A String", # Name of the Search Application. 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.
+ "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.
+ },
+ "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 the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
+ { # Filter options to be applied on query.
+ "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 approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
+ "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: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
+ "value": { # Definition of a single value with generic type. # The value to be compared with.
+ "integerValue": "A String",
+ "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.
+ "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.
+ },
+ "booleanValue": True or False,
+ "stringValue": "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: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
+ "compositeFilter": {
+ "logicOperator": "A String", # The logic operator of the sub filter.
+ "subFilters": [ # Sub filters.
+ # Object with schema name: Filter
+ ],
+ },
},
},
- },
- ],
+ ],
+ },
+ ],
+ "scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking 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.
},
- ],
- "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.
- "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
},
- "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
- { # Configurations for a source while processing a Search or Suggest request.
- "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which 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. # The crowding configuration for the source.
- "numResults": 42, # Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
- "numSuggestions": 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
- },
- "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the 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.
- "name": "A String", # Source name for content indexed by the Indexing API.
- "predefinedSource": "A String", # Predefined content source for Google Apps.
- },
- },
- ],
- "scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
- "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.
- },
- },
],
}</pre>
</div>
@@ -479,13 +479,6 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
- "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.
- },
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -495,6 +488,13 @@
"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.
},
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "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>
@@ -508,79 +508,79 @@
The object takes the form of:
{ # SearchApplication
- "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.
- "operatorName": "A String", # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
- "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.
- "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.
- },
- ],
- "name": "A String", # Name of the Search Application. Format: searchapplications/{application_id}.
- "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.
+ "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.
+ "operatorName": "A String", # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
+ "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
+ "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.
},
- "filterOptions": [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
- { # Filter options to be applied on query.
- "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 approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
- "compositeFilter": {
- "logicOperator": "A String", # The logic operator of the sub filter.
- "subFilters": [ # Sub filters.
- # Object with schema name: Filter
- ],
- },
- "valueFilter": {
- "value": { # Definition of a single value with generic type. # The value to be compared with.
- "timestampValue": "A String",
- "stringValue": "A String",
- "booleanValue": True or False,
- "integerValue": "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.
- "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.
+ ],
+ "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
+ { # Configurations for a source while processing a Search or Suggest request.
+ "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which 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. # The crowding configuration for the 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.
+ },
+ "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the 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.
+ "name": "A String", # Source name for content indexed by the Indexing API.
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ },
+ },
+ ],
+ "name": "A String", # Name of the Search Application. 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.
+ "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.
+ },
+ "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 the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
+ { # Filter options to be applied on query.
+ "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 approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
+ "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: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
+ "value": { # Definition of a single value with generic type. # The value to be compared with.
+ "integerValue": "A String",
+ "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.
+ "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.
+ },
+ "booleanValue": True or False,
+ "stringValue": "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: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
+ "compositeFilter": {
+ "logicOperator": "A String", # The logic operator of the sub filter.
+ "subFilters": [ # Sub filters.
+ # Object with schema name: Filter
+ ],
+ },
},
},
- },
- ],
+ ],
+ },
+ ],
+ "scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking 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.
},
- ],
- "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.
- "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
- },
- "sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.
- { # Configurations for a source while processing a Search or Suggest request.
- "crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which 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. # The crowding configuration for the source.
- "numResults": 42, # Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
- "numSuggestions": 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
- },
- "scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the 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.
- "name": "A String", # Source name for content indexed by the Indexing API.
- "predefinedSource": "A String", # Predefined content source for Google Apps.
- },
- },
- ],
- "scoringConfig": { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
- "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.
- },
-}
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -592,13 +592,6 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
- "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.
- },
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -608,6 +601,13 @@
"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.
},
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "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>