chore: regens API reference docs (#889)
diff --git a/docs/dyn/cloudsearch_v1.query.html b/docs/dyn/cloudsearch_v1.query.html
index 2a0ea9a..95fba86 100644
--- a/docs/dyn/cloudsearch_v1.query.html
+++ b/docs/dyn/cloudsearch_v1.query.html
@@ -80,21 +80,27 @@
<p class="firstline">Returns the sources Resource.</p>
<p class="toc_element">
- <code><a href="#search">search(body, x__xgafv=None)</a></code></p>
+ <code><a href="#search">search(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">The Cloud Search Query API provides the search method, which returns</p>
<p class="toc_element">
- <code><a href="#suggest">suggest(body, x__xgafv=None)</a></code></p>
+ <code><a href="#suggest">suggest(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Provides suggestions for autocompleting the query.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="search">search(body, x__xgafv=None)</code>
+ <code class="details" id="search">search(body=None, x__xgafv=None)</code>
<pre>The Cloud Search Query API provides the search method, which returns
the most relevant results from a user query. The results can come from
G Suite Apps, such as Gmail or Google Drive, or they can come from data
that you have indexed from a third party.
+**Note:** This API requires a standard end user account to execute.
+A service account can't perform Query API requests directly; to use a
+service account to perform queries, set up [G Suite domain-wide delegation
+of
+authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
+
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # The search API request.
@@ -116,15 +122,42 @@
# Valid values are between 1 and 100, inclusive.
# Default value is 10.
"queryInterpretationOptions": { # Options to interpret user query. # Options to interpret the user query.
+ "enableVerbatimMode": True or False, # Enable this flag to turn off all internal optimizations like natural
+ # language (NL) interpretation of queries, supplemental result retrieval,
+ # and usage of synonyms including custom ones.
+ # Nl interpretation will be disabled if either one of the two flags is true.
"disableNlInterpretation": True or False, # Flag to disable natural language (NL) interpretation of queries. Default is
# false, Set to true to disable natural language interpretation. NL
# interpretation only applies to predefined datasources.
},
- "sortOptions": { # The 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
+ "requestOptions": { # Shared request options for all RPC methods. # Request options, such as the search application and user timezone.
+ "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn".
+ # For more information, see
+ # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ # For translations.
+ #
+ # Set this field using the language set in browser or for the page. In the
+ # event that the user's language preference is known, set this field to the
+ # known user language.
+ #
+ # When specified, the documents in search results are biased towards the
+ # specified language.
+ #
+ # The suggest API does not use this parameter. Instead, suggest autocompletes
+ # only based on characters in the query.
+ "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request
+ "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
+ # Otherwise, ignore this field.
+ },
+ "searchApplicationId": "A String", # The ID generated when you create a search application using the
+ # [admin console](https://support.google.com/a/answer/9043922).
+ "timeZone": "A String", # Current user's time zone id, such as "America/Los_Angeles" or
+ # "Australia/Sydney". These IDs are defined by
+ # [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/)
+ # project, and currently available in the file
+ # [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml).
+ # This field is used to correctly interpret date and time queries.
+ # If this field is not specified, the default time zone (UTC) is used.
},
"dataSourceRestrictions": [ # The sources to use for querying. If not specified, all data sources
# from the current search application are used.
@@ -141,10 +174,10 @@
# For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
"filter": { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
- # approaches: <br/><br/>
+ # approaches: <br/><br/>
# **1. Setting a ValueFilter.** The name must match an operator_name defined in
# the schema for your data source.
- # <br/>
+ # <br/>
# **2. Setting a CompositeFilter.** The filters are evaluated
# using the logical operator. The top-level operators can only be either an AND
# or a NOT. AND can appear only at the top-most level. OR can appear only under
@@ -159,10 +192,10 @@
"operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*.
# The filter can work against both types of filters defined in the schema
# for your data source:
- # <br/><br/>
+ # <br/><br/>
# 1. `operator_name`, where the query filters results by the property
# that matches the value.
- # <br/>
+ # <br/>
# 2. `greater_than_operator_name` or `less_than_operator_name` in your
# schema. The query filters the results for the property values that are
# greater than or less than the supplied value in the query.
@@ -170,9 +203,9 @@
"timestampValue": "A String",
"doubleValue": 3.14,
"dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
"stringValue": "A String",
"booleanValue": True or False,
@@ -197,26 +230,11 @@
# See supported search operators in the [Cloud search
# Cheat
# Sheet](https://gsuite.google.com/learning-center/products/cloudsearch/cheat-sheet/)
- "requestOptions": { # Shared request options for all RPC methods. # Request options, such as the search application and user timezone.
- "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn".
- # For more information, see
- # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- # For translations.
- #
- # When specified, the documents in search results are biased towards the
- # specified language.
- # Suggest API does not use this parameter. It autocompletes only based on
- # characters in the query.
- "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request
- "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
- # Otherwise, ignore this field.
- },
- "searchApplicationId": "A String", # Id of the application created using SearchApplicationsService.
- "timeZone": "A String", # Current user's time zone id, such as "America/Los_Angeles" or
- # "Australia/Sydney". These IDs are defined by
- # [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/)
- # project, and currently available in the file
- # [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml)
+ "sortOptions": { # The 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
},
}
@@ -245,24 +263,19 @@
},
],
"name": "A String", # The resource name of the person to provide information about.
- # See <a href="https://developers.google.com/people/api/rest/v1/people/get">
- # People.get</a> from Google People API.
+ # See <a href="https://developers.google.com/people/api/rest/v1/people/get">
+ # People.get</a> from Google People API.
"personNames": [ # The person's name
{ # A person's name.
"displayName": "A String", # The read-only display name formatted according to the locale specified by
- # the viewer's account or the <code>Accept-Language</code> HTTP header.
+ # the viewer's account or the <code>Accept-Language</code> HTTP header.
},
],
"obfuscatedId": "A String", # Obfuscated ID of a person.
},
},
],
- "queryInterpretation": { # Query interpretation result for user query. Empty if query interpretation
- # is disabled.
- "interpretationType": "A String",
- "interpretedQuery": "A String", # The interpretation of the query used in search. For example, query "email
- # from john" will be interpreted as "from:john source:mail"
- },
+ "hasMoreResults": True or False, # Whether there are more search results matching the query.
"debugInfo": { # Debugging information about the response. # Debugging information about the response.
"formattedDebugInfo": "A String", # General debug info formatted for display.
},
@@ -314,17 +327,15 @@
"dateValues": { # List of date values.
"values": [
{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
],
},
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
- "A String",
- ],
- },
+ "name": "A String", # The name of the property. This name should correspond to the name of the
+ # property that was registered for object definition in the schema.
+ # The maximum allowable length for this property is 256 characters.
"enumValues": { # List of enum values.
"values": [ # The maximum allowable length for string values is 32 characters.
"A String",
@@ -351,9 +362,11 @@
"A String",
],
},
- "name": "A String", # The name of the property. This name should correspond to the name of the
- # property that was registered for object definition in the schema.
- # The maximum allowable length for this property is 256 characters.
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
+ "A String",
+ ],
+ },
},
],
"source": { # Defines sources for the suggest/search APIs. # The named source for the result, such as Gmail.
@@ -374,12 +387,12 @@
},
],
"name": "A String", # The resource name of the person to provide information about.
- # See <a href="https://developers.google.com/people/api/rest/v1/people/get">
- # People.get</a> from Google People API.
+ # See <a href="https://developers.google.com/people/api/rest/v1/people/get">
+ # People.get</a> from Google People API.
"personNames": [ # The person's name
{ # A person's name.
"displayName": "A String", # The read-only display name formatted according to the locale specified by
- # the viewer's account or the <code>Accept-Language</code> HTTP header.
+ # the viewer's account or the <code>Accept-Language</code> HTTP header.
},
],
"obfuscatedId": "A String", # Obfuscated ID of a person.
@@ -402,17 +415,15 @@
"dateValues": { # List of date values.
"values": [
{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
],
},
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
- "A String",
- ],
- },
+ "name": "A String", # The name of the property. This name should correspond to the name of the
+ # property that was registered for object definition in the schema.
+ # The maximum allowable length for this property is 256 characters.
"enumValues": { # List of enum values.
"values": [ # The maximum allowable length for string values is 32 characters.
"A String",
@@ -439,9 +450,11 @@
"A String",
],
},
- "name": "A String", # The name of the property. This name should correspond to the name of the
- # property that was registered for object definition in the schema.
- # The maximum allowable length for this property is 256 characters.
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
+ "A String",
+ ],
+ },
},
"operatorName": "A String", # The operator name of the property.
"label": "A String", # The display label for the property.
@@ -488,9 +501,9 @@
"timestampValue": "A String",
"doubleValue": 3.14,
"dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
"stringValue": "A String",
"booleanValue": True or False,
@@ -515,23 +528,39 @@
},
],
},
- "hasMoreResults": True or False, # Whether there are more search results matching the query.
+ "queryInterpretation": { # Query interpretation result for user query. Empty if query interpretation
+ # is disabled.
+ "interpretedQuery": "A String", # The interpretation of the query used in search. For example, queries with
+ # natural language intent like "email from john" will be interpreted as
+ # "from:john source:mail". This field will not be filled when the reason is
+ # NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY.
+ "interpretationType": "A String",
+ "reason": "A String", # The reason for interpretation of the query. This field will not be
+ # UNSPECIFIED if the interpretation type is not NONE.
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="suggest">suggest(body, x__xgafv=None)</code>
+ <code class="details" id="suggest">suggest(body=None, x__xgafv=None)</code>
<pre>Provides suggestions for autocompleting the query.
+**Note:** This API requires a standard end user account to execute.
+A service account can't perform Query API requests directly; to use a
+service account to perform queries, set up [G Suite domain-wide delegation
+of
+authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
+
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request of suggest API.
- "dataSourceRestrictions": [ # The sources to use for suggestions. If not specified, all data sources
- # from the current search application are used.
- # Suggestions are based on Gmail titles. Suggestions from third party sources
- # are not available.
+ "dataSourceRestrictions": [ # The sources to use for suggestions. If not specified, the data sources
+ # are taken from the current search application.
+ #
+ # NOTE: Suggestions are supported only for third party data sources and
+ # people (i.e. PredefinedSource.PERSON).
{ # Restriction on Datasource.
"filterOptions": [ # Filter options restricting the results. If multiple filters
# are present, they are grouped by object type before joining.
@@ -545,10 +574,10 @@
# For now, schema specific filters cannot be used to filter suggestions.
{ # Filter options to be applied on query.
"filter": { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
- # approaches: <br/><br/>
+ # approaches: <br/><br/>
# **1. Setting a ValueFilter.** The name must match an operator_name defined in
# the schema for your data source.
- # <br/>
+ # <br/>
# **2. Setting a CompositeFilter.** The filters are evaluated
# using the logical operator. The top-level operators can only be either an AND
# or a NOT. AND can appear only at the top-most level. OR can appear only under
@@ -563,10 +592,10 @@
"operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*.
# The filter can work against both types of filters defined in the schema
# for your data source:
- # <br/><br/>
+ # <br/><br/>
# 1. `operator_name`, where the query filters results by the property
# that matches the value.
- # <br/>
+ # <br/>
# 2. `greater_than_operator_name` or `less_than_operator_name` in your
# schema. The query filters the results for the property values that are
# greater than or less than the supplied value in the query.
@@ -574,9 +603,9 @@
"timestampValue": "A String",
"doubleValue": 3.14,
"dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
"stringValue": "A String",
"booleanValue": True or False,
@@ -605,20 +634,28 @@
# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
# For translations.
#
+ # Set this field using the language set in browser or for the page. In the
+ # event that the user's language preference is known, set this field to the
+ # known user language.
+ #
# When specified, the documents in search results are biased towards the
# specified language.
- # Suggest API does not use this parameter. It autocompletes only based on
- # characters in the query.
+ #
+ # The suggest API does not use this parameter. Instead, suggest autocompletes
+ # only based on characters in the query.
"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request
"enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
# Otherwise, ignore this field.
},
- "searchApplicationId": "A String", # Id of the application created using SearchApplicationsService.
+ "searchApplicationId": "A String", # The ID generated when you create a search application using the
+ # [admin console](https://support.google.com/a/answer/9043922).
"timeZone": "A String", # Current user's time zone id, such as "America/Los_Angeles" or
# "Australia/Sydney". These IDs are defined by
# [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/)
# project, and currently available in the file
- # [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml)
+ # [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml).
+ # This field is used to correctly interpret date and time queries.
+ # If this field is not specified, the default time zone (UTC) is used.
},
}
@@ -654,12 +691,12 @@
},
],
"name": "A String", # The resource name of the person to provide information about.
- # See <a href="https://developers.google.com/people/api/rest/v1/people/get">
- # People.get</a> from Google People API.
+ # See <a href="https://developers.google.com/people/api/rest/v1/people/get">
+ # People.get</a> from Google People API.
"personNames": [ # The person's name
{ # A person's name.
"displayName": "A String", # The read-only display name formatted according to the locale specified by
- # the viewer's account or the <code>Accept-Language</code> HTTP header.
+ # the viewer's account or the <code>Accept-Language</code> HTTP header.
},
],
"obfuscatedId": "A String", # Obfuscated ID of a person.