| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionDisks.html">regionDisks</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#addResourcePolicies">addResourcePolicies(project, region, disk, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Adds existing resource policies to a regional disk. You can only add one</p> |
| <p class="toc_element"> |
| <code><a href="#bulkInsert">bulkInsert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Bulk create a set of disks.</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="#createSnapshot">createSnapshot(project, region, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a snapshot of a specified persistent disk. For regular snapshot</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(project, region, disk, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the specified regional persistent disk. Deleting a regional disk</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(project, region, disk, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns a specified regional persistent disk.</p> |
| <p class="toc_element"> |
| <code><a href="#getAsyncReplicationStatus">getAsyncReplicationStatus(project, region, disk, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the status of current async replication for a given device.</p> |
| <p class="toc_element"> |
| <code><a href="#getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(project, region, body=None, requestId=None, sourceImage=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a persistent regional disk in the specified project using the data</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves the list of persistent disks contained within</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#removeResourcePolicies">removeResourcePolicies(project, region, disk, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Removes resource policies from a regional disk.</p> |
| <p class="toc_element"> |
| <code><a href="#resize">resize(project, region, disk, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Resizes the specified regional persistent disk.</p> |
| <p class="toc_element"> |
| <code><a href="#setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Sets the access control policy on the specified resource.</p> |
| <p class="toc_element"> |
| <code><a href="#setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Sets the labels on the target regional disk.</p> |
| <p class="toc_element"> |
| <code><a href="#startAsyncReplication">startAsyncReplication(project, region, disk, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Starts asynchronous replication.</p> |
| <p class="toc_element"> |
| <code><a href="#stopAsyncReplication">stopAsyncReplication(project, region, disk, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Stops asynchronous replication.</p> |
| <p class="toc_element"> |
| <code><a href="#stopGroupAsyncReplication">stopGroupAsyncReplication(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Stops asynchronous replication for a consistency group of disks.</p> |
| <p class="toc_element"> |
| <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=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, region, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update the specified disk with the data included in the request. Update is</p> |
| <p class="toc_element"> |
| <code><a href="#updateKmsKey">updateKmsKey(project, region, disk, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Rotates the customer-managed</p> |
| <p class="toc_element"> |
| <code><a href="#waitForReplicationCatchUp">waitForReplicationCatchUp(project, region, disk, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Wait for replication to catch up on the secondary disk.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="addResourcePolicies">addResourcePolicies(project, region, disk, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Adds existing resource policies to a regional disk. You can only add one |
| policy which will be applied to this disk for scheduling snapshot |
| creation. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the region for this request. (required) |
| disk: string, The disk name for this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "resourcePolicies": [ # Resource policies to be added to this disk. |
| "A String", |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="bulkInsert">bulkInsert(project, region, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Bulk create a set of disks. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the region for this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A transient resource used in compute.disks.bulkInsert and |
| # compute.regionDisks.bulkInsert. It is only used to process |
| # requests and is not persisted. |
| "instantSnapshotGroupParameters": { # The parameters for the instant snapshot group. |
| "sourceInstantSnapshotGroup": "A String", # The source instant snapshot group used to create disks. You can provide |
| # this as a partial or full URL to the resource. For example, the following |
| # are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup |
| # - projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup |
| # - zones/zone/instantSnapshotGroups/instantSnapshotGroup |
| }, |
| "snapshotGroupParameters": { # The parameters for the snapshot group. |
| "replicaZones": [ # URLs of the zones where disks should be replicated to. Only applicable |
| # for regional resources. |
| "A String", |
| ], |
| "sourceSnapshotGroup": "A String", # The source snapshot group used to create disks. You can provide this as a |
| # partial or full URL to the resource. For example, the following are valid |
| # values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/global/snapshotGroups/snapshotGroup |
| # - projects/project/global/snapshotGroups/snapshotGroup |
| # - global/snapshotGroups/snapshotGroup |
| "type": "A String", # URL of the disk type resource describing which disk type to use to create |
| # disks. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk |
| # types. |
| }, |
| "sourceConsistencyGroupPolicy": "A String", # The URL of the DiskConsistencyGroupPolicy for the group of disks to clone. |
| # This may be a full or partial URL, such as: |
| # |
| # |
| # - |
| # https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy |
| # |
| # - |
| # projects/project/regions/region/resourcePolicies/resourcePolicy |
| # |
| # - |
| # regions/region/resourcePolicies/resourcePolicy |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</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="createSnapshot">createSnapshot(project, region, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None)</code> |
| <pre>Creates a snapshot of a specified persistent disk. For regular snapshot |
| creation, consider using snapshots.insert |
| instead, as that method supports more features, such as creating snapshots |
| in a project different from the source disk project. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| disk: string, Name of the regional persistent disk to snapshot. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a Persistent Disk Snapshot resource. |
| # |
| # You can use snapshots to back up data on a regular interval. For more |
| # information, read Creating |
| # persistent disk snapshots. |
| "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are |
| # ARM64 or X86_64. |
| "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by |
| # applying resource policy on the target disk. |
| "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the |
| # specified name. The chain name must be 1-63 characters long and comply |
| # with RFC1035. This is an uncommon option only for advanced service |
| # owners who needs to create separate snapshot chains, for example, |
| # for chargeback tracking. When you describe your snapshot resource, this |
| # field is visible only if it has a non-empty value. |
| "creationSizeBytes": "A String", # [Output Only] Size in bytes of the snapshot at creation time. |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "description": "A String", # An optional description of this resource. Provide this property when you |
| # create the resource. |
| "diskSizeGb": "A String", # [Output Only] Size of the source disk, specified in GB. |
| "downloadBytes": "A String", # [Output Only] Number of bytes downloaded to restore a snapshot to a disk. |
| "enableConfidentialCompute": True or False, # Whether this snapshot is created from a confidential compute mode disk. |
| # [Output Only]: This field is not set by user, but from source disk. |
| "guestFlush": True or False, # [Input Only] Whether to attempt an application consistent snapshot by |
| # informing the OS to prepare for the snapshot process. |
| "guestOsFeatures": [ # [Output Only] A list of features to enable on the guest operating system. |
| # Applicable only for bootable images. Read |
| # Enabling guest operating system features to see a list of available |
| # options. |
| { # Guest OS features. |
| "type": "A String", # The ID of a supported feature. To add multiple values, use commas to |
| # separate values. Set to one or more of the following values: |
| # |
| # - VIRTIO_SCSI_MULTIQUEUE |
| # - WINDOWS |
| # - MULTI_IP_SUBNET |
| # - UEFI_COMPATIBLE |
| # - GVNIC |
| # - SEV_CAPABLE |
| # - SUSPEND_RESUME_COMPATIBLE |
| # - SEV_LIVE_MIGRATABLE_V2 |
| # - SEV_SNP_CAPABLE |
| # - TDX_CAPABLE |
| # - IDPF |
| # - SNP_SVSM_CAPABLE |
| # |
| # |
| # For more information, see |
| # Enabling guest operating system features. |
| }, |
| ], |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot |
| # for Snapshot resources. |
| "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is |
| # essentially a hash of the labels set used for optimistic locking. The |
| # fingerprint is initially generated by Compute Engine and changes after |
| # every request to modify or update labels. You must always provide an |
| # up-to-date fingerprint hash in order to update or change labels, |
| # otherwise the request will fail with error412 conditionNotMet. |
| # |
| # To see the latest fingerprint, make a get() request to |
| # retrieve a snapshot. |
| "labels": { # Labels to apply to this snapshot. These can be later modified by |
| # the setLabels method. |
| # Label values may be empty. |
| "a_key": "A String", |
| }, |
| "licenseCodes": [ # [Output Only] Integer license codes indicating which licenses are attached |
| # to this snapshot. |
| "A String", |
| ], |
| "licenses": [ # [Output Only] A list of public visible licenses that apply to this |
| # snapshot. This can be because the original image had licenses attached |
| # (such as a Windows image). |
| "A String", |
| ], |
| "locationHint": "A String", # An opaque location hint used to place the snapshot close to other |
| # resources. |
| # This field is for use by internal tools that use the public API. |
| "maxRetentionDays": 42, # Number of days the snapshot should be retained before being deleted |
| # automatically. |
| "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 withRFC1035. |
| # 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. |
| "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have |
| # the same definition as resource |
| # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and |
| # values are in the format `tagValues/456`. The field is ignored (both PUT & |
| # PATCH) when empty. |
| "a_key": "A String", |
| }, |
| }, |
| "region": "A String", # [Output Only] URL of the region where the snapshot resides. Only applicable |
| # for regional snapshots. |
| "resourceStatus": { # [Output only] ResourceStatus of the Snapshot resource |
| "scheduledDeletionTime": "A String", # [Output only] Scheduled deletion time of the snapshot. The snapshot will |
| # be deleted by the at any point within one hour after the deletion time. |
| }, |
| "satisfiesPzi": True or False, # Output only. Reserved for future use. |
| "satisfiesPzs": True or False, # [Output Only] Reserved for future use. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id. |
| "snapshotEncryptionKey": { # Encrypts the snapshot using acustomer-supplied |
| # encryption key. |
| # |
| # After you encrypt a snapshot using a customer-supplied key, you must |
| # provide the same key if you use the snapshot later. For example, you must |
| # provide the encryption key when you create a disk from the encrypted |
| # snapshot in a future request. |
| # |
| # Customer-supplied encryption keys do not protect access to metadata |
| # of the snapshot. |
| # |
| # If you do not provide an encryption key when creating the snapshot, then |
| # the snapshot will be encrypted using an automatically generated key and you |
| # do not need to provide a key to use the snapshot later. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "snapshotGroupId": "A String", # [Output Only] The unique ID of the snapshot group that this snapshot |
| # belongs to. |
| "snapshotGroupName": "A String", # [Output only] The snapshot group that this snapshot belongs to. |
| "snapshotType": "A String", # Indicates the type of the snapshot. |
| "sourceDisk": "A String", # The source disk used to create this snapshot. |
| "sourceDiskEncryptionKey": { # The customer-supplied |
| # encryption key of the source disk. Required if the source disk is |
| # protected by a customer-supplied encryption key. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceDiskForRecoveryCheckpoint": "A String", # The source disk whose recovery checkpoint will be used to create this |
| # snapshot. |
| "sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this snapshot. This |
| # value may be used to determine whether the snapshot was taken from the |
| # current or a previous instance of a given disk name. |
| "sourceInstantSnapshot": "A String", # The source instant snapshot used to create this snapshot. You can provide |
| # this as a partial or full URL to the resource. For example, the following |
| # are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot |
| # - projects/project/zones/zone/instantSnapshots/instantSnapshot |
| # - zones/zone/instantSnapshots/instantSnapshot |
| "sourceInstantSnapshotEncryptionKey": { # Customer provided encryption key when creating Snapshot from Instant |
| # Snapshot. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this |
| # snapshot. This value identifies the exact instant snapshot that was used to |
| # create this snapshot. For example, if you created the snapshot from an |
| # instant snapshot that was later deleted and recreated under the same name, |
| # the source instant snapshot ID would identify the exact instant snapshot |
| # that was used. |
| "sourceSnapshotSchedulePolicy": "A String", # [Output Only] URL of the resource policy which created this |
| # scheduled snapshot. |
| "sourceSnapshotSchedulePolicyId": "A String", # [Output Only] ID of the resource policy which created this |
| # scheduled snapshot. |
| "status": "A String", # [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING. |
| "storageBytes": "A String", # [Output Only] A size of the storage used by the snapshot. As snapshots |
| # share storage, this number is expected to change with snapshot |
| # creation/deletion. |
| "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a |
| # stable state or it is being adjusted as a result of shared storage |
| # reallocation. This status can either be UPDATING, meaning |
| # the size of the snapshot is being updated, or UP_TO_DATE, |
| # meaning the size of the snapshot is up-to-date. |
| "storageLocations": [ # Cloud Storage bucket storage location of the snapshot (regional or |
| # multi-regional). |
| "A String", |
| ], |
| "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of |
| # URLs to the license resource. |
| "A String", |
| ], |
| } |
| |
| guestFlush: boolean, [Input Only] Specifies to create an application consistent snapshot by |
| informing the OS to prepare for the snapshot process. |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(project, region, disk, requestId=None, x__xgafv=None)</code> |
| <pre>Deletes the specified regional persistent disk. Deleting a regional disk |
| removes all the replicas of its data permanently and is irreversible. |
| However, deleting a disk does not delete anysnapshots |
| previously made from the disk. You must separatelydelete |
| snapshots. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| disk: string, Name of the regional persistent disk to delete. (required) |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(project, region, disk, x__xgafv=None)</code> |
| <pre>Returns a specified regional persistent disk. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| disk: string, Name of the regional persistent disk to return. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a Persistent Disk resource. |
| # |
| # Google Compute Engine has two Disk resources: |
| # |
| # * [Zonal](/compute/docs/reference/rest/alpha/disks) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionDisks) |
| # |
| # Persistent disks are required for running your VM instances. |
| # Create both boot and non-boot (data) persistent disks. For more information, |
| # read Persistent Disks. For more |
| # storage options, read Storage options. |
| # |
| # The disks resource represents a zonal persistent disk. |
| # For more information, readZonal persistent disks. |
| # |
| # The regionDisks resource represents a |
| # regional persistent disk. For more information, read |
| # Regional resources. |
| "accessMode": "A String", # The access mode of the disk. |
| # |
| # |
| # - READ_WRITE_SINGLE: The default AccessMode, means the |
| # disk can be attached to single instance in RW mode. |
| # - READ_WRITE_MANY: The AccessMode means the disk can be |
| # attached to multiple instances in RW mode. |
| # - READ_ONLY_MANY: The AccessMode means the disk can be |
| # attached to multiple instances in RO mode. |
| # |
| # |
| # The AccessMode is only valid for Hyperdisk disk types. |
| "architecture": "A String", # The architecture of the disk. Valid values are |
| # ARM64 or X86_64. |
| "asyncPrimaryDisk": { # Disk asynchronously replicated into this disk. |
| "consistencyGroupPolicy": "A String", # [Output Only] URL of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "consistencyGroupPolicyId": "A String", # [Output Only] ID of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "disk": "A String", # The other disk asynchronously replicated to or from the current disk. |
| # You can provide this as a partial or full URL to the resource. |
| # For example, the following are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk |
| # - projects/project/zones/zone/disks/disk |
| # - zones/zone/disks/disk |
| "diskId": "A String", # [Output Only] The unique ID of the other disk asynchronously replicated |
| # to or from the current disk. This value identifies the exact disk that |
| # was used to create this replication. For example, if you started |
| # replicating the persistent disk from a disk that was later deleted and |
| # recreated under the same name, the disk ID would identify the exact |
| # version of the disk that was used. |
| }, |
| "asyncSecondaryDisks": { # [Output Only] A list of disks this disk is asynchronously replicated to. |
| "a_key": { |
| "asyncReplicationDisk": { |
| "consistencyGroupPolicy": "A String", # [Output Only] URL of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "consistencyGroupPolicyId": "A String", # [Output Only] ID of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "disk": "A String", # The other disk asynchronously replicated to or from the current disk. |
| # You can provide this as a partial or full URL to the resource. |
| # For example, the following are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk |
| # - projects/project/zones/zone/disks/disk |
| # - zones/zone/disks/disk |
| "diskId": "A String", # [Output Only] The unique ID of the other disk asynchronously replicated |
| # to or from the current disk. This value identifies the exact disk that |
| # was used to create this replication. For example, if you started |
| # replicating the persistent disk from a disk that was later deleted and |
| # recreated under the same name, the disk ID would identify the exact |
| # version of the disk that was used. |
| }, |
| }, |
| }, |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "description": "A String", # An optional description of this resource. Provide this property when you |
| # create the resource. |
| "diskEncryptionKey": { # Encrypts the disk using a |
| # customer-supplied encryption key or a |
| # customer-managed encryption key. |
| # |
| # Encryption keys do not protect access to metadata of the disk. |
| # |
| # After you encrypt a disk with a customer-supplied key, you must provide the |
| # same key if you use the disk later. For example, to create a disk snapshot, |
| # to create a disk image, to create a machine image, or to attach the disk to |
| # a virtual machine. |
| # |
| # After you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version* |
| # name once the disk is created. The disk is encrypted with this version of |
| # the key. In the response, diskEncryptionKey.kmsKeyName appears |
| # in the following format: |
| # |
| # "diskEncryptionKey.kmsKeyName": |
| # "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeysVersions/version |
| # |
| # If you do not provide an encryption key when creating the disk, then the |
| # disk is encrypted using an automatically generated key and you don't need |
| # to provide a key to use the disk later. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. |
| "eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase |
| # Windows specific VSS signature. |
| "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable |
| # only for bootable images. Read |
| # Enabling guest operating system features to see a list of available |
| # options. |
| { # Guest OS features. |
| "type": "A String", # The ID of a supported feature. To add multiple values, use commas to |
| # separate values. Set to one or more of the following values: |
| # |
| # - VIRTIO_SCSI_MULTIQUEUE |
| # - WINDOWS |
| # - MULTI_IP_SUBNET |
| # - UEFI_COMPATIBLE |
| # - GVNIC |
| # - SEV_CAPABLE |
| # - SUSPEND_RESUME_COMPATIBLE |
| # - SEV_LIVE_MIGRATABLE_V2 |
| # - SEV_SNP_CAPABLE |
| # - TDX_CAPABLE |
| # - IDPF |
| # - SNP_SVSM_CAPABLE |
| # |
| # |
| # For more information, see |
| # Enabling guest operating system features. |
| }, |
| ], |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk, |
| # which is either SCSI or NVME. The default isSCSI. |
| "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for |
| # disks. |
| "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is |
| # essentially a hash of the labels set used for optimistic locking. The |
| # fingerprint is initially generated by Compute Engine and changes after |
| # every request to modify or update labels. You must always provide an |
| # up-to-date fingerprint hash in order to update or change labels, |
| # otherwise the request will fail with error412 conditionNotMet. |
| # |
| # To see the latest fingerprint, make a get() request to |
| # retrieve a disk. |
| "labels": { # Labels to apply to this disk. These can be later modified by |
| # the setLabels method. |
| "a_key": "A String", |
| }, |
| "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp inRFC3339 |
| # text format. |
| "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp inRFC3339 |
| # text format. |
| "licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk. |
| "A String", |
| ], |
| "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. |
| "A String", |
| ], |
| "locationHint": "A String", # An opaque location hint used to place the disk close to other resources. |
| # This field is for use by internal tools that use the public API. |
| "locked": True or False, # [Output Only] The field indicates if the disk is created from a locked |
| # source image. Attachment of a disk created from a locked source image will |
| # cause the following operations to become irreversibly prohibited: |
| # |
| # - R/W or R/O disk attachment to any other instance |
| # - Disk detachment. And the disk can only be deleted when the instance |
| # is deleted |
| # - Creation of images or snapshots |
| # - Disk cloning |
| # |
| # |
| # |
| # Furthermore, the instance with at least one disk with locked flag set to |
| # true will be prohibited from performing the operations below: |
| # |
| # - Further attachment of secondary disks. |
| # - Detachment of any disks |
| # - Create machine images |
| # - Create instance template |
| # - Delete the instance with --keep-disk parameter set to true for locked |
| # disks |
| # - Attach a locked disk with --auto-delete parameter set to false |
| "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to |
| # more than one instance. |
| "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 withRFC1035. |
| # 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. |
| "options": "A String", # Internal use only. |
| "params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values |
| # have the same definition as resource |
| # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and |
| # values are in the format `tagValues/456`. The field is ignored (both PUT & |
| # PATCH) when empty. |
| "a_key": "A String", |
| }, |
| }, |
| "physicalBlockSizeBytes": "A String", # Physical block size of the persistent disk, in bytes. |
| # If not present in a request, a default value is used. |
| # The currently supported size is 4096, other sizes may be added in |
| # the future. |
| # If an unsupported value is requested, the error message will list |
| # the supported values for the caller's project. |
| "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number |
| # of I/O operations per second that the disk can handle. Values must be |
| # between 10,000 and 120,000. For more details, see theExtreme persistent |
| # disk documentation. |
| "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the |
| # number of throughput mb per second that the disk can handle. Values must be |
| # greater than or equal to 1. |
| "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for |
| # regional resources. |
| # You must specify this field as part of the HTTP request URL. It is |
| # not settable as a field in the request body. |
| "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable |
| # for regional resources. |
| "A String", |
| ], |
| "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. |
| "A String", |
| ], |
| "resourceStatus": { # [Output Only] Status information for the disk resource. |
| "asyncPrimaryDisk": { |
| "state": "A String", |
| }, |
| "asyncSecondaryDisks": { # Key: disk, value: AsyncReplicationStatus message |
| "a_key": { |
| "state": "A String", |
| }, |
| }, |
| "usedBytes": "A String", # [Output Only] Space used by data stored in the disk (in bytes). Note that |
| # this field is set only when the disk is in a storage pool. |
| }, |
| "satisfiesPzi": True or False, # Output only. Reserved for future use. |
| "satisfiesPzs": True or False, # [Output Only] Reserved for future use. |
| "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id. |
| "sizeGb": "A String", # Size, in GB, of the persistent disk. You can specify |
| # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty |
| # persistent disk. |
| # |
| # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the |
| # source. |
| # Acceptable values are greater than 0. |
| "sourceConsistencyGroupPolicy": "A String", # [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk |
| # that was created using a consistency group. |
| "sourceConsistencyGroupPolicyId": "A String", # [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk |
| # that was created using a consistency group. |
| "sourceDisk": "A String", # The source disk used to create this disk. You can provide this as a |
| # partial or full URL to the resource. For example, the following are valid |
| # values: |
| # |
| # |
| # - |
| # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk |
| # |
| # - |
| # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk |
| # |
| # - |
| # projects/project/zones/zone/disks/disk |
| # |
| # - |
| # projects/project/regions/region/disks/disk |
| # |
| # - |
| # zones/zone/disks/disk |
| # |
| # - |
| # regions/region/disks/disk |
| "sourceDiskId": "A String", # [Output Only] The unique ID of the disk used to create this disk. This |
| # value identifies the exact disk that was used to create this persistent |
| # disk. For example, if you created the persistent disk from a disk that |
| # was later deleted and recreated under the same name, the source disk ID |
| # would identify the exact version of the disk that was used. |
| "sourceImage": "A String", # The source image used to create this disk. If the source image is |
| # deleted, this field will not be set. |
| # |
| # To create a disk with one of the public operating system images, specify |
| # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image: |
| # |
| # projects/debian-cloud/global/images/family/debian-9 |
| # |
| # |
| # Alternatively, use a specific version of a public operating system image: |
| # |
| # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD |
| # |
| # |
| # To create a disk with a custom image that you created, specify the |
| # image name in the following format: |
| # |
| # global/images/my-custom-image |
| # |
| # |
| # You can also specify a custom image by its image family, which returns |
| # the latest version of the image in that family. Replace the image name |
| # with family/family-name: |
| # |
| # global/images/family/my-image-family |
| "sourceImageEncryptionKey": { # Thecustomer-supplied |
| # encryption key of the source image. Required if the source image is |
| # protected by a customer-supplied encryption key. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This |
| # value identifies the exact image that was used to create this persistent |
| # disk. For example, if you created the persistent disk from an image that |
| # was later deleted and recreated under the same name, the source image ID |
| # would identify the exact version of the image that was used. |
| "sourceInstantSnapshot": "A String", # The source instant snapshot used to create this disk. You can provide |
| # this as a partial or full URL to the resource. For example, the following |
| # are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot |
| # - projects/project/zones/zone/instantSnapshots/instantSnapshot |
| # - zones/zone/instantSnapshots/instantSnapshot |
| "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this |
| # disk. This value identifies the exact instant snapshot that was used to |
| # create this persistent disk. For example, if you created the persistent |
| # disk from an instant snapshot that was later deleted and recreated under |
| # the same name, the source instant snapshot ID would identify the exact |
| # version of the instant snapshot that was used. |
| "sourceMachineImage": "A String", # The machine image to create the disk from. You can provide this as a |
| # partial or full URL to the resource. For example, the following are valid |
| # values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/global/machineImages/machineImage |
| # - projects/project/global/machineImages/machineImage |
| # - global/machineImages/machineImage |
| "sourceMachineImageDiskDeviceName": "A String", # Input only. The device name of a disk within a given machine image. The |
| # source_machine_image must be specified. |
| "sourceMachineImageEncryptionKey": { # Thecustomer-supplied |
| # encryption key of the source machine image. Required if the source |
| # machine image is protected by a customer-supplied encryption key. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceMachineImageId": "A String", # [Output Only] The unique ID of the machine image used to create this disk. |
| # This value identifies the exact machine image that was used to create this |
| # persistent disk. For example, if you created the persistent disk from a |
| # machine image that was later deleted and recreated under the same name, the |
| # source machine image ID would identify the exact version of the machine |
| # image that was used. |
| "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a |
| # partial or full URL to the resource. For example, the following are valid |
| # values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot |
| # - projects/project/global/snapshots/snapshot |
| # - global/snapshots/snapshot |
| "sourceSnapshotEncryptionKey": { # Thecustomer-supplied |
| # encryption key of the source snapshot. Required if the source snapshot |
| # is protected by a customer-supplied encryption key. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This |
| # value identifies the exact snapshot that was used to create this persistent |
| # disk. For example, if you created the persistent disk from a snapshot that |
| # was later deleted and recreated under the same name, the source snapshot ID |
| # would identify the exact version of the snapshot that was used. |
| "sourceStorageObject": "A String", # The full Google Cloud Storage URI where the disk image is stored. This file |
| # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual |
| # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or |
| # https://storage.googleapis.com/. This flag is not optimized for creating |
| # multiple disks from a source storage object. To create many disks from a |
| # source storage object, use gcloud compute images |
| # import instead. |
| "status": "A String", # [Output Only] The status of disk creation. |
| # |
| # |
| # - CREATING: Disk is provisioning. |
| # - RESTORING: Source data is being copied into the |
| # disk. |
| # - FAILED: Disk creation failed. |
| # - READY: Disk is ready for use. |
| # - DELETING: Disk is deleting. |
| "storagePool": "A String", # The storage pool in which the new disk is created. You can provide |
| # this as a partial or full URL to the resource. For example, the following |
| # are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool |
| # - projects/project/zones/zone/storagePools/storagePool |
| # - zones/zone/storagePools/storagePool |
| "storageType": "A String", # [Deprecated] Storage type of the persistent disk. |
| "type": "A String", # URL of the disk type resource describing which disk type to use to create |
| # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk |
| # types. |
| "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user |
| # provided licenses can be modified after the disk is created. This includes |
| # a list of URLs to the license resource. For example, to provide a debian |
| # license: |
| # |
| # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch |
| "A String", |
| ], |
| "users": [ # [Output Only] Links to the users of the disk (attached instances) |
| # in form:projects/project/zones/zone/instances/instance |
| "A String", |
| ], |
| "zone": "A String", # [Output Only] URL of the zone where the disk resides. |
| # You must specify this field as part of the HTTP request URL. It is |
| # not settable as a field in the request body. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getAsyncReplicationStatus">getAsyncReplicationStatus(project, region, disk, x__xgafv=None)</code> |
| <pre>Gets the status of current async replication for a given device. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the zone for this request. (required) |
| disk: string, Name of the Disk resource whose Async replication details are requested. |
| Name should conform to RFC1035 or be an unsigned long integer. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "asyncReplicationStatus": { |
| "diskPairReplicationState": { |
| "dataReplicationState": "A String", # [Output Only] The status of disk creation. |
| # |
| # |
| # - ASYNC_REPLICATION_STATE_INITIALIZING: The device is |
| # doing the initial replication after starting the |
| # replication. |
| # |
| # - ASYNC_REPLICATION_STATE_REPLICATING_HEALTHY: The |
| # primary disk is healthily replicating to the secondary device i.e. |
| # last_replication_time is within RPO. |
| # |
| # - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_HIGH_CHURN: |
| # The replication is lagging above the SLO limit due to the disk's change |
| # rate being above the supported limit. |
| # |
| # - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_SYSTEM_LAGGING: |
| # The replication is lagging, and the RPO is not being met due to some |
| # internal issue. |
| # |
| # - ASYNC_REPLICATION_STATE_REPLICATION_STUCK: The |
| # replication is completely stuck due to some internal error. |
| # |
| # - ASYNC_REPLICATION_STATE_STOPPING: The replication |
| # is under the process of being stopped. This is a transient state. |
| # |
| # - ASYNC_REPLICATION_STATE_STOPPED: The replication |
| # between the disk-pairs have stopped. |
| # |
| # - ASYNC_REPLICATION_STATE_REPLICATING_BEHIND_CG_HIGH_CHURN: |
| # The replication is lagging above the SLO limit for the disk in the |
| # consistency group due to disk's change rate being above the supported |
| # limit. |
| "replicationDiskPair": { |
| "primaryDisk": "A String", # URL of the primary disk. |
| "secondaryDisk": "A String", # URL of the secondary disk. |
| }, |
| }, |
| "lastReplicationDetails": { |
| "lastReplicationTime": "A String", # The last sync time of the device pair. |
| "secondsSinceLastReplication": "A String", # Replication lag in seconds. This will only be populated if device is in |
| # replicating state. Note that the value is calculated sometime during |
| # request processing and at the instant the client receives the response, |
| # the current replication_lag may have changed. |
| }, |
| }, |
| "etag": "A String", # end_interface: MixerGetResponseWithEtagBuilder |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code> |
| <pre>Gets the access control policy for a resource. May be empty if no such |
| policy or resource exists. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the region for this request. (required) |
| resource: string, Name or id of the resource for this request. (required) |
| optionsRequestedPolicyVersion: integer, Requested IAM Policy version. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members`, or principals, to a single `role`. Principals can be user |
| # accounts, service accounts, Google groups, and domains (such as G Suite). A |
| # `role` is a named list of permissions; each `role` can be an IAM predefined |
| # role or a user-created custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # ``` |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:[email protected]", |
| # "group:[email protected]", |
| # "domain:google.com", |
| # "serviceAccount:[email protected]" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:[email protected]" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # ``` |
| # |
| # **YAML example:** |
| # |
| # ``` |
| # bindings: |
| # - members: |
| # - user:[email protected] |
| # - group:[email protected] |
| # - domain:google.com |
| # - serviceAccount:[email protected] |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:[email protected] |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # etag: BwWWja0YfJA= |
| # version: 3 |
| # ``` |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| { # Specifies the audit configuration for a service. |
| # The configuration determines which permission types are logged, and what |
| # identities, if any, are exempted from logging. |
| # An AuditConfig must have one or more AuditLogConfigs. |
| # |
| # If there are AuditConfigs for both `allServices` and a specific service, |
| # the union of the two AuditConfigs is used for that service: the log_types |
| # specified in each AuditConfig are enabled, and the exempted_members in each |
| # AuditLogConfig are exempted. |
| # |
| # Example Policy with multiple AuditConfigs: |
| # |
| # { |
| # "audit_configs": [ |
| # { |
| # "service": "allServices", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:[email protected]" |
| # ] |
| # }, |
| # { |
| # "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:[email protected]" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts `[email protected]` from DATA_READ logging, and |
| # `[email protected]` from DATA_WRITE logging. |
| "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| { # Provides the configuration for logging a type of permissions. |
| # Example: |
| # |
| # { |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:[email protected]" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # [email protected] from DATA_READ logging. |
| "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| # permission. |
| # Follows the same format of Binding.members. |
| "A String", |
| ], |
| "logType": "A String", # The log type that this config enables. |
| }, |
| ], |
| "service": "A String", # Specifies a service that will be enabled for audit logging. |
| # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| # `allServices` is a special value that covers all services. |
| }, |
| ], |
| "bindings": [ # Associates a list of `members`, or principals, with 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 principal. |
| # |
| # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 |
| # of these principals can be Google groups. Each occurrence of a principal |
| # counts towards these limits. For example, if the `bindings` grant 50 |
| # different roles to `user:[email protected]`, and not to any other |
| # principal, then you can add another 1,450 principals to the `bindings` in |
| # the `Policy`. |
| { # Associates `members`, or principals, with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # 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 principals 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). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| }, |
| "members": [ # Specifies the principals requesting access for a Google Cloud 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. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # Does not include identities that come from external identity providers |
| # (IdPs) through identity federation. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `[email protected]` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a Google |
| # service account. For example, |
| # `[email protected]`. |
| # |
| # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An |
| # identifier for a |
| # [Kubernetes service |
| # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). |
| # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `[email protected]`. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| # |
| # |
| # |
| # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: |
| # A single identity in a workforce identity pool. |
| # |
| # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: |
| # All workforce identities in a group. |
| # |
| # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: |
| # All workforce identities with a specific attribute value. |
| # |
| # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: |
| # All identities in a workforce identity pool. |
| # |
| # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: |
| # A single identity in a workload identity pool. |
| # |
| # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: |
| # A workload identity pool group. |
| # |
| # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: |
| # All identities in a workload identity pool with a certain attribute. |
| # |
| # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: |
| # All identities in a workload identity pool. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `[email protected]?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `[email protected]?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `[email protected]?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: |
| # Deleted single identity in a workforce identity pool. For example, |
| # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to the list of `members`, or principals. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| # |
| # For an overview of the IAM roles and permissions, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For |
| # a list of the available pre-defined roles, see |
| # [here](https://cloud.google.com/iam/docs/understanding-roles). |
| }, |
| ], |
| "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. |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(project, region, body=None, requestId=None, sourceImage=None, x__xgafv=None)</code> |
| <pre>Creates a persistent regional disk in the specified project using the data |
| included in the request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a Persistent Disk resource. |
| # |
| # Google Compute Engine has two Disk resources: |
| # |
| # * [Zonal](/compute/docs/reference/rest/alpha/disks) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionDisks) |
| # |
| # Persistent disks are required for running your VM instances. |
| # Create both boot and non-boot (data) persistent disks. For more information, |
| # read Persistent Disks. For more |
| # storage options, read Storage options. |
| # |
| # The disks resource represents a zonal persistent disk. |
| # For more information, readZonal persistent disks. |
| # |
| # The regionDisks resource represents a |
| # regional persistent disk. For more information, read |
| # Regional resources. |
| "accessMode": "A String", # The access mode of the disk. |
| # |
| # |
| # - READ_WRITE_SINGLE: The default AccessMode, means the |
| # disk can be attached to single instance in RW mode. |
| # - READ_WRITE_MANY: The AccessMode means the disk can be |
| # attached to multiple instances in RW mode. |
| # - READ_ONLY_MANY: The AccessMode means the disk can be |
| # attached to multiple instances in RO mode. |
| # |
| # |
| # The AccessMode is only valid for Hyperdisk disk types. |
| "architecture": "A String", # The architecture of the disk. Valid values are |
| # ARM64 or X86_64. |
| "asyncPrimaryDisk": { # Disk asynchronously replicated into this disk. |
| "consistencyGroupPolicy": "A String", # [Output Only] URL of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "consistencyGroupPolicyId": "A String", # [Output Only] ID of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "disk": "A String", # The other disk asynchronously replicated to or from the current disk. |
| # You can provide this as a partial or full URL to the resource. |
| # For example, the following are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk |
| # - projects/project/zones/zone/disks/disk |
| # - zones/zone/disks/disk |
| "diskId": "A String", # [Output Only] The unique ID of the other disk asynchronously replicated |
| # to or from the current disk. This value identifies the exact disk that |
| # was used to create this replication. For example, if you started |
| # replicating the persistent disk from a disk that was later deleted and |
| # recreated under the same name, the disk ID would identify the exact |
| # version of the disk that was used. |
| }, |
| "asyncSecondaryDisks": { # [Output Only] A list of disks this disk is asynchronously replicated to. |
| "a_key": { |
| "asyncReplicationDisk": { |
| "consistencyGroupPolicy": "A String", # [Output Only] URL of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "consistencyGroupPolicyId": "A String", # [Output Only] ID of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "disk": "A String", # The other disk asynchronously replicated to or from the current disk. |
| # You can provide this as a partial or full URL to the resource. |
| # For example, the following are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk |
| # - projects/project/zones/zone/disks/disk |
| # - zones/zone/disks/disk |
| "diskId": "A String", # [Output Only] The unique ID of the other disk asynchronously replicated |
| # to or from the current disk. This value identifies the exact disk that |
| # was used to create this replication. For example, if you started |
| # replicating the persistent disk from a disk that was later deleted and |
| # recreated under the same name, the disk ID would identify the exact |
| # version of the disk that was used. |
| }, |
| }, |
| }, |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "description": "A String", # An optional description of this resource. Provide this property when you |
| # create the resource. |
| "diskEncryptionKey": { # Encrypts the disk using a |
| # customer-supplied encryption key or a |
| # customer-managed encryption key. |
| # |
| # Encryption keys do not protect access to metadata of the disk. |
| # |
| # After you encrypt a disk with a customer-supplied key, you must provide the |
| # same key if you use the disk later. For example, to create a disk snapshot, |
| # to create a disk image, to create a machine image, or to attach the disk to |
| # a virtual machine. |
| # |
| # After you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version* |
| # name once the disk is created. The disk is encrypted with this version of |
| # the key. In the response, diskEncryptionKey.kmsKeyName appears |
| # in the following format: |
| # |
| # "diskEncryptionKey.kmsKeyName": |
| # "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeysVersions/version |
| # |
| # If you do not provide an encryption key when creating the disk, then the |
| # disk is encrypted using an automatically generated key and you don't need |
| # to provide a key to use the disk later. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. |
| "eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase |
| # Windows specific VSS signature. |
| "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable |
| # only for bootable images. Read |
| # Enabling guest operating system features to see a list of available |
| # options. |
| { # Guest OS features. |
| "type": "A String", # The ID of a supported feature. To add multiple values, use commas to |
| # separate values. Set to one or more of the following values: |
| # |
| # - VIRTIO_SCSI_MULTIQUEUE |
| # - WINDOWS |
| # - MULTI_IP_SUBNET |
| # - UEFI_COMPATIBLE |
| # - GVNIC |
| # - SEV_CAPABLE |
| # - SUSPEND_RESUME_COMPATIBLE |
| # - SEV_LIVE_MIGRATABLE_V2 |
| # - SEV_SNP_CAPABLE |
| # - TDX_CAPABLE |
| # - IDPF |
| # - SNP_SVSM_CAPABLE |
| # |
| # |
| # For more information, see |
| # Enabling guest operating system features. |
| }, |
| ], |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk, |
| # which is either SCSI or NVME. The default isSCSI. |
| "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for |
| # disks. |
| "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is |
| # essentially a hash of the labels set used for optimistic locking. The |
| # fingerprint is initially generated by Compute Engine and changes after |
| # every request to modify or update labels. You must always provide an |
| # up-to-date fingerprint hash in order to update or change labels, |
| # otherwise the request will fail with error412 conditionNotMet. |
| # |
| # To see the latest fingerprint, make a get() request to |
| # retrieve a disk. |
| "labels": { # Labels to apply to this disk. These can be later modified by |
| # the setLabels method. |
| "a_key": "A String", |
| }, |
| "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp inRFC3339 |
| # text format. |
| "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp inRFC3339 |
| # text format. |
| "licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk. |
| "A String", |
| ], |
| "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. |
| "A String", |
| ], |
| "locationHint": "A String", # An opaque location hint used to place the disk close to other resources. |
| # This field is for use by internal tools that use the public API. |
| "locked": True or False, # [Output Only] The field indicates if the disk is created from a locked |
| # source image. Attachment of a disk created from a locked source image will |
| # cause the following operations to become irreversibly prohibited: |
| # |
| # - R/W or R/O disk attachment to any other instance |
| # - Disk detachment. And the disk can only be deleted when the instance |
| # is deleted |
| # - Creation of images or snapshots |
| # - Disk cloning |
| # |
| # |
| # |
| # Furthermore, the instance with at least one disk with locked flag set to |
| # true will be prohibited from performing the operations below: |
| # |
| # - Further attachment of secondary disks. |
| # - Detachment of any disks |
| # - Create machine images |
| # - Create instance template |
| # - Delete the instance with --keep-disk parameter set to true for locked |
| # disks |
| # - Attach a locked disk with --auto-delete parameter set to false |
| "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to |
| # more than one instance. |
| "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 withRFC1035. |
| # 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. |
| "options": "A String", # Internal use only. |
| "params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values |
| # have the same definition as resource |
| # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and |
| # values are in the format `tagValues/456`. The field is ignored (both PUT & |
| # PATCH) when empty. |
| "a_key": "A String", |
| }, |
| }, |
| "physicalBlockSizeBytes": "A String", # Physical block size of the persistent disk, in bytes. |
| # If not present in a request, a default value is used. |
| # The currently supported size is 4096, other sizes may be added in |
| # the future. |
| # If an unsupported value is requested, the error message will list |
| # the supported values for the caller's project. |
| "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number |
| # of I/O operations per second that the disk can handle. Values must be |
| # between 10,000 and 120,000. For more details, see theExtreme persistent |
| # disk documentation. |
| "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the |
| # number of throughput mb per second that the disk can handle. Values must be |
| # greater than or equal to 1. |
| "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for |
| # regional resources. |
| # You must specify this field as part of the HTTP request URL. It is |
| # not settable as a field in the request body. |
| "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable |
| # for regional resources. |
| "A String", |
| ], |
| "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. |
| "A String", |
| ], |
| "resourceStatus": { # [Output Only] Status information for the disk resource. |
| "asyncPrimaryDisk": { |
| "state": "A String", |
| }, |
| "asyncSecondaryDisks": { # Key: disk, value: AsyncReplicationStatus message |
| "a_key": { |
| "state": "A String", |
| }, |
| }, |
| "usedBytes": "A String", # [Output Only] Space used by data stored in the disk (in bytes). Note that |
| # this field is set only when the disk is in a storage pool. |
| }, |
| "satisfiesPzi": True or False, # Output only. Reserved for future use. |
| "satisfiesPzs": True or False, # [Output Only] Reserved for future use. |
| "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id. |
| "sizeGb": "A String", # Size, in GB, of the persistent disk. You can specify |
| # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty |
| # persistent disk. |
| # |
| # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the |
| # source. |
| # Acceptable values are greater than 0. |
| "sourceConsistencyGroupPolicy": "A String", # [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk |
| # that was created using a consistency group. |
| "sourceConsistencyGroupPolicyId": "A String", # [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk |
| # that was created using a consistency group. |
| "sourceDisk": "A String", # The source disk used to create this disk. You can provide this as a |
| # partial or full URL to the resource. For example, the following are valid |
| # values: |
| # |
| # |
| # - |
| # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk |
| # |
| # - |
| # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk |
| # |
| # - |
| # projects/project/zones/zone/disks/disk |
| # |
| # - |
| # projects/project/regions/region/disks/disk |
| # |
| # - |
| # zones/zone/disks/disk |
| # |
| # - |
| # regions/region/disks/disk |
| "sourceDiskId": "A String", # [Output Only] The unique ID of the disk used to create this disk. This |
| # value identifies the exact disk that was used to create this persistent |
| # disk. For example, if you created the persistent disk from a disk that |
| # was later deleted and recreated under the same name, the source disk ID |
| # would identify the exact version of the disk that was used. |
| "sourceImage": "A String", # The source image used to create this disk. If the source image is |
| # deleted, this field will not be set. |
| # |
| # To create a disk with one of the public operating system images, specify |
| # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image: |
| # |
| # projects/debian-cloud/global/images/family/debian-9 |
| # |
| # |
| # Alternatively, use a specific version of a public operating system image: |
| # |
| # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD |
| # |
| # |
| # To create a disk with a custom image that you created, specify the |
| # image name in the following format: |
| # |
| # global/images/my-custom-image |
| # |
| # |
| # You can also specify a custom image by its image family, which returns |
| # the latest version of the image in that family. Replace the image name |
| # with family/family-name: |
| # |
| # global/images/family/my-image-family |
| "sourceImageEncryptionKey": { # Thecustomer-supplied |
| # encryption key of the source image. Required if the source image is |
| # protected by a customer-supplied encryption key. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This |
| # value identifies the exact image that was used to create this persistent |
| # disk. For example, if you created the persistent disk from an image that |
| # was later deleted and recreated under the same name, the source image ID |
| # would identify the exact version of the image that was used. |
| "sourceInstantSnapshot": "A String", # The source instant snapshot used to create this disk. You can provide |
| # this as a partial or full URL to the resource. For example, the following |
| # are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot |
| # - projects/project/zones/zone/instantSnapshots/instantSnapshot |
| # - zones/zone/instantSnapshots/instantSnapshot |
| "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this |
| # disk. This value identifies the exact instant snapshot that was used to |
| # create this persistent disk. For example, if you created the persistent |
| # disk from an instant snapshot that was later deleted and recreated under |
| # the same name, the source instant snapshot ID would identify the exact |
| # version of the instant snapshot that was used. |
| "sourceMachineImage": "A String", # The machine image to create the disk from. You can provide this as a |
| # partial or full URL to the resource. For example, the following are valid |
| # values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/global/machineImages/machineImage |
| # - projects/project/global/machineImages/machineImage |
| # - global/machineImages/machineImage |
| "sourceMachineImageDiskDeviceName": "A String", # Input only. The device name of a disk within a given machine image. The |
| # source_machine_image must be specified. |
| "sourceMachineImageEncryptionKey": { # Thecustomer-supplied |
| # encryption key of the source machine image. Required if the source |
| # machine image is protected by a customer-supplied encryption key. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceMachineImageId": "A String", # [Output Only] The unique ID of the machine image used to create this disk. |
| # This value identifies the exact machine image that was used to create this |
| # persistent disk. For example, if you created the persistent disk from a |
| # machine image that was later deleted and recreated under the same name, the |
| # source machine image ID would identify the exact version of the machine |
| # image that was used. |
| "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a |
| # partial or full URL to the resource. For example, the following are valid |
| # values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot |
| # - projects/project/global/snapshots/snapshot |
| # - global/snapshots/snapshot |
| "sourceSnapshotEncryptionKey": { # Thecustomer-supplied |
| # encryption key of the source snapshot. Required if the source snapshot |
| # is protected by a customer-supplied encryption key. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This |
| # value identifies the exact snapshot that was used to create this persistent |
| # disk. For example, if you created the persistent disk from a snapshot that |
| # was later deleted and recreated under the same name, the source snapshot ID |
| # would identify the exact version of the snapshot that was used. |
| "sourceStorageObject": "A String", # The full Google Cloud Storage URI where the disk image is stored. This file |
| # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual |
| # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or |
| # https://storage.googleapis.com/. This flag is not optimized for creating |
| # multiple disks from a source storage object. To create many disks from a |
| # source storage object, use gcloud compute images |
| # import instead. |
| "status": "A String", # [Output Only] The status of disk creation. |
| # |
| # |
| # - CREATING: Disk is provisioning. |
| # - RESTORING: Source data is being copied into the |
| # disk. |
| # - FAILED: Disk creation failed. |
| # - READY: Disk is ready for use. |
| # - DELETING: Disk is deleting. |
| "storagePool": "A String", # The storage pool in which the new disk is created. You can provide |
| # this as a partial or full URL to the resource. For example, the following |
| # are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool |
| # - projects/project/zones/zone/storagePools/storagePool |
| # - zones/zone/storagePools/storagePool |
| "storageType": "A String", # [Deprecated] Storage type of the persistent disk. |
| "type": "A String", # URL of the disk type resource describing which disk type to use to create |
| # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk |
| # types. |
| "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user |
| # provided licenses can be modified after the disk is created. This includes |
| # a list of URLs to the license resource. For example, to provide a debian |
| # license: |
| # |
| # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch |
| "A String", |
| ], |
| "users": [ # [Output Only] Links to the users of the disk (attached instances) |
| # in form:projects/project/zones/zone/instances/instance |
| "A String", |
| ], |
| "zone": "A String", # [Output Only] URL of the zone where the disk resides. |
| # You must specify this field as part of the HTTP request URL. It is |
| # not settable as a field in the request body. |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| sourceImage: string, Source image to restore onto a disk. This field is optional. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| <pre>Retrieves the list of persistent disks contained within |
| the specified region. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| filter: string, A filter expression that filters resources listed in the response. Most |
| Compute resources support two types of filter expressions: |
| expressions that support regular expressions and expressions that follow |
| API improvement proposal AIP-160. |
| These two types of filter expressions cannot be mixed in one request. |
| |
| If you want to use AIP-160, your expression must specify the field name, an |
| operator, and the value that you want to use for filtering. The value |
| must be a string, a number, or a boolean. The 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`. |
| |
| The `:*` comparison can be used to test whether a key has been defined. |
| For example, to find all objects with `owner` label use: |
| ``` |
| labels.owner:* |
| ``` |
| |
| 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 onresource 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) |
| ``` |
| |
| If you want to use a regular expression, use the `eq` (equal) or `ne` |
| (not equal) operator against a single un-parenthesized expression with or |
| without quotes or against multiple parenthesized expressions. Examples: |
| |
| `fieldname eq unquoted literal` |
| `fieldname eq 'single quoted literal'` |
| `fieldname eq "double quoted literal"` |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` |
| |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. |
| The literal value must match the entire field. |
| |
| For example, to filter for instances that do not end with name "instance", |
| you would use `name ne .*instance`. |
| |
| You cannot combine constraints on multiple fields using regular |
| expressions. |
| 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. |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case |
| of failure. The default value is false. |
| |
| For example, when partial success behavior is enabled, aggregatedList for a |
| single zone scope either returns all resources in the zone or no resources, |
| with an error code. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A list of Disk resources. |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| "items": [ # A list of Disk resources. |
| { # Represents a Persistent Disk resource. |
| # |
| # Google Compute Engine has two Disk resources: |
| # |
| # * [Zonal](/compute/docs/reference/rest/alpha/disks) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionDisks) |
| # |
| # Persistent disks are required for running your VM instances. |
| # Create both boot and non-boot (data) persistent disks. For more information, |
| # read Persistent Disks. For more |
| # storage options, read Storage options. |
| # |
| # The disks resource represents a zonal persistent disk. |
| # For more information, readZonal persistent disks. |
| # |
| # The regionDisks resource represents a |
| # regional persistent disk. For more information, read |
| # Regional resources. |
| "accessMode": "A String", # The access mode of the disk. |
| # |
| # |
| # - READ_WRITE_SINGLE: The default AccessMode, means the |
| # disk can be attached to single instance in RW mode. |
| # - READ_WRITE_MANY: The AccessMode means the disk can be |
| # attached to multiple instances in RW mode. |
| # - READ_ONLY_MANY: The AccessMode means the disk can be |
| # attached to multiple instances in RO mode. |
| # |
| # |
| # The AccessMode is only valid for Hyperdisk disk types. |
| "architecture": "A String", # The architecture of the disk. Valid values are |
| # ARM64 or X86_64. |
| "asyncPrimaryDisk": { # Disk asynchronously replicated into this disk. |
| "consistencyGroupPolicy": "A String", # [Output Only] URL of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "consistencyGroupPolicyId": "A String", # [Output Only] ID of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "disk": "A String", # The other disk asynchronously replicated to or from the current disk. |
| # You can provide this as a partial or full URL to the resource. |
| # For example, the following are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk |
| # - projects/project/zones/zone/disks/disk |
| # - zones/zone/disks/disk |
| "diskId": "A String", # [Output Only] The unique ID of the other disk asynchronously replicated |
| # to or from the current disk. This value identifies the exact disk that |
| # was used to create this replication. For example, if you started |
| # replicating the persistent disk from a disk that was later deleted and |
| # recreated under the same name, the disk ID would identify the exact |
| # version of the disk that was used. |
| }, |
| "asyncSecondaryDisks": { # [Output Only] A list of disks this disk is asynchronously replicated to. |
| "a_key": { |
| "asyncReplicationDisk": { |
| "consistencyGroupPolicy": "A String", # [Output Only] URL of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "consistencyGroupPolicyId": "A String", # [Output Only] ID of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "disk": "A String", # The other disk asynchronously replicated to or from the current disk. |
| # You can provide this as a partial or full URL to the resource. |
| # For example, the following are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk |
| # - projects/project/zones/zone/disks/disk |
| # - zones/zone/disks/disk |
| "diskId": "A String", # [Output Only] The unique ID of the other disk asynchronously replicated |
| # to or from the current disk. This value identifies the exact disk that |
| # was used to create this replication. For example, if you started |
| # replicating the persistent disk from a disk that was later deleted and |
| # recreated under the same name, the disk ID would identify the exact |
| # version of the disk that was used. |
| }, |
| }, |
| }, |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "description": "A String", # An optional description of this resource. Provide this property when you |
| # create the resource. |
| "diskEncryptionKey": { # Encrypts the disk using a |
| # customer-supplied encryption key or a |
| # customer-managed encryption key. |
| # |
| # Encryption keys do not protect access to metadata of the disk. |
| # |
| # After you encrypt a disk with a customer-supplied key, you must provide the |
| # same key if you use the disk later. For example, to create a disk snapshot, |
| # to create a disk image, to create a machine image, or to attach the disk to |
| # a virtual machine. |
| # |
| # After you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version* |
| # name once the disk is created. The disk is encrypted with this version of |
| # the key. In the response, diskEncryptionKey.kmsKeyName appears |
| # in the following format: |
| # |
| # "diskEncryptionKey.kmsKeyName": |
| # "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeysVersions/version |
| # |
| # If you do not provide an encryption key when creating the disk, then the |
| # disk is encrypted using an automatically generated key and you don't need |
| # to provide a key to use the disk later. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. |
| "eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase |
| # Windows specific VSS signature. |
| "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable |
| # only for bootable images. Read |
| # Enabling guest operating system features to see a list of available |
| # options. |
| { # Guest OS features. |
| "type": "A String", # The ID of a supported feature. To add multiple values, use commas to |
| # separate values. Set to one or more of the following values: |
| # |
| # - VIRTIO_SCSI_MULTIQUEUE |
| # - WINDOWS |
| # - MULTI_IP_SUBNET |
| # - UEFI_COMPATIBLE |
| # - GVNIC |
| # - SEV_CAPABLE |
| # - SUSPEND_RESUME_COMPATIBLE |
| # - SEV_LIVE_MIGRATABLE_V2 |
| # - SEV_SNP_CAPABLE |
| # - TDX_CAPABLE |
| # - IDPF |
| # - SNP_SVSM_CAPABLE |
| # |
| # |
| # For more information, see |
| # Enabling guest operating system features. |
| }, |
| ], |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk, |
| # which is either SCSI or NVME. The default isSCSI. |
| "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for |
| # disks. |
| "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is |
| # essentially a hash of the labels set used for optimistic locking. The |
| # fingerprint is initially generated by Compute Engine and changes after |
| # every request to modify or update labels. You must always provide an |
| # up-to-date fingerprint hash in order to update or change labels, |
| # otherwise the request will fail with error412 conditionNotMet. |
| # |
| # To see the latest fingerprint, make a get() request to |
| # retrieve a disk. |
| "labels": { # Labels to apply to this disk. These can be later modified by |
| # the setLabels method. |
| "a_key": "A String", |
| }, |
| "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp inRFC3339 |
| # text format. |
| "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp inRFC3339 |
| # text format. |
| "licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk. |
| "A String", |
| ], |
| "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. |
| "A String", |
| ], |
| "locationHint": "A String", # An opaque location hint used to place the disk close to other resources. |
| # This field is for use by internal tools that use the public API. |
| "locked": True or False, # [Output Only] The field indicates if the disk is created from a locked |
| # source image. Attachment of a disk created from a locked source image will |
| # cause the following operations to become irreversibly prohibited: |
| # |
| # - R/W or R/O disk attachment to any other instance |
| # - Disk detachment. And the disk can only be deleted when the instance |
| # is deleted |
| # - Creation of images or snapshots |
| # - Disk cloning |
| # |
| # |
| # |
| # Furthermore, the instance with at least one disk with locked flag set to |
| # true will be prohibited from performing the operations below: |
| # |
| # - Further attachment of secondary disks. |
| # - Detachment of any disks |
| # - Create machine images |
| # - Create instance template |
| # - Delete the instance with --keep-disk parameter set to true for locked |
| # disks |
| # - Attach a locked disk with --auto-delete parameter set to false |
| "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to |
| # more than one instance. |
| "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 withRFC1035. |
| # 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. |
| "options": "A String", # Internal use only. |
| "params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values |
| # have the same definition as resource |
| # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and |
| # values are in the format `tagValues/456`. The field is ignored (both PUT & |
| # PATCH) when empty. |
| "a_key": "A String", |
| }, |
| }, |
| "physicalBlockSizeBytes": "A String", # Physical block size of the persistent disk, in bytes. |
| # If not present in a request, a default value is used. |
| # The currently supported size is 4096, other sizes may be added in |
| # the future. |
| # If an unsupported value is requested, the error message will list |
| # the supported values for the caller's project. |
| "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number |
| # of I/O operations per second that the disk can handle. Values must be |
| # between 10,000 and 120,000. For more details, see theExtreme persistent |
| # disk documentation. |
| "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the |
| # number of throughput mb per second that the disk can handle. Values must be |
| # greater than or equal to 1. |
| "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for |
| # regional resources. |
| # You must specify this field as part of the HTTP request URL. It is |
| # not settable as a field in the request body. |
| "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable |
| # for regional resources. |
| "A String", |
| ], |
| "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. |
| "A String", |
| ], |
| "resourceStatus": { # [Output Only] Status information for the disk resource. |
| "asyncPrimaryDisk": { |
| "state": "A String", |
| }, |
| "asyncSecondaryDisks": { # Key: disk, value: AsyncReplicationStatus message |
| "a_key": { |
| "state": "A String", |
| }, |
| }, |
| "usedBytes": "A String", # [Output Only] Space used by data stored in the disk (in bytes). Note that |
| # this field is set only when the disk is in a storage pool. |
| }, |
| "satisfiesPzi": True or False, # Output only. Reserved for future use. |
| "satisfiesPzs": True or False, # [Output Only] Reserved for future use. |
| "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id. |
| "sizeGb": "A String", # Size, in GB, of the persistent disk. You can specify |
| # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty |
| # persistent disk. |
| # |
| # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the |
| # source. |
| # Acceptable values are greater than 0. |
| "sourceConsistencyGroupPolicy": "A String", # [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk |
| # that was created using a consistency group. |
| "sourceConsistencyGroupPolicyId": "A String", # [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk |
| # that was created using a consistency group. |
| "sourceDisk": "A String", # The source disk used to create this disk. You can provide this as a |
| # partial or full URL to the resource. For example, the following are valid |
| # values: |
| # |
| # |
| # - |
| # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk |
| # |
| # - |
| # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk |
| # |
| # - |
| # projects/project/zones/zone/disks/disk |
| # |
| # - |
| # projects/project/regions/region/disks/disk |
| # |
| # - |
| # zones/zone/disks/disk |
| # |
| # - |
| # regions/region/disks/disk |
| "sourceDiskId": "A String", # [Output Only] The unique ID of the disk used to create this disk. This |
| # value identifies the exact disk that was used to create this persistent |
| # disk. For example, if you created the persistent disk from a disk that |
| # was later deleted and recreated under the same name, the source disk ID |
| # would identify the exact version of the disk that was used. |
| "sourceImage": "A String", # The source image used to create this disk. If the source image is |
| # deleted, this field will not be set. |
| # |
| # To create a disk with one of the public operating system images, specify |
| # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image: |
| # |
| # projects/debian-cloud/global/images/family/debian-9 |
| # |
| # |
| # Alternatively, use a specific version of a public operating system image: |
| # |
| # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD |
| # |
| # |
| # To create a disk with a custom image that you created, specify the |
| # image name in the following format: |
| # |
| # global/images/my-custom-image |
| # |
| # |
| # You can also specify a custom image by its image family, which returns |
| # the latest version of the image in that family. Replace the image name |
| # with family/family-name: |
| # |
| # global/images/family/my-image-family |
| "sourceImageEncryptionKey": { # Thecustomer-supplied |
| # encryption key of the source image. Required if the source image is |
| # protected by a customer-supplied encryption key. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This |
| # value identifies the exact image that was used to create this persistent |
| # disk. For example, if you created the persistent disk from an image that |
| # was later deleted and recreated under the same name, the source image ID |
| # would identify the exact version of the image that was used. |
| "sourceInstantSnapshot": "A String", # The source instant snapshot used to create this disk. You can provide |
| # this as a partial or full URL to the resource. For example, the following |
| # are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot |
| # - projects/project/zones/zone/instantSnapshots/instantSnapshot |
| # - zones/zone/instantSnapshots/instantSnapshot |
| "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this |
| # disk. This value identifies the exact instant snapshot that was used to |
| # create this persistent disk. For example, if you created the persistent |
| # disk from an instant snapshot that was later deleted and recreated under |
| # the same name, the source instant snapshot ID would identify the exact |
| # version of the instant snapshot that was used. |
| "sourceMachineImage": "A String", # The machine image to create the disk from. You can provide this as a |
| # partial or full URL to the resource. For example, the following are valid |
| # values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/global/machineImages/machineImage |
| # - projects/project/global/machineImages/machineImage |
| # - global/machineImages/machineImage |
| "sourceMachineImageDiskDeviceName": "A String", # Input only. The device name of a disk within a given machine image. The |
| # source_machine_image must be specified. |
| "sourceMachineImageEncryptionKey": { # Thecustomer-supplied |
| # encryption key of the source machine image. Required if the source |
| # machine image is protected by a customer-supplied encryption key. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceMachineImageId": "A String", # [Output Only] The unique ID of the machine image used to create this disk. |
| # This value identifies the exact machine image that was used to create this |
| # persistent disk. For example, if you created the persistent disk from a |
| # machine image that was later deleted and recreated under the same name, the |
| # source machine image ID would identify the exact version of the machine |
| # image that was used. |
| "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a |
| # partial or full URL to the resource. For example, the following are valid |
| # values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot |
| # - projects/project/global/snapshots/snapshot |
| # - global/snapshots/snapshot |
| "sourceSnapshotEncryptionKey": { # Thecustomer-supplied |
| # encryption key of the source snapshot. Required if the source snapshot |
| # is protected by a customer-supplied encryption key. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This |
| # value identifies the exact snapshot that was used to create this persistent |
| # disk. For example, if you created the persistent disk from a snapshot that |
| # was later deleted and recreated under the same name, the source snapshot ID |
| # would identify the exact version of the snapshot that was used. |
| "sourceStorageObject": "A String", # The full Google Cloud Storage URI where the disk image is stored. This file |
| # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual |
| # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or |
| # https://storage.googleapis.com/. This flag is not optimized for creating |
| # multiple disks from a source storage object. To create many disks from a |
| # source storage object, use gcloud compute images |
| # import instead. |
| "status": "A String", # [Output Only] The status of disk creation. |
| # |
| # |
| # - CREATING: Disk is provisioning. |
| # - RESTORING: Source data is being copied into the |
| # disk. |
| # - FAILED: Disk creation failed. |
| # - READY: Disk is ready for use. |
| # - DELETING: Disk is deleting. |
| "storagePool": "A String", # The storage pool in which the new disk is created. You can provide |
| # this as a partial or full URL to the resource. For example, the following |
| # are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool |
| # - projects/project/zones/zone/storagePools/storagePool |
| # - zones/zone/storagePools/storagePool |
| "storageType": "A String", # [Deprecated] Storage type of the persistent disk. |
| "type": "A String", # URL of the disk type resource describing which disk type to use to create |
| # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk |
| # types. |
| "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user |
| # provided licenses can be modified after the disk is created. This includes |
| # a list of URLs to the license resource. For example, to provide a debian |
| # license: |
| # |
| # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch |
| "A String", |
| ], |
| "users": [ # [Output Only] Links to the users of the disk (attached instances) |
| # in form:projects/project/zones/zone/instances/instance |
| "A String", |
| ], |
| "zone": "A String", # [Output Only] URL of the zone where the disk resides. |
| # You must specify this field as part of the HTTP request URL. It is |
| # not settable as a field in the request body. |
| }, |
| ], |
| "kind": "compute#diskList", # [Output Only] Type of resource. Always compute#diskList for |
| # lists of disks. |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for |
| # the query parameter pageToken in the next list request. |
| # Subsequent list requests will have their own nextPageToken to |
| # continue paging through the results. |
| "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| "warning": { # [Output Only] Informational warning message. |
| "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. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="removeResourcePolicies">removeResourcePolicies(project, region, disk, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Removes resource policies from a regional disk. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the region for this request. (required) |
| disk: string, The disk name for this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "resourcePolicies": [ # Resource policies to be removed from this disk. |
| "A String", |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="resize">resize(project, region, disk, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Resizes the specified regional persistent disk. |
| |
| Args: |
| project: string, The project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| disk: string, Name of the regional persistent disk. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "sizeGb": "A String", # The new size of the regional persistent disk, which is specified in GB. |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</code> |
| <pre>Sets the access control policy on the specified resource. |
| Replaces any existing policy. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the region for this request. (required) |
| resource: string, Name or id of the resource for this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. |
| # Deprecated. Use 'policy' to specify bindings. |
| { # Associates `members`, or principals, with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # 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 principals 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). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| }, |
| "members": [ # Specifies the principals requesting access for a Google Cloud 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. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # Does not include identities that come from external identity providers |
| # (IdPs) through identity federation. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `[email protected]` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a Google |
| # service account. For example, |
| # `[email protected]`. |
| # |
| # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An |
| # identifier for a |
| # [Kubernetes service |
| # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). |
| # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `[email protected]`. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| # |
| # |
| # |
| # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: |
| # A single identity in a workforce identity pool. |
| # |
| # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: |
| # All workforce identities in a group. |
| # |
| # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: |
| # All workforce identities with a specific attribute value. |
| # |
| # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: |
| # All identities in a workforce identity pool. |
| # |
| # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: |
| # A single identity in a workload identity pool. |
| # |
| # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: |
| # A workload identity pool group. |
| # |
| # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: |
| # All identities in a workload identity pool with a certain attribute. |
| # |
| # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: |
| # All identities in a workload identity pool. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `[email protected]?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `[email protected]?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `[email protected]?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: |
| # Deleted single identity in a workforce identity pool. For example, |
| # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to the list of `members`, or principals. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| # |
| # For an overview of the IAM roles and permissions, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For |
| # a list of the available pre-defined roles, see |
| # [here](https://cloud.google.com/iam/docs/understanding-roles). |
| }, |
| ], |
| "etag": "A String", # Flatten Policy to create a backward compatible wire-format. |
| # Deprecated. Use 'policy' to specify the etag. |
| "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the 'resource'. The size of |
| # the policy is limited to a few 10s of KB. An empty policy is in general a |
| # valid policy but certain services (like Projects) might reject them. |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members`, or principals, to a single `role`. Principals can be user |
| # accounts, service accounts, Google groups, and domains (such as G Suite). A |
| # `role` is a named list of permissions; each `role` can be an IAM predefined |
| # role or a user-created custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # ``` |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:[email protected]", |
| # "group:[email protected]", |
| # "domain:google.com", |
| # "serviceAccount:[email protected]" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:[email protected]" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # ``` |
| # |
| # **YAML example:** |
| # |
| # ``` |
| # bindings: |
| # - members: |
| # - user:[email protected] |
| # - group:[email protected] |
| # - domain:google.com |
| # - serviceAccount:[email protected] |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:[email protected] |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # etag: BwWWja0YfJA= |
| # version: 3 |
| # ``` |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| { # Specifies the audit configuration for a service. |
| # The configuration determines which permission types are logged, and what |
| # identities, if any, are exempted from logging. |
| # An AuditConfig must have one or more AuditLogConfigs. |
| # |
| # If there are AuditConfigs for both `allServices` and a specific service, |
| # the union of the two AuditConfigs is used for that service: the log_types |
| # specified in each AuditConfig are enabled, and the exempted_members in each |
| # AuditLogConfig are exempted. |
| # |
| # Example Policy with multiple AuditConfigs: |
| # |
| # { |
| # "audit_configs": [ |
| # { |
| # "service": "allServices", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:[email protected]" |
| # ] |
| # }, |
| # { |
| # "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:[email protected]" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts `[email protected]` from DATA_READ logging, and |
| # `[email protected]` from DATA_WRITE logging. |
| "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| { # Provides the configuration for logging a type of permissions. |
| # Example: |
| # |
| # { |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:[email protected]" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # [email protected] from DATA_READ logging. |
| "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| # permission. |
| # Follows the same format of Binding.members. |
| "A String", |
| ], |
| "logType": "A String", # The log type that this config enables. |
| }, |
| ], |
| "service": "A String", # Specifies a service that will be enabled for audit logging. |
| # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| # `allServices` is a special value that covers all services. |
| }, |
| ], |
| "bindings": [ # Associates a list of `members`, or principals, with 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 principal. |
| # |
| # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 |
| # of these principals can be Google groups. Each occurrence of a principal |
| # counts towards these limits. For example, if the `bindings` grant 50 |
| # different roles to `user:[email protected]`, and not to any other |
| # principal, then you can add another 1,450 principals to the `bindings` in |
| # the `Policy`. |
| { # Associates `members`, or principals, with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # 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 principals 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). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| }, |
| "members": [ # Specifies the principals requesting access for a Google Cloud 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. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # Does not include identities that come from external identity providers |
| # (IdPs) through identity federation. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `[email protected]` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a Google |
| # service account. For example, |
| # `[email protected]`. |
| # |
| # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An |
| # identifier for a |
| # [Kubernetes service |
| # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). |
| # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `[email protected]`. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| # |
| # |
| # |
| # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: |
| # A single identity in a workforce identity pool. |
| # |
| # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: |
| # All workforce identities in a group. |
| # |
| # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: |
| # All workforce identities with a specific attribute value. |
| # |
| # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: |
| # All identities in a workforce identity pool. |
| # |
| # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: |
| # A single identity in a workload identity pool. |
| # |
| # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: |
| # A workload identity pool group. |
| # |
| # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: |
| # All identities in a workload identity pool with a certain attribute. |
| # |
| # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: |
| # All identities in a workload identity pool. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `[email protected]?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `[email protected]?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `[email protected]?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: |
| # Deleted single identity in a workforce identity pool. For example, |
| # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to the list of `members`, or principals. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| # |
| # For an overview of the IAM roles and permissions, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For |
| # a list of the available pre-defined roles, see |
| # [here](https://cloud.google.com/iam/docs/understanding-roles). |
| }, |
| ], |
| "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. |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members`, or principals, to a single `role`. Principals can be user |
| # accounts, service accounts, Google groups, and domains (such as G Suite). A |
| # `role` is a named list of permissions; each `role` can be an IAM predefined |
| # role or a user-created custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # ``` |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:[email protected]", |
| # "group:[email protected]", |
| # "domain:google.com", |
| # "serviceAccount:[email protected]" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:[email protected]" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # ``` |
| # |
| # **YAML example:** |
| # |
| # ``` |
| # bindings: |
| # - members: |
| # - user:[email protected] |
| # - group:[email protected] |
| # - domain:google.com |
| # - serviceAccount:[email protected] |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:[email protected] |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # etag: BwWWja0YfJA= |
| # version: 3 |
| # ``` |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| { # Specifies the audit configuration for a service. |
| # The configuration determines which permission types are logged, and what |
| # identities, if any, are exempted from logging. |
| # An AuditConfig must have one or more AuditLogConfigs. |
| # |
| # If there are AuditConfigs for both `allServices` and a specific service, |
| # the union of the two AuditConfigs is used for that service: the log_types |
| # specified in each AuditConfig are enabled, and the exempted_members in each |
| # AuditLogConfig are exempted. |
| # |
| # Example Policy with multiple AuditConfigs: |
| # |
| # { |
| # "audit_configs": [ |
| # { |
| # "service": "allServices", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:[email protected]" |
| # ] |
| # }, |
| # { |
| # "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:[email protected]" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts `[email protected]` from DATA_READ logging, and |
| # `[email protected]` from DATA_WRITE logging. |
| "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| { # Provides the configuration for logging a type of permissions. |
| # Example: |
| # |
| # { |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:[email protected]" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # [email protected] from DATA_READ logging. |
| "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| # permission. |
| # Follows the same format of Binding.members. |
| "A String", |
| ], |
| "logType": "A String", # The log type that this config enables. |
| }, |
| ], |
| "service": "A String", # Specifies a service that will be enabled for audit logging. |
| # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| # `allServices` is a special value that covers all services. |
| }, |
| ], |
| "bindings": [ # Associates a list of `members`, or principals, with 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 principal. |
| # |
| # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 |
| # of these principals can be Google groups. Each occurrence of a principal |
| # counts towards these limits. For example, if the `bindings` grant 50 |
| # different roles to `user:[email protected]`, and not to any other |
| # principal, then you can add another 1,450 principals to the `bindings` in |
| # the `Policy`. |
| { # Associates `members`, or principals, with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # 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 principals 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). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| }, |
| "members": [ # Specifies the principals requesting access for a Google Cloud 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. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # Does not include identities that come from external identity providers |
| # (IdPs) through identity federation. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `[email protected]` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a Google |
| # service account. For example, |
| # `[email protected]`. |
| # |
| # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An |
| # identifier for a |
| # [Kubernetes service |
| # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). |
| # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `[email protected]`. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| # |
| # |
| # |
| # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: |
| # A single identity in a workforce identity pool. |
| # |
| # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: |
| # All workforce identities in a group. |
| # |
| # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: |
| # All workforce identities with a specific attribute value. |
| # |
| # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: |
| # All identities in a workforce identity pool. |
| # |
| # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: |
| # A single identity in a workload identity pool. |
| # |
| # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: |
| # A workload identity pool group. |
| # |
| # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: |
| # All identities in a workload identity pool with a certain attribute. |
| # |
| # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: |
| # All identities in a workload identity pool. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `[email protected]?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `[email protected]?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `[email protected]?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: |
| # Deleted single identity in a workforce identity pool. For example, |
| # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to the list of `members`, or principals. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| # |
| # For an overview of the IAM roles and permissions, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For |
| # a list of the available pre-defined roles, see |
| # [here](https://cloud.google.com/iam/docs/understanding-roles). |
| }, |
| ], |
| "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. |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Sets the labels on the target regional disk. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The region for this request. (required) |
| resource: string, Name or id of the resource for this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, |
| # used to detect conflicts. The fingerprint is initially generated by Compute |
| # Engine and changes after every request to modify or update labels. You must |
| # always provide an up-to-date fingerprint hash in order to update or change |
| # labels. Make a get() request to the resource to get the latest |
| # fingerprint. |
| "labels": { # The labels to set for this resource. |
| "a_key": "A String", |
| }, |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="startAsyncReplication">startAsyncReplication(project, region, disk, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Starts asynchronous replication. |
| Must be invoked on the primary disk. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the region for this request. (required) |
| disk: string, The name of the persistent disk. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "asyncSecondaryDisk": "A String", # The secondary disk to start asynchronous replication to. |
| # You can provide this as a partial or full URL to the resource. For example, |
| # the following are valid values: |
| # |
| # |
| # - |
| # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk |
| # |
| # - |
| # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk |
| # |
| # - |
| # projects/project/zones/zone/disks/disk |
| # |
| # - |
| # projects/project/regions/region/disks/disk |
| # |
| # - |
| # zones/zone/disks/disk |
| # |
| # - |
| # regions/region/disks/disk |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="stopAsyncReplication">stopAsyncReplication(project, region, disk, requestId=None, x__xgafv=None)</code> |
| <pre>Stops asynchronous replication. |
| Can be invoked either on the primary or on the secondary disk. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the region for this request. (required) |
| disk: string, The name of the persistent disk. (required) |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="stopGroupAsyncReplication">stopGroupAsyncReplication(project, region, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Stops asynchronous replication for a consistency group of disks. |
| Can be invoked either in the primary or secondary scope. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the region for this request. This must be the region of the |
| primary or secondary disks in the consistency group. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A transient resource used in compute.disks.stopGroupAsyncReplication and |
| # compute.regionDisks.stopGroupAsyncReplication. It is only used to process |
| # requests and is not persisted. |
| "resourcePolicy": "A String", # The URL of the DiskConsistencyGroupPolicy for the group of disks to stop. |
| # This may be a full or partial URL, such as: |
| # |
| # |
| # - |
| # https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy |
| # |
| # - |
| # projects/project/regions/region/resourcePolicies/resourcePolicy |
| # |
| # - |
| # regions/region/resourcePolicies/resourcePolicy |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code> |
| <pre>Returns permissions that a caller has on the specified resource. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the region for this request. (required) |
| resource: string, Name or id of the resource for this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "permissions": [ # The set of permissions to check for the 'resource'. Permissions with |
| # wildcards (such as '*' or 'storage.*') are not allowed. |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| # allowed. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(project, region, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Update the specified disk with the data included in the request. Update is |
| performed only on selected fields included as part of update-mask. Only the |
| following fields can be modified: user_license. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the region for this request. (required) |
| disk: string, The disk name for this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a Persistent Disk resource. |
| # |
| # Google Compute Engine has two Disk resources: |
| # |
| # * [Zonal](/compute/docs/reference/rest/alpha/disks) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionDisks) |
| # |
| # Persistent disks are required for running your VM instances. |
| # Create both boot and non-boot (data) persistent disks. For more information, |
| # read Persistent Disks. For more |
| # storage options, read Storage options. |
| # |
| # The disks resource represents a zonal persistent disk. |
| # For more information, readZonal persistent disks. |
| # |
| # The regionDisks resource represents a |
| # regional persistent disk. For more information, read |
| # Regional resources. |
| "accessMode": "A String", # The access mode of the disk. |
| # |
| # |
| # - READ_WRITE_SINGLE: The default AccessMode, means the |
| # disk can be attached to single instance in RW mode. |
| # - READ_WRITE_MANY: The AccessMode means the disk can be |
| # attached to multiple instances in RW mode. |
| # - READ_ONLY_MANY: The AccessMode means the disk can be |
| # attached to multiple instances in RO mode. |
| # |
| # |
| # The AccessMode is only valid for Hyperdisk disk types. |
| "architecture": "A String", # The architecture of the disk. Valid values are |
| # ARM64 or X86_64. |
| "asyncPrimaryDisk": { # Disk asynchronously replicated into this disk. |
| "consistencyGroupPolicy": "A String", # [Output Only] URL of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "consistencyGroupPolicyId": "A String", # [Output Only] ID of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "disk": "A String", # The other disk asynchronously replicated to or from the current disk. |
| # You can provide this as a partial or full URL to the resource. |
| # For example, the following are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk |
| # - projects/project/zones/zone/disks/disk |
| # - zones/zone/disks/disk |
| "diskId": "A String", # [Output Only] The unique ID of the other disk asynchronously replicated |
| # to or from the current disk. This value identifies the exact disk that |
| # was used to create this replication. For example, if you started |
| # replicating the persistent disk from a disk that was later deleted and |
| # recreated under the same name, the disk ID would identify the exact |
| # version of the disk that was used. |
| }, |
| "asyncSecondaryDisks": { # [Output Only] A list of disks this disk is asynchronously replicated to. |
| "a_key": { |
| "asyncReplicationDisk": { |
| "consistencyGroupPolicy": "A String", # [Output Only] URL of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "consistencyGroupPolicyId": "A String", # [Output Only] ID of the DiskConsistencyGroupPolicy if replication was |
| # started on the disk as a member of a group. |
| "disk": "A String", # The other disk asynchronously replicated to or from the current disk. |
| # You can provide this as a partial or full URL to the resource. |
| # For example, the following are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk |
| # - projects/project/zones/zone/disks/disk |
| # - zones/zone/disks/disk |
| "diskId": "A String", # [Output Only] The unique ID of the other disk asynchronously replicated |
| # to or from the current disk. This value identifies the exact disk that |
| # was used to create this replication. For example, if you started |
| # replicating the persistent disk from a disk that was later deleted and |
| # recreated under the same name, the disk ID would identify the exact |
| # version of the disk that was used. |
| }, |
| }, |
| }, |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "description": "A String", # An optional description of this resource. Provide this property when you |
| # create the resource. |
| "diskEncryptionKey": { # Encrypts the disk using a |
| # customer-supplied encryption key or a |
| # customer-managed encryption key. |
| # |
| # Encryption keys do not protect access to metadata of the disk. |
| # |
| # After you encrypt a disk with a customer-supplied key, you must provide the |
| # same key if you use the disk later. For example, to create a disk snapshot, |
| # to create a disk image, to create a machine image, or to attach the disk to |
| # a virtual machine. |
| # |
| # After you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version* |
| # name once the disk is created. The disk is encrypted with this version of |
| # the key. In the response, diskEncryptionKey.kmsKeyName appears |
| # in the following format: |
| # |
| # "diskEncryptionKey.kmsKeyName": |
| # "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeysVersions/version |
| # |
| # If you do not provide an encryption key when creating the disk, then the |
| # disk is encrypted using an automatically generated key and you don't need |
| # to provide a key to use the disk later. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. |
| "eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase |
| # Windows specific VSS signature. |
| "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable |
| # only for bootable images. Read |
| # Enabling guest operating system features to see a list of available |
| # options. |
| { # Guest OS features. |
| "type": "A String", # The ID of a supported feature. To add multiple values, use commas to |
| # separate values. Set to one or more of the following values: |
| # |
| # - VIRTIO_SCSI_MULTIQUEUE |
| # - WINDOWS |
| # - MULTI_IP_SUBNET |
| # - UEFI_COMPATIBLE |
| # - GVNIC |
| # - SEV_CAPABLE |
| # - SUSPEND_RESUME_COMPATIBLE |
| # - SEV_LIVE_MIGRATABLE_V2 |
| # - SEV_SNP_CAPABLE |
| # - TDX_CAPABLE |
| # - IDPF |
| # - SNP_SVSM_CAPABLE |
| # |
| # |
| # For more information, see |
| # Enabling guest operating system features. |
| }, |
| ], |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk, |
| # which is either SCSI or NVME. The default isSCSI. |
| "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for |
| # disks. |
| "labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is |
| # essentially a hash of the labels set used for optimistic locking. The |
| # fingerprint is initially generated by Compute Engine and changes after |
| # every request to modify or update labels. You must always provide an |
| # up-to-date fingerprint hash in order to update or change labels, |
| # otherwise the request will fail with error412 conditionNotMet. |
| # |
| # To see the latest fingerprint, make a get() request to |
| # retrieve a disk. |
| "labels": { # Labels to apply to this disk. These can be later modified by |
| # the setLabels method. |
| "a_key": "A String", |
| }, |
| "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp inRFC3339 |
| # text format. |
| "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp inRFC3339 |
| # text format. |
| "licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk. |
| "A String", |
| ], |
| "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. |
| "A String", |
| ], |
| "locationHint": "A String", # An opaque location hint used to place the disk close to other resources. |
| # This field is for use by internal tools that use the public API. |
| "locked": True or False, # [Output Only] The field indicates if the disk is created from a locked |
| # source image. Attachment of a disk created from a locked source image will |
| # cause the following operations to become irreversibly prohibited: |
| # |
| # - R/W or R/O disk attachment to any other instance |
| # - Disk detachment. And the disk can only be deleted when the instance |
| # is deleted |
| # - Creation of images or snapshots |
| # - Disk cloning |
| # |
| # |
| # |
| # Furthermore, the instance with at least one disk with locked flag set to |
| # true will be prohibited from performing the operations below: |
| # |
| # - Further attachment of secondary disks. |
| # - Detachment of any disks |
| # - Create machine images |
| # - Create instance template |
| # - Delete the instance with --keep-disk parameter set to true for locked |
| # disks |
| # - Attach a locked disk with --auto-delete parameter set to false |
| "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to |
| # more than one instance. |
| "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 withRFC1035. |
| # 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. |
| "options": "A String", # Internal use only. |
| "params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values |
| # have the same definition as resource |
| # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and |
| # values are in the format `tagValues/456`. The field is ignored (both PUT & |
| # PATCH) when empty. |
| "a_key": "A String", |
| }, |
| }, |
| "physicalBlockSizeBytes": "A String", # Physical block size of the persistent disk, in bytes. |
| # If not present in a request, a default value is used. |
| # The currently supported size is 4096, other sizes may be added in |
| # the future. |
| # If an unsupported value is requested, the error message will list |
| # the supported values for the caller's project. |
| "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number |
| # of I/O operations per second that the disk can handle. Values must be |
| # between 10,000 and 120,000. For more details, see theExtreme persistent |
| # disk documentation. |
| "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the |
| # number of throughput mb per second that the disk can handle. Values must be |
| # greater than or equal to 1. |
| "region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for |
| # regional resources. |
| # You must specify this field as part of the HTTP request URL. It is |
| # not settable as a field in the request body. |
| "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable |
| # for regional resources. |
| "A String", |
| ], |
| "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. |
| "A String", |
| ], |
| "resourceStatus": { # [Output Only] Status information for the disk resource. |
| "asyncPrimaryDisk": { |
| "state": "A String", |
| }, |
| "asyncSecondaryDisks": { # Key: disk, value: AsyncReplicationStatus message |
| "a_key": { |
| "state": "A String", |
| }, |
| }, |
| "usedBytes": "A String", # [Output Only] Space used by data stored in the disk (in bytes). Note that |
| # this field is set only when the disk is in a storage pool. |
| }, |
| "satisfiesPzi": True or False, # Output only. Reserved for future use. |
| "satisfiesPzs": True or False, # [Output Only] Reserved for future use. |
| "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id. |
| "sizeGb": "A String", # Size, in GB, of the persistent disk. You can specify |
| # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty |
| # persistent disk. |
| # |
| # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the |
| # source. |
| # Acceptable values are greater than 0. |
| "sourceConsistencyGroupPolicy": "A String", # [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk |
| # that was created using a consistency group. |
| "sourceConsistencyGroupPolicyId": "A String", # [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk |
| # that was created using a consistency group. |
| "sourceDisk": "A String", # The source disk used to create this disk. You can provide this as a |
| # partial or full URL to the resource. For example, the following are valid |
| # values: |
| # |
| # |
| # - |
| # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk |
| # |
| # - |
| # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk |
| # |
| # - |
| # projects/project/zones/zone/disks/disk |
| # |
| # - |
| # projects/project/regions/region/disks/disk |
| # |
| # - |
| # zones/zone/disks/disk |
| # |
| # - |
| # regions/region/disks/disk |
| "sourceDiskId": "A String", # [Output Only] The unique ID of the disk used to create this disk. This |
| # value identifies the exact disk that was used to create this persistent |
| # disk. For example, if you created the persistent disk from a disk that |
| # was later deleted and recreated under the same name, the source disk ID |
| # would identify the exact version of the disk that was used. |
| "sourceImage": "A String", # The source image used to create this disk. If the source image is |
| # deleted, this field will not be set. |
| # |
| # To create a disk with one of the public operating system images, specify |
| # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image: |
| # |
| # projects/debian-cloud/global/images/family/debian-9 |
| # |
| # |
| # Alternatively, use a specific version of a public operating system image: |
| # |
| # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD |
| # |
| # |
| # To create a disk with a custom image that you created, specify the |
| # image name in the following format: |
| # |
| # global/images/my-custom-image |
| # |
| # |
| # You can also specify a custom image by its image family, which returns |
| # the latest version of the image in that family. Replace the image name |
| # with family/family-name: |
| # |
| # global/images/family/my-image-family |
| "sourceImageEncryptionKey": { # Thecustomer-supplied |
| # encryption key of the source image. Required if the source image is |
| # protected by a customer-supplied encryption key. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This |
| # value identifies the exact image that was used to create this persistent |
| # disk. For example, if you created the persistent disk from an image that |
| # was later deleted and recreated under the same name, the source image ID |
| # would identify the exact version of the image that was used. |
| "sourceInstantSnapshot": "A String", # The source instant snapshot used to create this disk. You can provide |
| # this as a partial or full URL to the resource. For example, the following |
| # are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot |
| # - projects/project/zones/zone/instantSnapshots/instantSnapshot |
| # - zones/zone/instantSnapshots/instantSnapshot |
| "sourceInstantSnapshotId": "A String", # [Output Only] The unique ID of the instant snapshot used to create this |
| # disk. This value identifies the exact instant snapshot that was used to |
| # create this persistent disk. For example, if you created the persistent |
| # disk from an instant snapshot that was later deleted and recreated under |
| # the same name, the source instant snapshot ID would identify the exact |
| # version of the instant snapshot that was used. |
| "sourceMachineImage": "A String", # The machine image to create the disk from. You can provide this as a |
| # partial or full URL to the resource. For example, the following are valid |
| # values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/global/machineImages/machineImage |
| # - projects/project/global/machineImages/machineImage |
| # - global/machineImages/machineImage |
| "sourceMachineImageDiskDeviceName": "A String", # Input only. The device name of a disk within a given machine image. The |
| # source_machine_image must be specified. |
| "sourceMachineImageEncryptionKey": { # Thecustomer-supplied |
| # encryption key of the source machine image. Required if the source |
| # machine image is protected by a customer-supplied encryption key. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceMachineImageId": "A String", # [Output Only] The unique ID of the machine image used to create this disk. |
| # This value identifies the exact machine image that was used to create this |
| # persistent disk. For example, if you created the persistent disk from a |
| # machine image that was later deleted and recreated under the same name, the |
| # source machine image ID would identify the exact version of the machine |
| # image that was used. |
| "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a |
| # partial or full URL to the resource. For example, the following are valid |
| # values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot |
| # - projects/project/global/snapshots/snapshot |
| # - global/snapshots/snapshot |
| "sourceSnapshotEncryptionKey": { # Thecustomer-supplied |
| # encryption key of the source snapshot. Required if the source snapshot |
| # is protected by a customer-supplied encryption key. |
| "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| # For example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # |
| # The fully-qualifed key name may be returned for resource GET requests. For |
| # example: |
| # |
| # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ |
| # key_region/cryptoKeys/key |
| # /cryptoKeyVersions/1 |
| "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS |
| # key. If absent, the Compute Engine default service account is used. |
| # For example: |
| # |
| # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ |
| "rawKey": "A String", # Specifies a 256-bit customer-supplied |
| # encryption key, encoded in RFC |
| # 4648 base64 to either encrypt or decrypt this resource. You can |
| # provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rawKey": |
| # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
| "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit |
| # customer-supplied encryption key to either encrypt or decrypt this |
| # resource. You can provide either the rawKey or thersaEncryptedKey. |
| # For example: |
| # |
| # "rsaEncryptedKey": |
| # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH |
| # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD |
| # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" |
| # |
| # The key must meet the following requirements before you can provide it to |
| # Compute Engine: |
| # |
| # 1. The key is wrapped using a RSA public key certificate provided by |
| # Google. |
| # 2. After being wrapped, the key must be encoded in RFC 4648 base64 |
| # encoding. |
| # |
| # Gets the RSA public key certificate provided by Google at: |
| # |
| # |
| # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
| "sha256": "A String", # [Output only] TheRFC |
| # 4648 base64 encoded SHA-256 hash of the customer-supplied |
| # encryption key that protects this resource. |
| }, |
| "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This |
| # value identifies the exact snapshot that was used to create this persistent |
| # disk. For example, if you created the persistent disk from a snapshot that |
| # was later deleted and recreated under the same name, the source snapshot ID |
| # would identify the exact version of the snapshot that was used. |
| "sourceStorageObject": "A String", # The full Google Cloud Storage URI where the disk image is stored. This file |
| # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual |
| # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or |
| # https://storage.googleapis.com/. This flag is not optimized for creating |
| # multiple disks from a source storage object. To create many disks from a |
| # source storage object, use gcloud compute images |
| # import instead. |
| "status": "A String", # [Output Only] The status of disk creation. |
| # |
| # |
| # - CREATING: Disk is provisioning. |
| # - RESTORING: Source data is being copied into the |
| # disk. |
| # - FAILED: Disk creation failed. |
| # - READY: Disk is ready for use. |
| # - DELETING: Disk is deleting. |
| "storagePool": "A String", # The storage pool in which the new disk is created. You can provide |
| # this as a partial or full URL to the resource. For example, the following |
| # are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool |
| # - projects/project/zones/zone/storagePools/storagePool |
| # - zones/zone/storagePools/storagePool |
| "storageType": "A String", # [Deprecated] Storage type of the persistent disk. |
| "type": "A String", # URL of the disk type resource describing which disk type to use to create |
| # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk |
| # types. |
| "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user |
| # provided licenses can be modified after the disk is created. This includes |
| # a list of URLs to the license resource. For example, to provide a debian |
| # license: |
| # |
| # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch |
| "A String", |
| ], |
| "users": [ # [Output Only] Links to the users of the disk (attached instances) |
| # in form:projects/project/zones/zone/instances/instance |
| "A String", |
| ], |
| "zone": "A String", # [Output Only] URL of the zone where the disk resides. |
| # You must specify this field as part of the HTTP request URL. It is |
| # not settable as a field in the request body. |
| } |
| |
| paths: string, A parameter (repeated) |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| updateMask: string, update_mask indicates fields to be updated as part of this request. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="updateKmsKey">updateKmsKey(project, region, disk, requestId=None, x__xgafv=None)</code> |
| <pre>Rotates the customer-managed |
| encryption key to the latest version for the specified persistent disk. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, The name of the region for this request. (required) |
| disk: string, Name of the Disk resource, should conform to RFC1035. (required) |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="waitForReplicationCatchUp">waitForReplicationCatchUp(project, region, disk, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Wait for replication to catch up on the secondary disk. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| region: string, Name of the region for this request. (required) |
| disk: string, The name of the persistent disk. |
| Name should conform to RFC1035 or be an unsigned long integer. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "maxWaitDuration": "A String", |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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. |
| }</pre> |
| </div> |
| |
| </body></html> |
