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/cloudasset_v1beta1.projects.html b/docs/dyn/cloudasset_v1beta1.projects.html
index 467bc11..58faf93 100644
--- a/docs/dyn/cloudasset_v1beta1.projects.html
+++ b/docs/dyn/cloudasset_v1beta1.projects.html
@@ -80,14 +80,14 @@
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
- <code><a href="#batchGetAssetsHistory">batchGetAssetsHistory(parent, contentType=None, assetNames=None, readTimeWindow_startTime=None, readTimeWindow_endTime=None, x__xgafv=None)</a></code></p>
+ <code><a href="#batchGetAssetsHistory">batchGetAssetsHistory(parent, contentType=None, readTimeWindow_endTime=None, readTimeWindow_startTime=None, assetNames=None, x__xgafv=None)</a></code></p>
<p class="firstline">Batch gets the update history of assets that overlap a time window.</p>
<p class="toc_element">
<code><a href="#exportAssets">exportAssets(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Exports assets with time and resource types to a given Cloud Storage</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="batchGetAssetsHistory">batchGetAssetsHistory(parent, contentType=None, assetNames=None, readTimeWindow_startTime=None, readTimeWindow_endTime=None, x__xgafv=None)</code>
+ <code class="details" id="batchGetAssetsHistory">batchGetAssetsHistory(parent, contentType=None, readTimeWindow_endTime=None, readTimeWindow_startTime=None, assetNames=None, x__xgafv=None)</code>
<pre>Batch gets the update history of assets that overlap a time window.
For RESOURCE content, this API outputs history with asset in both
non-delete or deleted status.
@@ -98,9 +98,12 @@
Args:
parent: string, Required. The relative name of the root asset. It can only be an
-organization number (such as "organizations/123"), a project ID (such as
-"projects/my-project-id")", or a project number (such as "projects/12345"). (required)
+organization number (such as "organizations/123"), a project ID (such as
+"projects/my-project-id")", or a project number (such as "projects/12345"). (required)
contentType: string, Optional. The content type.
+ readTimeWindow_endTime: string, End time of the time window (inclusive).
+Current timestamp if not specified.
+ readTimeWindow_startTime: string, Start time of the time window (exclusive).
assetNames: string, A list of the full names of the assets. For example:
`//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
See [Resource
@@ -109,9 +112,6 @@
The request becomes a no-op if the asset name list is empty, and the max
size of the asset name list is 100 in one request. (repeated)
- readTimeWindow_startTime: string, Start time of the time window (exclusive).
- readTimeWindow_endTime: string, End time of the time window (inclusive).
-Current timestamp if not specified.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -121,18 +121,23 @@
An object of the form:
{ # Batch get assets history response.
- "assets": [ # A list of assets with valid time windows.
+ "assets": [ # A list of assets with valid time windows.
{ # Temporal asset. In addition to the asset, the temporal asset includes the
# status of the asset and valid from and to time of it.
- "deleted": True or False, # If the asset is deleted or not.
- "window": { # A time window of (start_time, end_time]. # The time window when the asset data and state was observed.
- "endTime": "A String", # End time of the time window (inclusive).
+ "deleted": True or False, # If the asset is deleted or not.
+ "window": { # A time window of (start_time, end_time]. # The time window when the asset data and state was observed.
+ "endTime": "A String", # End time of the time window (inclusive).
# Current timestamp if not specified.
- "startTime": "A String", # Start time of the time window (exclusive).
+ "startTime": "A String", # Start time of the time window (exclusive).
},
- "asset": { # Cloud asset. This includes all Google Cloud Platform resources, # Asset.
+ "asset": { # Cloud asset. This includes all Google Cloud Platform resources, # Asset.
# Cloud IAM policies, and other non-GCP assets.
- "iamPolicy": { # An Identity and Access Management (IAM) policy, which specifies access # Representation of the actual Cloud IAM policy set on a cloud resource. For
+ "name": "A String", # The full name of the asset. For example:
+ # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
+ # See [Resource
+ # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
+ # for more information.
+ "iamPolicy": { # An Identity and Access Management (IAM) policy, which specifies access # Representation of the actual Cloud IAM policy set on a cloud resource. For
# each resource, there must be at most one Cloud IAM policy set on it.
# controls for Google Cloud resources.
#
@@ -151,28 +156,28 @@
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -190,98 +195,13 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service.
- # The configuration determines which permission types are logged, and what
- # identities, if any, are exempted from logging.
- # An AuditConfig must have one or more AuditLogConfigs.
- #
- # If there are AuditConfigs for both `allServices` and a specific service,
- # the union of the two AuditConfigs is used for that service: the log_types
- # specified in each AuditConfig are enabled, and the exempted_members in each
- # AuditLogConfig are exempted.
- #
- # Example Policy with multiple AuditConfigs:
- #
- # {
- # "audit_configs": [
- # {
- # "service": "allServices"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # },
- # {
- # "log_type": "ADMIN_READ",
- # }
- # ]
- # },
- # {
- # "service": "sampleservice.googleapis.com"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # },
- # {
- # "log_type": "DATA_WRITE",
- # "exempted_members": [
- # "user:aliya@example.com"
- # ]
- # }
- # ]
- # }
- # ]
- # }
- #
- # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
- # logging. It also exempts jose@example.com from DATA_READ logging, and
- # aliya@example.com from DATA_WRITE logging.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions.
- # Example:
- #
- # {
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # }
- # ]
- # }
- #
- # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # jose@example.com from DATA_READ logging.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
- # permission.
- # Follows the same format of Binding.members.
- "A String",
- ],
- "logType": "A String", # The log type that this config enables.
- },
- ],
- "service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
- # `allServices` is a special value that covers all services.
- },
- ],
- "version": 42, # Specifies the format of the policy.
+ "version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
@@ -302,13 +222,140 @@
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # },
+ # {
+ # "log_type": "ADMIN_READ",
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts jose@example.com from DATA_READ logging, and
+ # aliya@example.com from DATA_WRITE logging.
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ },
+ ],
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ # NOTE: An unsatisfied condition will not allow user access via current
+ # binding. Different bindings, including their conditions, are examined
+ # independently.
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ },
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -351,55 +398,13 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
@@ -412,14 +417,26 @@
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
},
- "assetType": "A String", # Type of the asset. Example: "google.compute.Disk".
- "resource": { # Representation of a cloud resource. # Representation of the resource.
- "resourceUrl": "A String", # The REST URL for accessing the resource. An HTTP GET operation using this
+ "resource": { # Representation of a cloud resource. # Representation of the resource.
+ "resourceUrl": "A String", # The REST URL for accessing the resource. An HTTP GET operation using this
# URL returns the resource itself.
# Example:
# `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`.
# It will be left unspecified for resources without a REST API.
- "parent": "A String", # The full name of the immediate parent of this resource. See
+ "discoveryName": "A String", # The JSON schema name listed in the discovery document.
+ # Example: "Project". It will be left unspecified for resources (such as
+ # Cloud Bigtable) without a discovery-based API.
+ "version": "A String", # The API version. Example: "v1".
+ "data": { # The content of the resource, in which some sensitive fields are scrubbed
+ # away and may not be present.
+ "a_key": "", # Properties of the object.
+ },
+ "discoveryDocumentUri": "A String", # The URL of the discovery document containing the resource's JSON schema.
+ # For example:
+ # `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`.
+ # It will be left unspecified for resources without a discovery-based API,
+ # such as Cloud Bigtable.
+ "parent": "A String", # The full name of the immediate parent of this resource. See
# [Resource
# Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
# for more information.
@@ -427,28 +444,11 @@
# For GCP assets, it is the parent resource defined in the [Cloud IAM policy
# hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).
# For example:
- # `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`.
+ # `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`.
#
# For third-party assets, it is up to the users to define.
- "discoveryDocumentUri": "A String", # The URL of the discovery document containing the resource's JSON schema.
- # For example:
- # `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`.
- # It will be left unspecified for resources without a discovery-based API,
- # such as Cloud Bigtable.
- "discoveryName": "A String", # The JSON schema name listed in the discovery document.
- # Example: "Project". It will be left unspecified for resources (such as
- # Cloud Bigtable) without a discovery-based API.
- "version": "A String", # The API version. Example: "v1".
- "data": { # The content of the resource, in which some sensitive fields are scrubbed
- # away and may not be present.
- "a_key": "", # Properties of the object.
- },
},
- "name": "A String", # The full name of the asset. For example:
- # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
- # See [Resource
- # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
- # for more information.
+ "assetType": "A String", # Type of the asset. Example: "google.compute.Disk".
},
},
],
@@ -464,45 +464,45 @@
Args:
parent: string, Required. The relative name of the root asset. This can only be an
-organization number (such as "organizations/123"), a project ID (such as
-"projects/my-project-id"), a project number (such as "projects/12345"), or
-a folder number (such as "folders/123"). (required)
+organization number (such as "organizations/123"), a project ID (such as
+"projects/my-project-id"), a project number (such as "projects/12345"), or
+a folder number (such as "folders/123"). (required)
body: object, The request body.
The object takes the form of:
{ # Export asset request.
- "assetTypes": [ # A list of asset types of which to take a snapshot for. For example:
- # "google.compute.Disk". If specified, only matching assets will be returned.
- # See [Introduction to Cloud Asset
- # Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview)
- # for all supported asset types.
- "A String",
- ],
- "contentType": "A String", # Asset content type. If not specified, no content but the asset name will be
- # returned.
- "outputConfig": { # Output configuration for export assets destination. # Required. Output configuration indicating where the results will be output
- # to. All results will be in newline delimited JSON format.
- "gcsDestination": { # A Cloud Storage location. # Destination on Cloud Storage.
- "uriPrefix": "A String", # The uri prefix of all generated Cloud Storage objects. For example:
- # "gs://bucket_name/object_name_prefix". Each object uri is in format:
- # "gs://bucket_name/object_name_prefix/<asset type>/<shard number> and only
- # contains assets for that type. <shard number> starts from 0. For example:
- # "gs://bucket_name/object_name_prefix/google.compute.disk/0" is the first
- # shard of output objects containing all google.compute.disk assets.
- # An INVALID_ARGUMENT error will be returned if file with the same name
- # "gs://bucket_name/object_name_prefix" already exists.
- "uri": "A String", # The uri of the Cloud Storage object. It's the same uri that is used by
- # gsutil. For example: "gs://bucket_name/object_name". See [Viewing and
- # Editing Object
- # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
- # for more information.
- },
- },
- "readTime": "A String", # Timestamp to take an asset snapshot. This can only be set to a timestamp
+ "readTime": "A String", # Timestamp to take an asset snapshot. This can only be set to a timestamp
# between 2018-10-02 UTC (inclusive) and the current time. If not specified,
# the current time will be used. Due to delays in resource data collection
# and indexing, there is a volatile window during which running the same
# query may get different results.
+ "contentType": "A String", # Asset content type. If not specified, no content but the asset name will be
+ # returned.
+ "outputConfig": { # Output configuration for export assets destination. # Required. Output configuration indicating where the results will be output
+ # to. All results will be in newline delimited JSON format.
+ "gcsDestination": { # A Cloud Storage location. # Destination on Cloud Storage.
+ "uri": "A String", # The uri of the Cloud Storage object. It's the same uri that is used by
+ # gsutil. For example: "gs://bucket_name/object_name". See [Viewing and
+ # Editing Object
+ # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
+ # for more information.
+ "uriPrefix": "A String", # The uri prefix of all generated Cloud Storage objects. For example:
+ # "gs://bucket_name/object_name_prefix". Each object uri is in format:
+ # "gs://bucket_name/object_name_prefix/<asset type>/<shard number> and only
+ # contains assets for that type. <shard number> starts from 0. For example:
+ # "gs://bucket_name/object_name_prefix/google.compute.disk/0" is the first
+ # shard of output objects containing all google.compute.disk assets.
+ # An INVALID_ARGUMENT error will be returned if file with the same name
+ # "gs://bucket_name/object_name_prefix" already exists.
+ },
+ },
+ "assetTypes": [ # A list of asset types of which to take a snapshot for. For example:
+ # "google.compute.Disk". If specified, only matching assets will be returned.
+ # See [Introduction to Cloud Asset
+ # Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview)
+ # for all supported asset types.
+ "A String",
+ ],
}
x__xgafv: string, V1 error format.
@@ -515,34 +515,7 @@
{ # 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.
- },
- "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
- # message types for APIs to use.
- {
- "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.
- # 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
@@ -550,11 +523,38 @@
# 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.
+ # 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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "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.
}</pre>
</div>