docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/cloudsearch_v1.settings.datasources.html b/docs/dyn/cloudsearch_v1.settings.datasources.html
index 3ffe4ab..247e70c 100644
--- a/docs/dyn/cloudsearch_v1.settings.datasources.html
+++ b/docs/dyn/cloudsearch_v1.settings.datasources.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a datasource.</p>
<p class="toc_element">
- <code><a href="#list">list(pageSize=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(pageToken=None, pageSize=None, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists datasources.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -104,47 +104,47 @@
The object takes the form of:
{ # Datasource is a logical namespace for items to be indexed.
- # All items must belong to a datasource. This is the prerequisite before
- # items can be indexed into Cloud Search.
- "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
- # schema.
- "A String",
- ],
- "displayName": "A String", # Required. Display name of the datasource
- # The maximum length is 300 characters.
- "name": "A String", # Name of the datasource resource.
- # Format: datasources/{source_id}.
- # <br />The name is ignored when creating a datasource.
- "disableModifications": True or False, # If true, Indexing API rejects any modification calls to this datasource
- # such as create, update, and delete.
- # Disabling this does not imply halting process of previously
- # accepted data.
- "indexingServiceAccounts": [ # List of service accounts that have indexing access.
- "A String",
- ],
- "itemsVisibility": [ # This field restricts visibility to items at the datasource level. Items
- # within the datasource are restricted to the union of users and groups
- # included in this field. Note that, this does not ensure access to a
- # specific item, as users need to have ACL permissions on the contained
- # items. This ensures a high level access on the entire datasource, and
- # that the individual items are not shared outside this visibility.
- {
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
- # customer.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- },
- ],
- "shortName": "A String", # A short name or alias for the source. This value will be used to match the
- # 'source' operator. For example, if the short name is *&lt;value&gt;* then
- # queries like *source:&lt;value&gt;* will only return results for this
- # source. The value must be unique across all datasources. The value must
- # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
- # with 'google' and cannot be one of the following: mail, gmail, docs, drive,
- # groups, sites, calendar, hangouts, gplus, keep, people, teams.
- # Its maximum length is 32 characters.
- "disableServing": True or False, # Disable serving any search or assist results.
- }
+ # All items must belong to a datasource. This is the prerequisite before
+ # items can be indexed into Cloud Search.
+ "disableModifications": True or False, # If true, Indexing API rejects any modification calls to this datasource
+ # such as create, update, and delete.
+ # Disabling this does not imply halting process of previously
+ # accepted data.
+ "indexingServiceAccounts": [ # List of service accounts that have indexing access.
+ "A String",
+ ],
+ "disableServing": True or False, # Disable serving any search or assist results.
+ "displayName": "A String", # Required. Display name of the datasource
+ # The maximum length is 300 characters.
+ "itemsVisibility": [ # This field restricts visibility to items at the datasource level. Items
+ # within the datasource are restricted to the union of users and groups
+ # included in this field. Note that, this does not ensure access to a
+ # specific item, as users need to have ACL permissions on the contained
+ # items. This ensures a high level access on the entire datasource, and
+ # that the individual items are not shared outside this visibility.
+ {
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
+ # customer.
+ },
+ ],
+ "shortName": "A String", # A short name or alias for the source. This value will be used to match the
+ # 'source' operator. For example, if the short name is *&lt;value&gt;* then
+ # queries like *source:&lt;value&gt;* will only return results for this
+ # source. The value must be unique across all datasources. The value must
+ # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
+ # with 'google' and cannot be one of the following: mail, gmail, docs, drive,
+ # groups, sites, calendar, hangouts, gplus, keep, people, teams.
+ # Its maximum length is 32 characters.
+ "name": "A String", # Name of the datasource resource.
+ # Format: datasources/{source_id}.
+ # <br />The name is ignored when creating a datasource.
+ "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
+ # schema.
+ "A String",
+ ],
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -156,16 +156,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -173,28 +167,34 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
@@ -220,16 +220,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -237,28 +231,34 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
@@ -283,62 +283,62 @@
An object of the form:
{ # Datasource is a logical namespace for items to be indexed.
- # All items must belong to a datasource. This is the prerequisite before
- # items can be indexed into Cloud Search.
- "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
- # schema.
- "A String",
- ],
- "displayName": "A String", # Required. Display name of the datasource
- # The maximum length is 300 characters.
- "name": "A String", # Name of the datasource resource.
- # Format: datasources/{source_id}.
- # <br />The name is ignored when creating a datasource.
- "disableModifications": True or False, # If true, Indexing API rejects any modification calls to this datasource
- # such as create, update, and delete.
- # Disabling this does not imply halting process of previously
- # accepted data.
- "indexingServiceAccounts": [ # List of service accounts that have indexing access.
- "A String",
- ],
- "itemsVisibility": [ # This field restricts visibility to items at the datasource level. Items
- # within the datasource are restricted to the union of users and groups
- # included in this field. Note that, this does not ensure access to a
- # specific item, as users need to have ACL permissions on the contained
- # items. This ensures a high level access on the entire datasource, and
- # that the individual items are not shared outside this visibility.
- {
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
- # customer.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- },
- ],
- "shortName": "A String", # A short name or alias for the source. This value will be used to match the
- # 'source' operator. For example, if the short name is *&lt;value&gt;* then
- # queries like *source:&lt;value&gt;* will only return results for this
- # source. The value must be unique across all datasources. The value must
- # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
- # with 'google' and cannot be one of the following: mail, gmail, docs, drive,
- # groups, sites, calendar, hangouts, gplus, keep, people, teams.
- # Its maximum length is 32 characters.
- "disableServing": True or False, # Disable serving any search or assist results.
- }</pre>
+ # All items must belong to a datasource. This is the prerequisite before
+ # items can be indexed into Cloud Search.
+ "disableModifications": True or False, # If true, Indexing API rejects any modification calls to this datasource
+ # such as create, update, and delete.
+ # Disabling this does not imply halting process of previously
+ # accepted data.
+ "indexingServiceAccounts": [ # List of service accounts that have indexing access.
+ "A String",
+ ],
+ "disableServing": True or False, # Disable serving any search or assist results.
+ "displayName": "A String", # Required. Display name of the datasource
+ # The maximum length is 300 characters.
+ "itemsVisibility": [ # This field restricts visibility to items at the datasource level. Items
+ # within the datasource are restricted to the union of users and groups
+ # included in this field. Note that, this does not ensure access to a
+ # specific item, as users need to have ACL permissions on the contained
+ # items. This ensures a high level access on the entire datasource, and
+ # that the individual items are not shared outside this visibility.
+ {
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
+ # customer.
+ },
+ ],
+ "shortName": "A String", # A short name or alias for the source. This value will be used to match the
+ # 'source' operator. For example, if the short name is *&lt;value&gt;* then
+ # queries like *source:&lt;value&gt;* will only return results for this
+ # source. The value must be unique across all datasources. The value must
+ # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
+ # with 'google' and cannot be one of the following: mail, gmail, docs, drive,
+ # groups, sites, calendar, hangouts, gplus, keep, people, teams.
+ # Its maximum length is 32 characters.
+ "name": "A String", # Name of the datasource resource.
+ # Format: datasources/{source_id}.
+ # <br />The name is ignored when creating a datasource.
+ "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
+ # schema.
+ "A String",
+ ],
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(pageSize=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(pageToken=None, pageSize=None, debugOptions_enableDebugging=None, x__xgafv=None)</code>
<pre>Lists datasources.
**Note:** This API requires an admin account to execute.
Args:
+ pageToken: string, Starting index of the results.
pageSize: integer, Maximum number of datasources to fetch in a request.
The max value is 100.
<br />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.
- pageToken: string, Starting index of the results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -348,52 +348,52 @@
An object of the form:
{
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
- "sources": [
+ "sources": [
{ # Datasource is a logical namespace for items to be indexed.
- # All items must belong to a datasource. This is the prerequisite before
- # items can be indexed into Cloud Search.
- "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
- # schema.
- "A String",
- ],
- "displayName": "A String", # Required. Display name of the datasource
- # The maximum length is 300 characters.
- "name": "A String", # Name of the datasource resource.
- # Format: datasources/{source_id}.
- # <br />The name is ignored when creating a datasource.
- "disableModifications": True or False, # If true, Indexing API rejects any modification calls to this datasource
- # such as create, update, and delete.
- # Disabling this does not imply halting process of previously
- # accepted data.
- "indexingServiceAccounts": [ # List of service accounts that have indexing access.
- "A String",
- ],
- "itemsVisibility": [ # This field restricts visibility to items at the datasource level. Items
- # within the datasource are restricted to the union of users and groups
- # included in this field. Note that, this does not ensure access to a
- # specific item, as users need to have ACL permissions on the contained
- # items. This ensures a high level access on the entire datasource, and
- # that the individual items are not shared outside this visibility.
- {
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
- # customer.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- },
- ],
- "shortName": "A String", # A short name or alias for the source. This value will be used to match the
- # 'source' operator. For example, if the short name is *&lt;value&gt;* then
- # queries like *source:&lt;value&gt;* will only return results for this
- # source. The value must be unique across all datasources. The value must
- # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
- # with 'google' and cannot be one of the following: mail, gmail, docs, drive,
- # groups, sites, calendar, hangouts, gplus, keep, people, teams.
- # Its maximum length is 32 characters.
- "disableServing": True or False, # Disable serving any search or assist results.
- },
+ # All items must belong to a datasource. This is the prerequisite before
+ # items can be indexed into Cloud Search.
+ "disableModifications": True or False, # If true, Indexing API rejects any modification calls to this datasource
+ # such as create, update, and delete.
+ # Disabling this does not imply halting process of previously
+ # accepted data.
+ "indexingServiceAccounts": [ # List of service accounts that have indexing access.
+ "A String",
+ ],
+ "disableServing": True or False, # Disable serving any search or assist results.
+ "displayName": "A String", # Required. Display name of the datasource
+ # The maximum length is 300 characters.
+ "itemsVisibility": [ # This field restricts visibility to items at the datasource level. Items
+ # within the datasource are restricted to the union of users and groups
+ # included in this field. Note that, this does not ensure access to a
+ # specific item, as users need to have ACL permissions on the contained
+ # items. This ensures a high level access on the entire datasource, and
+ # that the individual items are not shared outside this visibility.
+ {
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
+ # customer.
+ },
+ ],
+ "shortName": "A String", # A short name or alias for the source. This value will be used to match the
+ # 'source' operator. For example, if the short name is *&lt;value&gt;* then
+ # queries like *source:&lt;value&gt;* will only return results for this
+ # source. The value must be unique across all datasources. The value must
+ # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
+ # with 'google' and cannot be one of the following: mail, gmail, docs, drive,
+ # groups, sites, calendar, hangouts, gplus, keep, people, teams.
+ # Its maximum length is 32 characters.
+ "name": "A String", # Name of the datasource resource.
+ # Format: datasources/{source_id}.
+ # <br />The name is ignored when creating a datasource.
+ "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
+ # schema.
+ "A String",
+ ],
+ },
],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ # more results in the list.
}</pre>
</div>
@@ -406,7 +406,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>
@@ -425,50 +425,50 @@
The object takes the form of:
{
- "source": { # Datasource is a logical namespace for items to be indexed.
- # All items must belong to a datasource. This is the prerequisite before
- # items can be indexed into Cloud Search.
- "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
- # schema.
- "A String",
- ],
- "displayName": "A String", # Required. Display name of the datasource
- # The maximum length is 300 characters.
- "name": "A String", # Name of the datasource resource.
- # Format: datasources/{source_id}.
- # <br />The name is ignored when creating a datasource.
- "disableModifications": True or False, # If true, Indexing API rejects any modification calls to this datasource
- # such as create, update, and delete.
- # Disabling this does not imply halting process of previously
- # accepted data.
- "indexingServiceAccounts": [ # List of service accounts that have indexing access.
- "A String",
- ],
- "itemsVisibility": [ # This field restricts visibility to items at the datasource level. Items
- # within the datasource are restricted to the union of users and groups
- # included in this field. Note that, this does not ensure access to a
- # specific item, as users need to have ACL permissions on the contained
- # items. This ensures a high level access on the entire datasource, and
- # that the individual items are not shared outside this visibility.
- {
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
- # customer.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- },
- ],
- "shortName": "A String", # A short name or alias for the source. This value will be used to match the
- # 'source' operator. For example, if the short name is *&lt;value&gt;* then
- # queries like *source:&lt;value&gt;* will only return results for this
- # source. The value must be unique across all datasources. The value must
- # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
- # with 'google' and cannot be one of the following: mail, gmail, docs, drive,
- # groups, sites, calendar, hangouts, gplus, keep, people, teams.
- # Its maximum length is 32 characters.
- "disableServing": True or False, # Disable serving any search or assist results.
- },
- "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
- "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
+ "source": { # Datasource is a logical namespace for items to be indexed.
+ # All items must belong to a datasource. This is the prerequisite before
+ # items can be indexed into Cloud Search.
+ "disableModifications": True or False, # If true, Indexing API rejects any modification calls to this datasource
+ # such as create, update, and delete.
+ # Disabling this does not imply halting process of previously
+ # accepted data.
+ "indexingServiceAccounts": [ # List of service accounts that have indexing access.
+ "A String",
+ ],
+ "disableServing": True or False, # Disable serving any search or assist results.
+ "displayName": "A String", # Required. Display name of the datasource
+ # The maximum length is 300 characters.
+ "itemsVisibility": [ # This field restricts visibility to items at the datasource level. Items
+ # within the datasource are restricted to the union of users and groups
+ # included in this field. Note that, this does not ensure access to a
+ # specific item, as users need to have ACL permissions on the contained
+ # items. This ensures a high level access on the entire datasource, and
+ # that the individual items are not shared outside this visibility.
+ {
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
+ # customer.
+ },
+ ],
+ "shortName": "A String", # A short name or alias for the source. This value will be used to match the
+ # 'source' operator. For example, if the short name is *&lt;value&gt;* then
+ # queries like *source:&lt;value&gt;* will only return results for this
+ # source. The value must be unique across all datasources. The value must
+ # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
+ # with 'google' and cannot be one of the following: mail, gmail, docs, drive,
+ # groups, sites, calendar, hangouts, gplus, keep, people, teams.
+ # Its maximum length is 32 characters.
+ "name": "A String", # Name of the datasource resource.
+ # Format: datasources/{source_id}.
+ # <br />The name is ignored when creating a datasource.
+ "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
+ # schema.
+ "A String",
+ ],
+ },
+ "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
+ "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
# Otherwise, ignore this field.
},
}
@@ -483,16 +483,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -500,28 +494,34 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>