docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/deploymentmanager_v2.deployments.html b/docs/dyn/deploymentmanager_v2.deployments.html
index c6c2419..c3b6cf3 100644
--- a/docs/dyn/deploymentmanager_v2.deployments.html
+++ b/docs/dyn/deploymentmanager_v2.deployments.html
@@ -78,6 +78,9 @@
<code><a href="#cancelPreview">cancelPreview(project, deployment, body=None)</a></code></p>
<p class="firstline">Cancels and removes the preview currently associated with the deployment.</p>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#delete">delete(project, deployment, deletePolicy=None)</a></code></p>
<p class="firstline">Deletes a deployment and all of the resources in the deployment.</p>
<p class="toc_element">
@@ -87,16 +90,16 @@
<code><a href="#getIamPolicy">getIamPolicy(project, resource)</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>
+ <code><a href="#insert">insert(project, body=None, preview=None, createPolicy=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, orderBy=None, maxResults=None, filter=None, pageToken=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>
+ <code><a href="#patch">patch(project, deployment, body=None, deletePolicy=None, preview=None, createPolicy=None)</a></code></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>
@@ -108,7 +111,7 @@
<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
<p class="toc_element">
- <code><a href="#update">update(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None)</a></code></p>
+ <code><a href="#update">update(project, deployment, body=None, deletePolicy=None, createPolicy=None, preview=None)</a></code></p>
<p class="firstline">Updates a deployment and all of the resources described by the deployment manifest.</p>
<h3>Method Details</h3>
<div class="method">
@@ -145,53 +148,58 @@
# - 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 ==)
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"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.
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "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.
+ },
+ ],
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "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.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "name": "A String", # [Output Only] Name of the operation.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
- "code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "code": "A String", # [Output Only] The error type identifier for this error.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
- "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 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 applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "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`.
- "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`.
- "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.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "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 applicable when performing per-zone operations.
+ "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.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
}</pre>
</div>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="delete">delete(project, deployment, deletePolicy=None)</code>
<pre>Deletes a deployment and all of the resources in the deployment.
@@ -220,49 +228,49 @@
# - 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 ==)
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"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.
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "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.
+ },
+ ],
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "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.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "name": "A String", # [Output Only] Name of the operation.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
- "code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "code": "A String", # [Output Only] The error type identifier for this error.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
- "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 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 applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "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`.
- "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`.
- "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.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "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 applicable when performing per-zone operations.
+ "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.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
}</pre>
</div>
@@ -278,20 +286,26 @@
An object of the form:
{
- "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.
- #
- # 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])?)?`.
{
"key": "A String",
"value": "A String",
},
],
- "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.
+ "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
+ "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
+ "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
+ "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
+ {
+ "name": "A String", # The name of the file.
+ "content": "A String", # The contents of the file.
+ },
+ ],
+ "config": { # The configuration to use for this deployment.
+ "content": "A String", # The contents of the file.
+ },
+ },
+ "id": "A String",
"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:
@@ -306,73 +320,67 @@
# - 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 ==)
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"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.
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "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.
+ },
+ ],
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "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.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "name": "A String", # [Output Only] Name of the operation.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
- "code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "code": "A String", # [Output Only] The error type identifier for this error.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
- "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 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 applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "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`.
- "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`.
- "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.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "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 applicable when performing per-zone operations.
+ "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.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
},
+ "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.
+ #
+ # 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.
+ "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.
"selfLink": "A String", # Output only. Server defined URL for the resource.
- "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
- "config": { # The configuration to use for this deployment.
- "content": "A String", # The contents of the file.
- },
- "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
- {
- "content": "A String", # The contents of the file.
- "name": "A String", # The name of the file.
- },
- ],
- },
+ "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.
"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
- "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
+ "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.
"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",
},
],
- "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.
+ "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
},
- "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
}</pre>
</div>
@@ -414,57 +422,28 @@
# { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "exemptedMembers": [
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example:
#
# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "logType": "A String", # The log type that this config enables.
+ "ignoreChildExemptions": True or False,
"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.
},
],
- "exemptedMembers": [
- "A String",
- ],
- "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.
},
],
+ "iamOwned": True or False,
"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 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.
- #
- # 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.
- "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:
#
# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
@@ -490,33 +469,68 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
+ "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.
+ #
+ # 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.
+ "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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "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.
+ },
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 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.
#
# **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.
- "action": "A String", # Required
- "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
- { # A condition to be met.
- "iam": "A String", # Trusted attributes supplied by the IAM system.
- "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.
- "values": [ # The objects of the condition.
- "A String",
- ],
- },
- ],
- "description": "A String", # Human-readable description of the rule.
"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
"A String",
],
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "description": "A String", # Human-readable description of the rule.
+ "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "values": [ # The objects of the condition.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ },
+ ],
"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
{ # Specifies what kind of log the caller must write
+ "dataAccess": { # Write a Data Access (Gin) log # Data access options.
+ "logMode": "A String",
+ },
"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
"permissionType": "A String", # The type of the permission that was checked.
@@ -532,26 +546,20 @@
# 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/debug_access_count {iam_principal=[value of IAMContext.principal]}
+ "metric": "A String", # The metric to update.
+ "field": "A String", # The field value to attribute.
"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",
},
},
],
"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
"A String",
],
- "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
- "A String",
- ],
},
],
"version": 42, # Specifies the format of the policy.
@@ -571,7 +579,7 @@
</div>
<div class="method">
- <code class="details" id="insert">insert(project, body=None, createPolicy=None, preview=None)</code>
+ <code class="details" id="insert">insert(project, body=None, preview=None, createPolicy=None)</code>
<pre>Creates a deployment and all of the resources described by the deployment manifest.
Args:
@@ -580,20 +588,26 @@
The object takes the form of:
{
- "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.
- #
- # 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])?)?`.
{
"key": "A String",
"value": "A String",
},
],
- "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.
+ "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
+ "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
+ "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
+ "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
+ {
+ "name": "A String", # The name of the file.
+ "content": "A String", # The contents of the file.
+ },
+ ],
+ "config": { # The configuration to use for this deployment.
+ "content": "A String", # The contents of the file.
+ },
+ },
+ "id": "A String",
"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:
@@ -608,80 +622,74 @@
# - 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 ==)
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"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.
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "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.
+ },
+ ],
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "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.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "name": "A String", # [Output Only] Name of the operation.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
- "code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "code": "A String", # [Output Only] The error type identifier for this error.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
- "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 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 applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "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`.
- "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`.
- "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.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "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 applicable when performing per-zone operations.
+ "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.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
},
+ "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.
+ #
+ # 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.
+ "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.
"selfLink": "A String", # Output only. Server defined URL for the resource.
- "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
- "config": { # The configuration to use for this deployment.
- "content": "A String", # The contents of the file.
- },
- "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
- {
- "content": "A String", # The contents of the file.
- "name": "A String", # The name of the file.
- },
- ],
- },
+ "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.
"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
- "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
+ "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.
"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",
},
],
- "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.
+ "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
},
- "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
}
+ 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.
createPolicy: string, Sets the policy to use for creating new resources.
Allowed values
ACQUIRE -
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.
Returns:
An object of the form:
@@ -700,58 +708,64 @@
# - 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 ==)
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"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.
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "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.
+ },
+ ],
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "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.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "name": "A String", # [Output Only] Name of the operation.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
- "code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "code": "A String", # [Output Only] The error type identifier for this error.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
- "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 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 applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "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`.
- "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`.
- "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.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "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 applicable when performing per-zone operations.
+ "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.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
}</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, orderBy=None, maxResults=None, filter=None, pageToken=None)</code>
<pre>Lists all deployments for a given project.
Args:
project: string, The project ID for this request. (required)
+ 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.
+
+Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+ 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`)
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`.
@@ -759,34 +773,35 @@
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`)
- 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.
-
-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.
Returns:
An object of the form:
{ # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.
+ "nextPageToken": "A String", # Output only. A token used to continue a truncated list request.
"deployments": [ # Output only. The deployments contained in this response.
{
- "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.
- #
- # 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])?)?`.
{
"key": "A String",
"value": "A String",
},
],
- "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.
+ "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
+ "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
+ "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
+ "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
+ {
+ "name": "A String", # The name of the file.
+ "content": "A String", # The contents of the file.
+ },
+ ],
+ "config": { # The configuration to use for this deployment.
+ "content": "A String", # The contents of the file.
+ },
+ },
+ "id": "A String",
"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:
@@ -801,76 +816,69 @@
# - 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 ==)
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"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.
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "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.
+ },
+ ],
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "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.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "name": "A String", # [Output Only] Name of the operation.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
- "code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "code": "A String", # [Output Only] The error type identifier for this error.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
- "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 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 applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "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`.
- "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`.
- "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.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "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 applicable when performing per-zone operations.
+ "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.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
},
+ "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.
+ #
+ # 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.
+ "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.
"selfLink": "A String", # Output only. Server defined URL for the resource.
- "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
- "config": { # The configuration to use for this deployment.
- "content": "A String", # The contents of the file.
- },
- "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
- {
- "content": "A String", # The contents of the file.
- "name": "A String", # The name of the file.
- },
- ],
- },
+ "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.
"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
- "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
+ "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.
"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",
},
],
- "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.
+ "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
},
- "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
},
],
- "nextPageToken": "A String", # Output only. A token used to continue a truncated list request.
}</pre>
</div>
@@ -889,7 +897,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None)</code>
+ <code class="details" id="patch">patch(project, deployment, body=None, deletePolicy=None, preview=None, createPolicy=None)</code>
<pre>Patches a deployment and all of the resources described by the deployment manifest.
Args:
@@ -899,20 +907,26 @@
The object takes the form of:
{
- "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.
- #
- # 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])?)?`.
{
"key": "A String",
"value": "A String",
},
],
- "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.
+ "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
+ "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
+ "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
+ "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
+ {
+ "name": "A String", # The name of the file.
+ "content": "A String", # The contents of the file.
+ },
+ ],
+ "config": { # The configuration to use for this deployment.
+ "content": "A String", # The contents of the file.
+ },
+ },
+ "id": "A String",
"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:
@@ -927,84 +941,78 @@
# - 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 ==)
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"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.
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "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.
+ },
+ ],
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "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.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "name": "A String", # [Output Only] Name of the operation.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
- "code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "code": "A String", # [Output Only] The error type identifier for this error.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
- "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 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 applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "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`.
- "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`.
- "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.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "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 applicable when performing per-zone operations.
+ "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.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
},
+ "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.
+ #
+ # 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.
+ "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.
"selfLink": "A String", # Output only. Server defined URL for the resource.
- "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
- "config": { # The configuration to use for this deployment.
- "content": "A String", # The contents of the file.
- },
- "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
- {
- "content": "A String", # The contents of the file.
- "name": "A String", # The name of the file.
- },
- ],
- },
+ "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.
"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
- "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
+ "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.
"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",
},
],
- "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.
+ "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
},
- "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
}
- createPolicy: string, Sets the policy to use for creating new resources.
- Allowed values
- ACQUIRE -
- CREATE_OR_ACQUIRE -
deletePolicy: string, Sets the policy to use for deleting resources.
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.
+ createPolicy: string, Sets the policy to use for creating new resources.
+ Allowed values
+ ACQUIRE -
+ CREATE_OR_ACQUIRE -
Returns:
An object of the form:
@@ -1023,49 +1031,49 @@
# - 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 ==)
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"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.
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "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.
+ },
+ ],
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "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.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "name": "A String", # [Output Only] Name of the operation.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
- "code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "code": "A String", # [Output Only] The error type identifier for this error.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
- "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 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 applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "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`.
- "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`.
- "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.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "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 applicable when performing per-zone operations.
+ "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.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
}</pre>
</div>
@@ -1082,36 +1090,6 @@
{
"bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.
{ # Associates `members` with a `role`.
- "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.
- #
- # 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.
- "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:
#
# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
@@ -1137,6 +1115,36 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
+ "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.
+ #
+ # 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.
+ "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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "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.
+ },
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
@@ -1168,57 +1176,28 @@
# { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "exemptedMembers": [
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example:
#
# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "logType": "A String", # The log type that this config enables.
+ "ignoreChildExemptions": True or False,
"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.
},
],
- "exemptedMembers": [
- "A String",
- ],
- "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.
},
],
+ "iamOwned": True or False,
"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 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.
- #
- # 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.
- "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:
#
# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
@@ -1244,33 +1223,68 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
+ "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.
+ #
+ # 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.
+ "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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "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.
+ },
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 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.
#
# **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.
- "action": "A String", # Required
- "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
- { # A condition to be met.
- "iam": "A String", # Trusted attributes supplied by the IAM system.
- "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.
- "values": [ # The objects of the condition.
- "A String",
- ],
- },
- ],
- "description": "A String", # Human-readable description of the rule.
"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
"A String",
],
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "description": "A String", # Human-readable description of the rule.
+ "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "values": [ # The objects of the condition.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ },
+ ],
"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
{ # Specifies what kind of log the caller must write
+ "dataAccess": { # Write a Data Access (Gin) log # Data access options.
+ "logMode": "A String",
+ },
"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
"permissionType": "A String", # The type of the permission that was checked.
@@ -1286,26 +1300,20 @@
# 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/debug_access_count {iam_principal=[value of IAMContext.principal]}
+ "metric": "A String", # The metric to update.
+ "field": "A String", # The field value to attribute.
"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",
},
},
],
"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
"A String",
],
- "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
- "A String",
- ],
},
],
"version": 42, # Specifies the format of the policy.
@@ -1355,57 +1363,28 @@
# { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "exemptedMembers": [
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions. Example:
#
# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "logType": "A String", # The log type that this config enables.
+ "ignoreChildExemptions": True or False,
"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.
},
],
- "exemptedMembers": [
- "A String",
- ],
- "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.
},
],
+ "iamOwned": True or False,
"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 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.
- #
- # 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.
- "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:
#
# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
@@ -1431,33 +1410,68 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
"A String",
],
+ "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.
+ #
+ # 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.
+ "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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "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.
+ },
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help 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.
#
# **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.
- "action": "A String", # Required
- "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
- { # A condition to be met.
- "iam": "A String", # Trusted attributes supplied by the IAM system.
- "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.
- "values": [ # The objects of the condition.
- "A String",
- ],
- },
- ],
- "description": "A String", # Human-readable description of the rule.
"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
"A String",
],
+ "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "description": "A String", # Human-readable description of the rule.
+ "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "values": [ # The objects of the condition.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+ },
+ ],
"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
{ # Specifies what kind of log the caller must write
+ "dataAccess": { # Write a Data Access (Gin) log # Data access options.
+ "logMode": "A String",
+ },
"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
"permissionType": "A String", # The type of the permission that was checked.
@@ -1473,26 +1487,20 @@
# 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/debug_access_count {iam_principal=[value of IAMContext.principal]}
+ "metric": "A String", # The metric to update.
+ "field": "A String", # The field value to attribute.
"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",
},
},
],
"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
"A String",
],
- "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
- "A String",
- ],
},
],
"version": 42, # Specifies the format of the policy.
@@ -1545,49 +1553,49 @@
# - 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 ==)
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"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.
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "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.
+ },
+ ],
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "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.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "name": "A String", # [Output Only] Name of the operation.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
- "code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "code": "A String", # [Output Only] The error type identifier for this error.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
- "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 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 applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "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`.
- "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`.
- "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.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "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 applicable when performing per-zone operations.
+ "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.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
}</pre>
</div>
@@ -1619,7 +1627,7 @@
</div>
<div class="method">
- <code class="details" id="update">update(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None)</code>
+ <code class="details" id="update">update(project, deployment, body=None, deletePolicy=None, createPolicy=None, preview=None)</code>
<pre>Updates a deployment and all of the resources described by the deployment manifest.
Args:
@@ -1629,20 +1637,26 @@
The object takes the form of:
{
- "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.
- #
- # 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])?)?`.
{
"key": "A String",
"value": "A String",
},
],
- "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.
+ "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
+ "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
+ "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
+ "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
+ {
+ "name": "A String", # The name of the file.
+ "content": "A String", # The contents of the file.
+ },
+ ],
+ "config": { # The configuration to use for this deployment.
+ "content": "A String", # The contents of the file.
+ },
+ },
+ "id": "A String",
"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:
@@ -1657,83 +1671,77 @@
# - 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 ==)
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"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.
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "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.
+ },
+ ],
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "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.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "name": "A String", # [Output Only] Name of the operation.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
- "code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "code": "A String", # [Output Only] The error type identifier for this error.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
- "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 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 applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "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`.
- "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`.
- "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.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "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 applicable when performing per-zone operations.
+ "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.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
},
+ "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.
+ #
+ # 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.
+ "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.
"selfLink": "A String", # Output only. Server defined URL for the resource.
- "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
- "config": { # The configuration to use for this deployment.
- "content": "A String", # The contents of the file.
- },
- "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
- {
- "content": "A String", # The contents of the file.
- "name": "A String", # The name of the file.
- },
- ],
- },
+ "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.
"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
- "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
+ "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.
"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",
},
],
- "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.
+ "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.
},
- "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
}
- createPolicy: string, Sets the policy to use for creating new resources.
- Allowed values
- ACQUIRE -
- CREATE_OR_ACQUIRE -
deletePolicy: string, Sets the policy to use for deleting resources.
Allowed values
ABANDON -
DELETE -
+ createPolicy: string, Sets the policy to use for creating new resources.
+ Allowed values
+ ACQUIRE -
+ CREATE_OR_ACQUIRE -
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:
@@ -1753,49 +1761,49 @@
# - 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 ==)
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"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.
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "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.
+ },
+ ],
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "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.
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "name": "A String", # [Output Only] Name of the operation.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
- "code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "code": "A String", # [Output Only] The error type identifier for this error.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
- "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 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 applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "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`.
- "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`.
- "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.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "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 applicable when performing per-zone operations.
+ "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.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
}</pre>
</div>