docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/cloudsearch_v1.query.sources.html b/docs/dyn/cloudsearch_v1.query.sources.html
index 579499c..b8a6575 100644
--- a/docs/dyn/cloudsearch_v1.query.sources.html
+++ b/docs/dyn/cloudsearch_v1.query.sources.html
@@ -75,42 +75,40 @@
<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.query.html">query</a> . <a href="cloudsearch_v1.query.sources.html">sources</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#list">list(requestOptions_timeZone=None, pageToken=None, requestOptions_debugOptions_enableDebugging=None, requestOptions_searchApplicationId=None, requestOptions_languageCode=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(pageToken=None, requestOptions_timeZone=None, requestOptions_debugOptions_enableDebugging=None, requestOptions_languageCode=None, requestOptions_searchApplicationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns list of sources that user can use for Search and Suggest APIs.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="list">list(requestOptions_timeZone=None, pageToken=None, requestOptions_debugOptions_enableDebugging=None, requestOptions_searchApplicationId=None, requestOptions_languageCode=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(pageToken=None, requestOptions_timeZone=None, requestOptions_debugOptions_enableDebugging=None, requestOptions_languageCode=None, requestOptions_searchApplicationId=None, x__xgafv=None)</code>
<pre>Returns list of sources that user can use for Search and Suggest APIs.
**Note:** This API requires a standard end user account to execute.
-A service account can't perform Query API requests directly; to use a
+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:
- requestOptions_timeZone: string, Current user's time zone id, such as "America/Los_Angeles" or
-"Australia/Sydney". These IDs are defined by
+ pageToken: string, Number of sources to return in the response.
+ requestOptions_timeZone: 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.
- pageToken: string, Number of sources to return in the response.
requestOptions_debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
Otherwise, ignore this field.
- requestOptions_searchApplicationId: string, The ID generated when you create a search application using the
-[admin console](https://support.google.com/a/answer/9043922).
- requestOptions_languageCode: string, The BCP-47 language code, such as "en-US" or "sr-Latn".
+ requestOptions_languageCode: 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
+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
@@ -118,6 +116,8 @@
The suggest API does not use this parameter. Instead, suggest autocompletes
only based on characters in the query.
+ requestOptions_searchApplicationId: string, The ID generated when you create a search application using the
+[admin console](https://support.google.com/a/answer/9043922).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -127,40 +127,40 @@
An object of the form:
{ # List sources response.
- "nextPageToken": "A String",
- "sources": [
+ "nextPageToken": "A String",
+ "sources": [
{ # List of sources that the user can search using the query API.
- "source": { # Defines sources for the suggest/search APIs. # Name of the source
- "predefinedSource": "A String", # Predefined content source for Google Apps.
- "name": "A String", # Source name for content indexed by the
- # Indexing API.
- },
- "operators": [ # List of all operators applicable for this source.
+ "operators": [ # List of all operators applicable for this source.
{ # The definition of a operator that can be used in a Search/Suggest request.
- "enumValues": [ # Potential list of values for the opeatror field. This field is only filled
- # when we can safely enumerate all the possible values of this operator.
- "A String",
- ],
- "displayName": "A String", # Display name of the operator
- "greaterThanOperatorName": "A String", # Indicates the operator name that can be used to isolate the property using
- # the greater-than operator.
- "isReturnable": True or False, # Will the property associated with this facet be returned as part of search
+ "operatorName": "A String", # The name of the operator.
+ "isSortable": True or False, # Can this operator be used to sort results.
+ "isFacetable": True or False, # Can this operator be used to get facets.
+ "isReturnable": True or False, # Will the property associated with this facet be returned as part of search
# results.
- "lessThanOperatorName": "A String", # Indicates the operator name that can be used to isolate the property using
+ "greaterThanOperatorName": "A String", # Indicates the operator name that can be used to isolate the property using
+ # the greater-than operator.
+ "displayName": "A String", # Display name of the operator
+ "isRepeatable": True or False, # Indicates if multiple values can be set for this property.
+ "enumValues": [ # Potential list of values for the opeatror field. This field is only filled
+ # when we can safely enumerate all the possible values of this operator.
+ "A String",
+ ],
+ "lessThanOperatorName": "A String", # Indicates the operator name that can be used to isolate the property using
# the less-than operator.
- "isRepeatable": True or False, # Indicates if multiple values can be set for this property.
- "isFacetable": True or False, # Can this operator be used to get facets.
- "isSuggestable": True or False, # Can get suggestions for this field.
- "type": "A String", # Type of the operator.
- "operatorName": "A String", # The name of the operator.
- "isSortable": True or False, # Can this operator be used to sort results.
- "objectType": "A String", # Name of the object corresponding to the operator. This field is only filled
+ "isSuggestable": True or False, # Can get suggestions for this field.
+ "type": "A String", # Type of the operator.
+ "objectType": "A String", # Name of the object corresponding to the operator. This field is only filled
# for schema-specific operators, and is unset for common operators.
},
],
- "displayName": "A String", # Display name of the data source.
- "shortName": "A String", # A short name or alias for the source. This value can be used with the
- # 'source' operator.
+ "shortName": "A String", # A short name or alias for the source. This value can be used with the
+ # 'source' operator.
+ "displayName": "A String", # Display name of the data source.
+ "source": { # Defines sources for the suggest/search APIs. # Name of the source
+ "predefinedSource": "A String", # Predefined content source for Google Apps.
+ "name": "A String", # Source name for content indexed by the
+ # Indexing API.
+ },
},
],
}</pre>
@@ -175,7 +175,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>