docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/serviceconsumermanagement_v1.services.tenancyUnits.html b/docs/dyn/serviceconsumermanagement_v1.services.tenancyUnits.html
index 6b6426f..fe4fcf5 100644
--- a/docs/dyn/serviceconsumermanagement_v1.services.tenancyUnits.html
+++ b/docs/dyn/serviceconsumermanagement_v1.services.tenancyUnits.html
@@ -93,7 +93,7 @@
<code><a href="#deleteProject">deleteProject(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified project resource identified by a tenant resource tag.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Find the tenancy unit for a managed service and service consumer.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -122,15 +122,17 @@
{ # Request to add a newly created and configured tenant project to a tenancy
# unit.
- "tag": "A String", # Tag of the added project. Must be less than 128 characters. Required.
"projectConfig": { # This structure defines a tenant project to be added to the specified tenancy # Configuration of the new tenant project to be added to tenancy unit
# resources.
# unit and its initial configuration and properties. A project lien is created
# for the tenant project to prevent the tenant project from being deleted
# accidentally. The lien is deleted as part of tenant project removal.
- "labels": { # Labels that are applied to this project.
- "a_key": "A String",
- },
+ "services": [ # Google Cloud API names of services that are activated on this project
+ # during provisioning. If any of these services can't be activated,
+ # the request fails.
+ # For example: 'compute.googleapis.com','cloudfunctions.googleapis.com'
+ "A String",
+ ],
"serviceAccountConfig": { # Describes the service account configuration for the tenant project. # Configuration for the IAM service account on the tenant project.
"accountId": "A String", # ID of the IAM service account to be created in tenant project.
# The email format of the service account is
@@ -142,11 +144,10 @@
"A String",
],
},
- "folder": "A String", # Folder where project in this tenancy unit must be located
- # This folder must have been previously created with the required
- # permissions for the caller to create and configure a project in it.
- # Valid folder resource names have the format `folders/{folder_number}`
- # (for example, `folders/123456`).
+ "billingConfig": { # Describes the billing configuration for a new tenant project. # Billing account properties. The billing account must be specified.
+ "billingAccount": "A String", # Name of the billing account.
+ # For example `billingAccounts/012345-567890-ABCDEF`.
+ },
"tenantProjectPolicy": { # Describes policy settings that need to be applied to a newly # Describes ownership and policies for the new tenant project. Required.
# created tenant project.
"policyBindings": [ # Policy bindings to be applied to the tenant project, in addition to the
@@ -156,27 +157,26 @@
# members for `roles/owner`, at least one of them must be either the `user`
# or `group` type.
{ # Translates to IAM Policy bindings (without auditing at this level)
+ "role": "A String", # Role. (https://cloud.google.com/iam/docs/understanding-roles)
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"members": [ # Uses the same format as in IAM policy.
# `member` must include both a prefix and ID. For example, `user:{emailId}`,
# `serviceAccount:{emailId}`, `group:{emailId}`.
"A String",
],
- "role": "A String", # Role. (https://cloud.google.com/iam/docs/understanding-roles)
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
},
- "services": [ # Google Cloud API names of services that are activated on this project
- # during provisioning. If any of these services can't be activated,
- # the request fails.
- # For example: 'compute.googleapis.com','cloudfunctions.googleapis.com'
- "A String",
- ],
- "billingConfig": { # Describes the billing configuration for a new tenant project. # Billing account properties. The billing account must be specified.
- "billingAccount": "A String", # Name of the billing account.
- # For example `billingAccounts/012345-567890-ABCDEF`.
+ "folder": "A String", # Folder where project in this tenancy unit must be located
+ # This folder must have been previously created with the required
+ # permissions for the caller to create and configure a project in it.
+ # Valid folder resource names have the format `folders/{folder_number}`
+ # (for example, `folders/123456`).
+ "labels": { # Labels that are applied to this project.
+ "a_key": "A String",
},
},
+ "tag": "A String", # Tag of the added project. Must be less than 128 characters. Required.
}
x__xgafv: string, V1 error format.
@@ -189,6 +189,27 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
@@ -208,27 +229,6 @@
"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.
- },
- ],
- "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.
- },
- "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>
@@ -259,14 +259,16 @@
The object takes the form of:
{ # Request to apply configuration to an existing tenant project.
- "tag": "A String", # Tag of the project. Must be less than 128 characters. Required.
"projectConfig": { # This structure defines a tenant project to be added to the specified tenancy # Configuration that should be applied to the existing tenant project.
# unit and its initial configuration and properties. A project lien is created
# for the tenant project to prevent the tenant project from being deleted
# accidentally. The lien is deleted as part of tenant project removal.
- "labels": { # Labels that are applied to this project.
- "a_key": "A String",
- },
+ "services": [ # Google Cloud API names of services that are activated on this project
+ # during provisioning. If any of these services can't be activated,
+ # the request fails.
+ # For example: 'compute.googleapis.com','cloudfunctions.googleapis.com'
+ "A String",
+ ],
"serviceAccountConfig": { # Describes the service account configuration for the tenant project. # Configuration for the IAM service account on the tenant project.
"accountId": "A String", # ID of the IAM service account to be created in tenant project.
# The email format of the service account is
@@ -278,11 +280,10 @@
"A String",
],
},
- "folder": "A String", # Folder where project in this tenancy unit must be located
- # This folder must have been previously created with the required
- # permissions for the caller to create and configure a project in it.
- # Valid folder resource names have the format `folders/{folder_number}`
- # (for example, `folders/123456`).
+ "billingConfig": { # Describes the billing configuration for a new tenant project. # Billing account properties. The billing account must be specified.
+ "billingAccount": "A String", # Name of the billing account.
+ # For example `billingAccounts/012345-567890-ABCDEF`.
+ },
"tenantProjectPolicy": { # Describes policy settings that need to be applied to a newly # Describes ownership and policies for the new tenant project. Required.
# created tenant project.
"policyBindings": [ # Policy bindings to be applied to the tenant project, in addition to the
@@ -292,27 +293,26 @@
# members for `roles/owner`, at least one of them must be either the `user`
# or `group` type.
{ # Translates to IAM Policy bindings (without auditing at this level)
+ "role": "A String", # Role. (https://cloud.google.com/iam/docs/understanding-roles)
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"members": [ # Uses the same format as in IAM policy.
# `member` must include both a prefix and ID. For example, `user:{emailId}`,
# `serviceAccount:{emailId}`, `group:{emailId}`.
"A String",
],
- "role": "A String", # Role. (https://cloud.google.com/iam/docs/understanding-roles)
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
},
- "services": [ # Google Cloud API names of services that are activated on this project
- # during provisioning. If any of these services can't be activated,
- # the request fails.
- # For example: 'compute.googleapis.com','cloudfunctions.googleapis.com'
- "A String",
- ],
- "billingConfig": { # Describes the billing configuration for a new tenant project. # Billing account properties. The billing account must be specified.
- "billingAccount": "A String", # Name of the billing account.
- # For example `billingAccounts/012345-567890-ABCDEF`.
+ "folder": "A String", # Folder where project in this tenancy unit must be located
+ # This folder must have been previously created with the required
+ # permissions for the caller to create and configure a project in it.
+ # Valid folder resource names have the format `folders/{folder_number}`
+ # (for example, `folders/123456`).
+ "labels": { # Labels that are applied to this project.
+ "a_key": "A String",
},
},
+ "tag": "A String", # Tag of the project. Must be less than 128 characters. Required.
}
x__xgafv: string, V1 error format.
@@ -325,6 +325,27 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
@@ -344,27 +365,6 @@
"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.
- },
- ],
- "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.
- },
- "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>
@@ -390,14 +390,14 @@
{ # Request to attach an existing project to the tenancy unit as a new tenant
# resource.
+ "externalResource": "A String", # When attaching an external project, this is in the format of
+ # `projects/{project_number}`.
"reservedResource": "A String", # When attaching a reserved project already in tenancy units, this is the
# tag of a tenant resource under the tenancy unit for the managed service's
# service producer project. The reserved tenant resource must be in an
# active state.
"tag": "A String", # Tag of the tenant resource after attachment.
# Must be less than 128 characters. Required.
- "externalResource": "A String", # When attaching an external project, this is in the format of
- # `projects/{project_number}`.
}
x__xgafv: string, V1 error format.
@@ -410,6 +410,27 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
@@ -429,27 +450,6 @@
"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.
- },
- ],
- "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.
- },
- "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>
@@ -501,14 +501,14 @@
# For example 'projects/123456'.
},
],
+ "createTime": "A String", # @OutputOnly The time this tenancy unit was created.
+ "consumer": "A String", # @OutputOnly Cloud resource name of the consumer of this service.
+ # For example 'projects/123456'.
"name": "A String", # Globally unique identifier of this tenancy unit
# "services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}"
- "createTime": "A String", # @OutputOnly The time this tenancy unit was created.
"service": "A String", # Output only. Google Cloud API name of the managed service owning this
# tenancy unit.
# For example 'serviceconsumermanagement.googleapis.com'.
- "consumer": "A String", # @OutputOnly Cloud resource name of the consumer of this service.
- # For example 'projects/123456'.
}</pre>
</div>
@@ -530,6 +530,27 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
@@ -549,27 +570,6 @@
"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.
- },
- ],
- "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.
- },
- "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>
@@ -606,6 +606,27 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
@@ -625,32 +646,11 @@
"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.
- },
- ],
- "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.
- },
- "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>
<div class="method">
- <code class="details" id="list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
<pre>Find the tenancy unit for a managed service and service consumer.
This method shouldn't be used in a service producer's runtime path, for
example to find the tenant project number when creating VMs. Service
@@ -664,11 +664,11 @@
service consumer, for example 'projects', or 'organizations'.
{resource id} is the consumer numeric id, such as project number: '123456'.
{service} the name of a service, such as 'service.googleapis.com'. (required)
+ pageSize: integer, The maximum number of results returned by this request.
filter: string, Filter expression over tenancy resources field. Optional.
pageToken: string, The continuation token, which is used to page through large result sets.
To get the next page of results, set this parameter to the value of
`nextPageToken` from the previous response.
- pageSize: integer, The maximum number of results returned by this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -678,6 +678,7 @@
An object of the form:
{ # Response for the list request.
+ "nextPageToken": "A String", # Pagination token for large results.
"tenancyUnits": [ # Tenancy units matching the request.
{ # Representation of a tenancy unit.
"tenantResources": [ # Resources constituting the tenancy unit.
@@ -690,17 +691,16 @@
# For example 'projects/123456'.
},
],
+ "createTime": "A String", # @OutputOnly The time this tenancy unit was created.
+ "consumer": "A String", # @OutputOnly Cloud resource name of the consumer of this service.
+ # For example 'projects/123456'.
"name": "A String", # Globally unique identifier of this tenancy unit
# "services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}"
- "createTime": "A String", # @OutputOnly The time this tenancy unit was created.
"service": "A String", # Output only. Google Cloud API name of the managed service owning this
# tenancy unit.
# For example 'serviceconsumermanagement.googleapis.com'.
- "consumer": "A String", # @OutputOnly Cloud resource name of the consumer of this service.
- # For example 'projects/123456'.
},
],
- "nextPageToken": "A String", # Pagination token for large results.
}</pre>
</div>
@@ -749,6 +749,27 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
@@ -768,27 +789,6 @@
"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.
- },
- ],
- "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.
- },
- "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>
@@ -823,6 +823,27 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
@@ -842,27 +863,6 @@
"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.
- },
- ],
- "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.
- },
- "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>