docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/deploymentmanager_alpha.deployments.html b/docs/dyn/deploymentmanager_alpha.deployments.html
index 04a9fe6..141f0ae 100644
--- a/docs/dyn/deploymentmanager_alpha.deployments.html
+++ b/docs/dyn/deploymentmanager_alpha.deployments.html
@@ -84,20 +84,20 @@
<code><a href="#get">get(project, deployment)</a></code></p>
<p class="firstline">Gets information about a specific deployment.</p>
<p class="toc_element">
- <code><a href="#getIamPolicy">getIamPolicy(project, resource)</a></code></p>
+ <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body=None, createPolicy=None, preview=None)</a></code></p>
<p class="firstline">Creates a deployment and all of the resources described by the deployment manifest.</p>
<p class="toc_element">
- <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>
+ <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
<p class="firstline">Lists all deployments for a given project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None)</a></code></p>
-<p class="firstline">Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.</p>
+<p class="firstline">Patches a deployment and all of the resources described by the deployment manifest.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
@@ -122,16 +122,29 @@
The object takes the form of:
{
- "fingerprint": "A String", # Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests).
+ "fingerprint": "A String", # Specifies a fingerprint for `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided in `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests).
#
- # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a `get()` request on the deployment.
}
Returns:
An object of the form:
- { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the `globalOperations` resource.
+ # - For regional operations, use the `regionOperations` resource.
+ # - For zonal operations, use the `zonalOperations` resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
@@ -145,22 +158,23 @@
},
],
},
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
@@ -174,7 +188,7 @@
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
}</pre>
</div>
@@ -193,7 +207,20 @@
Returns:
An object of the form:
- { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the `globalOperations` resource.
+ # - For regional operations, use the `regionOperations` resource.
+ # - For zonal operations, use the `zonalOperations` resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
@@ -207,22 +234,23 @@
},
],
},
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
@@ -236,7 +264,7 @@
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
}</pre>
</div>
@@ -263,20 +291,33 @@
"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
"description": "A String", # An optional user-provided description of the deployment.
- "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
+ "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
#
- # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.
"id": "A String",
"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
- "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
{
"key": "A String",
"value": "A String",
},
],
- "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed.
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this deployment.
+ "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "operation": { # Represents an Operation resource. # Output only. The Operation that most recently ran, or is currently running, on this deployment.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the `globalOperations` resource.
+ # - For regional operations, use the `regionOperations` resource.
+ # - For zonal operations, use the `zonalOperations` resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
@@ -290,22 +331,23 @@
},
],
},
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
@@ -319,12 +361,12 @@
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
},
- "outputs": [ # Output only. Map of outputs from the last manifest that deployed successfully.
- {
- "key": "A String",
- "value": "A String",
+ "outputs": [ # Output only. List of outputs from the last manifest that deployed successfully.
+ { # Output object for Deployments
+ "key": "A String", # Key of the output
+ "value": "A String", # Value of the label
},
],
"selfLink": "A String", # Output only. Server defined URL for the resource.
@@ -351,7 +393,7 @@
"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
- "labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
+ "labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
{
"key": "A String",
"value": "A String",
@@ -364,33 +406,34 @@
</div>
<div class="method">
- <code class="details" id="getIamPolicy">getIamPolicy(project, resource)</code>
+ <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None)</code>
<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Args:
project: string, Project ID for this request. (required)
resource: string, Name or id of the resource for this request. (required)
+ optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
#
#
#
- # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.
#
- # **JSON Example**
+ # For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
- # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ # **JSON example:**
#
- # **YAML Example**
+ # { "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.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 }
#
- # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer
+ # **YAML example:**
#
+ # bindings: - 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:eve@example.com role: roles/resourcemanager.organizationViewer 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
#
- #
- # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).
+ # 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.
#
@@ -398,18 +441,19 @@
#
# Example Policy with multiple AuditConfigs:
#
- # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] }
+ # { "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 fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
+ # 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:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] }
+ # { "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 foo@gmail.com from DATA_READ logging.
+ # 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",
],
+ "ignoreChildExemptions": True or False,
"logType": "A String", # The log type that this config enables.
},
],
@@ -419,17 +463,37 @@
"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.
},
],
- "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error.
+ "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`.
- "condition": { # Represents an expression text. Example: # Unimplemented. 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.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.
#
- # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
- "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ # If the condition evaluates to `true`, then this binding applies to the current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # 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.
- #
- # The application context of the containing message determines which well-known feature set of CEL is supported.
- "location": "A String", # An 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", # An 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.
+ "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.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
#
@@ -437,7 +501,7 @@
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
#
- # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` .
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
#
#
#
@@ -445,9 +509,15 @@
#
# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
#
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
#
#
- # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
@@ -455,7 +525,7 @@
],
"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 conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
#
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"iamOwned": True or False,
"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
{ # A rule to be applied in a Policy.
@@ -466,8 +536,7 @@
"op": "A String", # An operator to apply the subject with.
"svc": "A String", # Trusted attributes discharged by the service.
"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
- "value": "A String", # DEPRECATED. Use 'values' instead.
- "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "values": [ # The objects of the condition.
"A String",
],
},
@@ -492,16 +561,18 @@
#
# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.
#
- # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]}
- #
- # At this time we do not support multiple field names (though this may be supported in the future).
+ # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}
+ "customFields": [ # Custom fields.
+ { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
+ "name": "A String", # Name is the field name.
+ "value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
+ },
+ ],
"field": "A String", # The field value to attribute.
"metric": "A String", # The metric to update.
},
"dataAccess": { # Write a Data Access (Gin) log # Data access options.
- "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now.
- #
- # NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152).
+ "logMode": "A String",
},
},
],
@@ -513,7 +584,19 @@
],
},
],
- "version": 42, # Deprecated.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
@@ -538,20 +621,33 @@
"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
"description": "A String", # An optional user-provided description of the deployment.
- "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
+ "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
#
- # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.
"id": "A String",
"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
- "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
{
"key": "A String",
"value": "A String",
},
],
- "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed.
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this deployment.
+ "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "operation": { # Represents an Operation resource. # Output only. The Operation that most recently ran, or is currently running, on this deployment.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the `globalOperations` resource.
+ # - For regional operations, use the `regionOperations` resource.
+ # - For zonal operations, use the `zonalOperations` resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
@@ -565,22 +661,23 @@
},
],
},
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
@@ -594,12 +691,12 @@
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
},
- "outputs": [ # Output only. Map of outputs from the last manifest that deployed successfully.
- {
- "key": "A String",
- "value": "A String",
+ "outputs": [ # Output only. List of outputs from the last manifest that deployed successfully.
+ { # Output object for Deployments
+ "key": "A String", # Key of the output
+ "value": "A String", # Value of the label
},
],
"selfLink": "A String", # Output only. Server defined URL for the resource.
@@ -626,7 +723,7 @@
"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
- "labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
+ "labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
{
"key": "A String",
"value": "A String",
@@ -642,12 +739,25 @@
ACQUIRE -
CREATE -
CREATE_OR_ACQUIRE -
- preview: boolean, If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
+ preview: boolean, If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the `update()` method or you can use the `cancelPreview()` method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
Returns:
An object of the form:
- { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the `globalOperations` resource.
+ # - For regional operations, use the `regionOperations` resource.
+ # - For zonal operations, use the `zonalOperations` resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
@@ -661,22 +771,23 @@
},
],
},
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
@@ -690,30 +801,31 @@
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>
+ <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
<pre>Lists all deployments for a given project.
Args:
project: string, The project ID for this request. (required)
- filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
+ filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
-For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
+For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
-You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
+You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
-To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
- maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
+To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
+ maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
-You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
-Currently, only sorting by name or creationTimestamp desc is supported.
- pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+ pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+ returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Returns:
An object of the form:
@@ -732,20 +844,33 @@
"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
"description": "A String", # An optional user-provided description of the deployment.
- "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
+ "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
#
- # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.
"id": "A String",
"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
- "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
{
"key": "A String",
"value": "A String",
},
],
- "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed.
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this deployment.
+ "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "operation": { # Represents an Operation resource. # Output only. The Operation that most recently ran, or is currently running, on this deployment.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the `globalOperations` resource.
+ # - For regional operations, use the `regionOperations` resource.
+ # - For zonal operations, use the `zonalOperations` resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
@@ -759,22 +884,23 @@
},
],
},
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
@@ -788,12 +914,12 @@
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
},
- "outputs": [ # Output only. Map of outputs from the last manifest that deployed successfully.
- {
- "key": "A String",
- "value": "A String",
+ "outputs": [ # Output only. List of outputs from the last manifest that deployed successfully.
+ { # Output object for Deployments
+ "key": "A String", # Key of the output
+ "value": "A String", # Value of the label
},
],
"selfLink": "A String", # Output only. Server defined URL for the resource.
@@ -820,7 +946,7 @@
"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
- "labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
+ "labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
{
"key": "A String",
"value": "A String",
@@ -851,7 +977,7 @@
<div class="method">
<code class="details" id="patch">patch(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None)</code>
- <pre>Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.
+ <pre>Patches a deployment and all of the resources described by the deployment manifest.
Args:
project: string, The project ID for this request. (required)
@@ -871,20 +997,33 @@
"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
"description": "A String", # An optional user-provided description of the deployment.
- "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
+ "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
#
- # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.
"id": "A String",
"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
- "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
{
"key": "A String",
"value": "A String",
},
],
- "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed.
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this deployment.
+ "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "operation": { # Represents an Operation resource. # Output only. The Operation that most recently ran, or is currently running, on this deployment.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the `globalOperations` resource.
+ # - For regional operations, use the `regionOperations` resource.
+ # - For zonal operations, use the `zonalOperations` resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
@@ -898,22 +1037,23 @@
},
],
},
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
@@ -927,12 +1067,12 @@
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
},
- "outputs": [ # Output only. Map of outputs from the last manifest that deployed successfully.
- {
- "key": "A String",
- "value": "A String",
+ "outputs": [ # Output only. List of outputs from the last manifest that deployed successfully.
+ { # Output object for Deployments
+ "key": "A String", # Key of the output
+ "value": "A String", # Value of the label
},
],
"selfLink": "A String", # Output only. Server defined URL for the resource.
@@ -959,7 +1099,7 @@
"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
- "labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
+ "labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
{
"key": "A String",
"value": "A String",
@@ -979,12 +1119,25 @@
Allowed values
ABANDON -
DELETE -
- preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
+ preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a `target.config` with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the `update()` or you can `cancelPreview()` to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
Returns:
An object of the form:
- { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the `globalOperations` resource.
+ # - For regional operations, use the `regionOperations` resource.
+ # - For zonal operations, use the `zonalOperations` resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
@@ -998,22 +1151,23 @@
},
],
},
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
@@ -1027,7 +1181,7 @@
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
}</pre>
</div>
@@ -1044,15 +1198,35 @@
{
"bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.
{ # Associates `members` with a `role`.
- "condition": { # Represents an expression text. Example: # Unimplemented. 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.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.
#
- # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
- "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ # If the condition evaluates to `true`, then this binding applies to the current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # 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.
- #
- # The application context of the containing message determines which well-known feature set of CEL is supported.
- "location": "A String", # An 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", # An 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.
+ "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.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
#
@@ -1060,7 +1234,7 @@
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
#
- # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` .
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
#
#
#
@@ -1068,32 +1242,38 @@
#
# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
#
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
#
#
- # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.
- "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.
#
#
#
- # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.
#
- # **JSON Example**
+ # For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
- # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ # **JSON example:**
#
- # **YAML Example**
+ # { "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.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 }
#
- # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer
+ # **YAML example:**
#
+ # bindings: - 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:eve@example.com role: roles/resourcemanager.organizationViewer 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
#
- #
- # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).
+ # 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.
#
@@ -1101,18 +1281,19 @@
#
# Example Policy with multiple AuditConfigs:
#
- # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] }
+ # { "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 fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
+ # 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:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] }
+ # { "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 foo@gmail.com from DATA_READ logging.
+ # 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",
],
+ "ignoreChildExemptions": True or False,
"logType": "A String", # The log type that this config enables.
},
],
@@ -1122,17 +1303,37 @@
"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.
},
],
- "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error.
+ "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`.
- "condition": { # Represents an expression text. Example: # Unimplemented. 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.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.
#
- # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
- "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ # If the condition evaluates to `true`, then this binding applies to the current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # 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.
- #
- # The application context of the containing message determines which well-known feature set of CEL is supported.
- "location": "A String", # An 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", # An 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.
+ "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.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
#
@@ -1140,7 +1341,7 @@
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
#
- # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` .
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
#
#
#
@@ -1148,9 +1349,15 @@
#
# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
#
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
#
#
- # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
@@ -1158,7 +1365,7 @@
],
"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 conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
#
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"iamOwned": True or False,
"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
{ # A rule to be applied in a Policy.
@@ -1169,8 +1376,7 @@
"op": "A String", # An operator to apply the subject with.
"svc": "A String", # Trusted attributes discharged by the service.
"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
- "value": "A String", # DEPRECATED. Use 'values' instead.
- "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "values": [ # The objects of the condition.
"A String",
],
},
@@ -1195,16 +1401,18 @@
#
# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.
#
- # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]}
- #
- # At this time we do not support multiple field names (though this may be supported in the future).
+ # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}
+ "customFields": [ # Custom fields.
+ { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
+ "name": "A String", # Name is the field name.
+ "value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
+ },
+ ],
"field": "A String", # The field value to attribute.
"metric": "A String", # The metric to update.
},
"dataAccess": { # Write a Data Access (Gin) log # Data access options.
- "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now.
- #
- # NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152).
+ "logMode": "A String",
},
},
],
@@ -1216,7 +1424,19 @@
],
},
],
- "version": 42, # Deprecated.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
@@ -1224,23 +1444,23 @@
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
#
#
#
- # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.
#
- # **JSON Example**
+ # For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
- # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
+ # **JSON example:**
#
- # **YAML Example**
+ # { "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.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 }
#
- # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer
+ # **YAML example:**
#
+ # bindings: - 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:eve@example.com role: roles/resourcemanager.organizationViewer 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
#
- #
- # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).
+ # 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.
#
@@ -1248,18 +1468,19 @@
#
# Example Policy with multiple AuditConfigs:
#
- # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] }
+ # { "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 fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
+ # 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:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] }
+ # { "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 foo@gmail.com from DATA_READ logging.
+ # 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",
],
+ "ignoreChildExemptions": True or False,
"logType": "A String", # The log type that this config enables.
},
],
@@ -1269,17 +1490,37 @@
"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.
},
],
- "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error.
+ "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`.
- "condition": { # Represents an expression text. Example: # Unimplemented. 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.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.
#
- # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
- "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ # If the condition evaluates to `true`, then this binding applies to the current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # 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.
- #
- # The application context of the containing message determines which well-known feature set of CEL is supported.
- "location": "A String", # An 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", # An 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.
+ "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.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
#
@@ -1287,7 +1528,7 @@
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
#
- # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` .
+ # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
#
#
#
@@ -1295,9 +1536,15 @@
#
# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
#
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
#
#
- # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
@@ -1305,7 +1552,7 @@
],
"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 conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
#
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
+ # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"iamOwned": True or False,
"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
{ # A rule to be applied in a Policy.
@@ -1316,8 +1563,7 @@
"op": "A String", # An operator to apply the subject with.
"svc": "A String", # Trusted attributes discharged by the service.
"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
- "value": "A String", # DEPRECATED. Use 'values' instead.
- "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "values": [ # The objects of the condition.
"A String",
],
},
@@ -1342,16 +1588,18 @@
#
# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.
#
- # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]}
- #
- # At this time we do not support multiple field names (though this may be supported in the future).
+ # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}
+ "customFields": [ # Custom fields.
+ { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
+ "name": "A String", # Name is the field name.
+ "value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
+ },
+ ],
"field": "A String", # The field value to attribute.
"metric": "A String", # The metric to update.
},
"dataAccess": { # Write a Data Access (Gin) log # Data access options.
- "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now.
- #
- # NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152).
+ "logMode": "A String",
},
},
],
@@ -1363,7 +1611,19 @@
],
},
],
- "version": 42, # Deprecated.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
@@ -1378,16 +1638,29 @@
The object takes the form of:
{
- "fingerprint": "A String", # Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision).
+ "fingerprint": "A String", # Specifies a fingerprint for `stop()` requests. A fingerprint is a randomly generated value that must be provided in `stop()` requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision).
#
- # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a `get()` request on the deployment.
}
Returns:
An object of the form:
- { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the `globalOperations` resource.
+ # - For regional operations, use the `regionOperations` resource.
+ # - For zonal operations, use the `zonalOperations` resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
@@ -1401,22 +1674,23 @@
},
],
},
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
@@ -1430,7 +1704,7 @@
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
}</pre>
</div>
@@ -1483,20 +1757,33 @@
"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
"description": "A String", # An optional user-provided description of the deployment.
- "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
+ "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
#
- # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.
"id": "A String",
"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
- "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
{
"key": "A String",
"value": "A String",
},
],
- "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed.
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this deployment.
+ "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.
+ "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+ "operation": { # Represents an Operation resource. # Output only. The Operation that most recently ran, or is currently running, on this deployment.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the `globalOperations` resource.
+ # - For regional operations, use the `regionOperations` resource.
+ # - For zonal operations, use the `zonalOperations` resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
@@ -1510,22 +1797,23 @@
},
],
},
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
@@ -1539,12 +1827,12 @@
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
},
- "outputs": [ # Output only. Map of outputs from the last manifest that deployed successfully.
- {
- "key": "A String",
- "value": "A String",
+ "outputs": [ # Output only. List of outputs from the last manifest that deployed successfully.
+ { # Output object for Deployments
+ "key": "A String", # Key of the output
+ "value": "A String", # Value of the label
},
],
"selfLink": "A String", # Output only. Server defined URL for the resource.
@@ -1571,7 +1859,7 @@
"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
- "labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
+ "labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
{
"key": "A String",
"value": "A String",
@@ -1591,12 +1879,25 @@
Allowed values
ABANDON -
DELETE -
- preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
+ preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a `target.config` with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the `update()` or you can `cancelPreview()` to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
Returns:
An object of the form:
- { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the `globalOperations` resource.
+ # - For regional operations, use the `regionOperations` resource.
+ # - For zonal operations, use the `zonalOperations` resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
@@ -1610,22 +1911,23 @@
},
],
},
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
@@ -1639,7 +1941,7 @@
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
}</pre>
</div>