1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.disks.html">disks</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 79 <p class="firstline">Retrieves an aggregated list of persistent disks.</p> 80 <p class="toc_element"> 81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 82 <p class="firstline">Retrieves the next page of results.</p> 83 <p class="toc_element"> 84 <code><a href="#createSnapshot">createSnapshot(project, zone, disk, body, guestFlush=None)</a></code></p> 85 <p class="firstline">Creates a snapshot of a specified persistent disk.</p> 86 <p class="toc_element"> 87 <code><a href="#delete">delete(project, zone, disk)</a></code></p> 88 <p class="firstline">Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.</p> 89 <p class="toc_element"> 90 <code><a href="#get">get(project, zone, disk)</a></code></p> 91 <p class="firstline">Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.</p> 92 <p class="toc_element"> 93 <code><a href="#insert">insert(project, zone, body, sourceImage=None)</a></code></p> 94 <p class="firstline">Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.</p> 95 <p class="toc_element"> 96 <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 97 <p class="firstline">Retrieves a list of persistent disks contained within the specified zone.</p> 98 <p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100 <p class="firstline">Retrieves the next page of results.</p> 101 <p class="toc_element"> 102 <code><a href="#resize">resize(project, zone, disk, body)</a></code></p> 103 <p class="firstline">Resizes the specified persistent disk.</p> 104 <p class="toc_element"> 105 <code><a href="#setLabels">setLabels(project, zone, resource, body)</a></code></p> 106 <p class="firstline">Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.</p> 107 <p class="toc_element"> 108 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p> 109 <p class="firstline">Returns permissions that a caller has on the specified resource.</p> 110 <h3>Method Details</h3> 111 <div class="method"> 112 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 113 <pre>Retrieves an aggregated list of persistent disks. 114 115 Args: 116 project: string, Project ID for this request. (required) 117 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 118 119 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. 120 121 Currently, only sorting by name or creationTimestamp desc is supported. 122 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) 123 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. 124 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 125 126 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 127 128 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 129 130 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 131 132 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 133 134 Returns: 135 An object of the form: 136 137 { 138 "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 than maxResults, 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. Acceptable values are 0 to 500, inclusive. (Default: 500) 139 "items": { # [Output Only] A map of scoped disk lists. 140 "a_key": { # [Output Only] Name of the scope containing this set of disks. 141 "disks": [ # [Output Only] List of disks contained in this scope. 142 { # A Disk resource. 143 "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 144 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 145 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 146 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 147 # 148 # The key must meet the following requirements before you can provide it to Compute Engine: 149 # - The key is wrapped using a RSA public key certificate provided by Google. 150 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 151 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 152 }, 153 "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. 154 "a_key": "A String", 155 }, 156 "licenses": [ # Any applicable publicly visible licenses. 157 "A String", 158 ], 159 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 160 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 161 "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance 162 "A String", 163 ], 164 "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key. 165 # 166 # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). 167 # 168 # Customer-supplied encryption keys do not protect access to metadata of the disk. 169 # 170 # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. 171 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 172 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 173 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 174 # 175 # The key must meet the following requirements before you can provide it to Compute Engine: 176 # - The key is wrapped using a RSA public key certificate provided by Google. 177 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 178 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 179 }, 180 "zone": "A String", # [Output Only] URL of the zone where the disk resides. 181 "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format. 182 "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. 183 "status": "A String", # [Output Only] The status of disk creation. 184 "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: 185 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot 186 # - projects/project/global/snapshots/snapshot 187 # - global/snapshots/snapshot 188 "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format. 189 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 190 "storageType": "A String", # [Deprecated] Storage type of the persistent disk. 191 "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. 192 # 193 # To see the latest fingerprint, make a get() request to retrieve a disk. 194 "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. 195 "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set. 196 # 197 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image: 198 # 199 # projects/debian-cloud/global/images/family/debian-8 200 # 201 # Alternatively, use a specific version of a public operating system image: 202 # 203 # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD 204 # 205 # To create a disk with a private image that you created, specify the image name in the following format: 206 # 207 # global/images/my-private-image 208 # 209 # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: 210 # 211 # global/images/family/my-private-family 212 "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. 213 "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks. 214 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 215 "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. 216 # 217 # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. 218 "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. 219 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 220 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 221 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 222 # 223 # The key must meet the following requirements before you can provide it to Compute Engine: 224 # - The key is wrapped using a RSA public key certificate provided by Google. 225 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 226 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 227 }, 228 "options": "A String", # Internal use only. 229 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 230 }, 231 ], 232 "warning": { # [Output Only] Informational warning which replaces the list of disks when the list is empty. 233 "message": "A String", # [Output Only] A human-readable description of the warning code. 234 "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. 235 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 236 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 237 { 238 "value": "A String", # [Output Only] A warning data value corresponding to the key. 239 "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). 240 }, 241 ], 242 }, 243 }, 244 }, 245 "kind": "compute#diskAggregatedList", # [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks. 246 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 247 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 248 }</pre> 249 </div> 250 251 <div class="method"> 252 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 253 <pre>Retrieves the next page of results. 254 255 Args: 256 previous_request: The request for the previous page. (required) 257 previous_response: The response from the request for the previous page. (required) 258 259 Returns: 260 A request object that you can call 'execute()' on to request the next 261 page. Returns None if there are no more items in the collection. 262 </pre> 263 </div> 264 265 <div class="method"> 266 <code class="details" id="createSnapshot">createSnapshot(project, zone, disk, body, guestFlush=None)</code> 267 <pre>Creates a snapshot of a specified persistent disk. 268 269 Args: 270 project: string, Project ID for this request. (required) 271 zone: string, The name of the zone for this request. (required) 272 disk: string, Name of the persistent disk to snapshot. (required) 273 body: object, The request body. (required) 274 The object takes the form of: 275 276 { # A persistent disk snapshot resource. 277 "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. 278 "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. 279 "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. 280 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 281 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 282 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 283 # 284 # The key must meet the following requirements before you can provide it to Compute Engine: 285 # - The key is wrapped using a RSA public key certificate provided by Google. 286 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 287 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 288 }, 289 "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. 290 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 291 "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot. 292 "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key. 293 # 294 # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. 295 # 296 # Customer-supplied encryption keys do not protect access to metadata of the disk. 297 # 298 # 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. 299 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 300 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 301 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 302 # 303 # The key must meet the following requirements before you can provide it to Compute Engine: 304 # - The key is wrapped using a RSA public key certificate provided by Google. 305 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 306 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 307 }, 308 "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. 309 "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. 310 # 311 # To see the latest fingerprint, make a get() request to retrieve a snapshot. 312 "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. 313 "a_key": "A String", 314 }, 315 "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. 316 "diskSizeGb": "A String", # [Output Only] Size of the snapshot, specified in GB. 317 "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). 318 "A String", 319 ], 320 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 321 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 322 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 323 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 324 } 325 326 guestFlush: boolean, A parameter 327 328 Returns: 329 An object of the form: 330 331 { # An Operation resource, used to manage asynchronous API requests. 332 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 333 "clientOperationId": "A String", # [Output Only] Reserved for future use. 334 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 335 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 336 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 337 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 338 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 339 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 340 "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. 341 "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. 342 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 343 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 344 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 345 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 346 { 347 "message": "A String", # [Output Only] A human-readable description of the warning code. 348 "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. 349 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 350 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 351 { 352 "value": "A String", # [Output Only] A warning data value corresponding to the key. 353 "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). 354 }, 355 ], 356 }, 357 ], 358 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 359 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 360 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 361 "name": "A String", # [Output Only] Name of the resource. 362 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 363 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 364 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 365 { 366 "message": "A String", # [Output Only] An optional, human-readable error message. 367 "code": "A String", # [Output Only] The error type identifier for this error. 368 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 369 }, 370 ], 371 }, 372 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 373 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 374 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 375 }</pre> 376 </div> 377 378 <div class="method"> 379 <code class="details" id="delete">delete(project, zone, disk)</code> 380 <pre>Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. 381 382 Args: 383 project: string, Project ID for this request. (required) 384 zone: string, The name of the zone for this request. (required) 385 disk: string, Name of the persistent disk to delete. (required) 386 387 Returns: 388 An object of the form: 389 390 { # An Operation resource, used to manage asynchronous API requests. 391 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 392 "clientOperationId": "A String", # [Output Only] Reserved for future use. 393 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 394 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 395 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 396 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 397 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 398 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 399 "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. 400 "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. 401 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 402 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 403 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 404 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 405 { 406 "message": "A String", # [Output Only] A human-readable description of the warning code. 407 "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. 408 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 409 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 410 { 411 "value": "A String", # [Output Only] A warning data value corresponding to the key. 412 "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). 413 }, 414 ], 415 }, 416 ], 417 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 418 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 419 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 420 "name": "A String", # [Output Only] Name of the resource. 421 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 422 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 423 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 424 { 425 "message": "A String", # [Output Only] An optional, human-readable error message. 426 "code": "A String", # [Output Only] The error type identifier for this error. 427 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 428 }, 429 ], 430 }, 431 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 432 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 433 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 434 }</pre> 435 </div> 436 437 <div class="method"> 438 <code class="details" id="get">get(project, zone, disk)</code> 439 <pre>Returns a specified persistent disk. Get a list of available persistent disks by making a list() request. 440 441 Args: 442 project: string, Project ID for this request. (required) 443 zone: string, The name of the zone for this request. (required) 444 disk: string, Name of the persistent disk to return. (required) 445 446 Returns: 447 An object of the form: 448 449 { # A Disk resource. 450 "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 451 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 452 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 453 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 454 # 455 # The key must meet the following requirements before you can provide it to Compute Engine: 456 # - The key is wrapped using a RSA public key certificate provided by Google. 457 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 458 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 459 }, 460 "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. 461 "a_key": "A String", 462 }, 463 "licenses": [ # Any applicable publicly visible licenses. 464 "A String", 465 ], 466 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 467 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 468 "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance 469 "A String", 470 ], 471 "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key. 472 # 473 # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). 474 # 475 # Customer-supplied encryption keys do not protect access to metadata of the disk. 476 # 477 # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. 478 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 479 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 480 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 481 # 482 # The key must meet the following requirements before you can provide it to Compute Engine: 483 # - The key is wrapped using a RSA public key certificate provided by Google. 484 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 485 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 486 }, 487 "zone": "A String", # [Output Only] URL of the zone where the disk resides. 488 "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format. 489 "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. 490 "status": "A String", # [Output Only] The status of disk creation. 491 "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: 492 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot 493 # - projects/project/global/snapshots/snapshot 494 # - global/snapshots/snapshot 495 "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format. 496 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 497 "storageType": "A String", # [Deprecated] Storage type of the persistent disk. 498 "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. 499 # 500 # To see the latest fingerprint, make a get() request to retrieve a disk. 501 "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. 502 "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set. 503 # 504 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image: 505 # 506 # projects/debian-cloud/global/images/family/debian-8 507 # 508 # Alternatively, use a specific version of a public operating system image: 509 # 510 # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD 511 # 512 # To create a disk with a private image that you created, specify the image name in the following format: 513 # 514 # global/images/my-private-image 515 # 516 # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: 517 # 518 # global/images/family/my-private-family 519 "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. 520 "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks. 521 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 522 "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. 523 # 524 # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. 525 "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. 526 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 527 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 528 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 529 # 530 # The key must meet the following requirements before you can provide it to Compute Engine: 531 # - The key is wrapped using a RSA public key certificate provided by Google. 532 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 533 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 534 }, 535 "options": "A String", # Internal use only. 536 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 537 }</pre> 538 </div> 539 540 <div class="method"> 541 <code class="details" id="insert">insert(project, zone, body, sourceImage=None)</code> 542 <pre>Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. 543 544 Args: 545 project: string, Project ID for this request. (required) 546 zone: string, The name of the zone for this request. (required) 547 body: object, The request body. (required) 548 The object takes the form of: 549 550 { # A Disk resource. 551 "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 552 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 553 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 554 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 555 # 556 # The key must meet the following requirements before you can provide it to Compute Engine: 557 # - The key is wrapped using a RSA public key certificate provided by Google. 558 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 559 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 560 }, 561 "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. 562 "a_key": "A String", 563 }, 564 "licenses": [ # Any applicable publicly visible licenses. 565 "A String", 566 ], 567 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 568 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 569 "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance 570 "A String", 571 ], 572 "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key. 573 # 574 # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). 575 # 576 # Customer-supplied encryption keys do not protect access to metadata of the disk. 577 # 578 # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. 579 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 580 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 581 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 582 # 583 # The key must meet the following requirements before you can provide it to Compute Engine: 584 # - The key is wrapped using a RSA public key certificate provided by Google. 585 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 586 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 587 }, 588 "zone": "A String", # [Output Only] URL of the zone where the disk resides. 589 "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format. 590 "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. 591 "status": "A String", # [Output Only] The status of disk creation. 592 "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: 593 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot 594 # - projects/project/global/snapshots/snapshot 595 # - global/snapshots/snapshot 596 "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format. 597 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 598 "storageType": "A String", # [Deprecated] Storage type of the persistent disk. 599 "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. 600 # 601 # To see the latest fingerprint, make a get() request to retrieve a disk. 602 "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. 603 "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set. 604 # 605 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image: 606 # 607 # projects/debian-cloud/global/images/family/debian-8 608 # 609 # Alternatively, use a specific version of a public operating system image: 610 # 611 # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD 612 # 613 # To create a disk with a private image that you created, specify the image name in the following format: 614 # 615 # global/images/my-private-image 616 # 617 # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: 618 # 619 # global/images/family/my-private-family 620 "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. 621 "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks. 622 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 623 "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. 624 # 625 # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. 626 "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. 627 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 628 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 629 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 630 # 631 # The key must meet the following requirements before you can provide it to Compute Engine: 632 # - The key is wrapped using a RSA public key certificate provided by Google. 633 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 634 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 635 }, 636 "options": "A String", # Internal use only. 637 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 638 } 639 640 sourceImage: string, Optional. Source image to restore onto a disk. 641 642 Returns: 643 An object of the form: 644 645 { # An Operation resource, used to manage asynchronous API requests. 646 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 647 "clientOperationId": "A String", # [Output Only] Reserved for future use. 648 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 649 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 650 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 651 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 652 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 653 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 654 "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. 655 "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. 656 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 657 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 658 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 659 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 660 { 661 "message": "A String", # [Output Only] A human-readable description of the warning code. 662 "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. 663 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 664 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 665 { 666 "value": "A String", # [Output Only] A warning data value corresponding to the key. 667 "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). 668 }, 669 ], 670 }, 671 ], 672 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 673 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 674 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 675 "name": "A String", # [Output Only] Name of the resource. 676 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 677 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 678 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 679 { 680 "message": "A String", # [Output Only] An optional, human-readable error message. 681 "code": "A String", # [Output Only] The error type identifier for this error. 682 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 683 }, 684 ], 685 }, 686 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 687 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 688 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 689 }</pre> 690 </div> 691 692 <div class="method"> 693 <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 694 <pre>Retrieves a list of persistent disks contained within the specified zone. 695 696 Args: 697 project: string, Project ID for this request. (required) 698 zone: string, The name of the zone for this request. (required) 699 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 700 701 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. 702 703 Currently, only sorting by name or creationTimestamp desc is supported. 704 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) 705 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. 706 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 707 708 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 709 710 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 711 712 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 713 714 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 715 716 Returns: 717 An object of the form: 718 719 { # A list of Disk resources. 720 "nextPageToken": "A String", # This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, 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. 721 "items": [ # A list of Disk resources. 722 { # A Disk resource. 723 "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 724 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 725 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 726 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 727 # 728 # The key must meet the following requirements before you can provide it to Compute Engine: 729 # - The key is wrapped using a RSA public key certificate provided by Google. 730 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 731 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 732 }, 733 "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. 734 "a_key": "A String", 735 }, 736 "licenses": [ # Any applicable publicly visible licenses. 737 "A String", 738 ], 739 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 740 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 741 "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance 742 "A String", 743 ], 744 "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key. 745 # 746 # After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). 747 # 748 # Customer-supplied encryption keys do not protect access to metadata of the disk. 749 # 750 # If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. 751 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 752 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 753 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 754 # 755 # The key must meet the following requirements before you can provide it to Compute Engine: 756 # - The key is wrapped using a RSA public key certificate provided by Google. 757 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 758 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 759 }, 760 "zone": "A String", # [Output Only] URL of the zone where the disk resides. 761 "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format. 762 "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. 763 "status": "A String", # [Output Only] The status of disk creation. 764 "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: 765 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot 766 # - projects/project/global/snapshots/snapshot 767 # - global/snapshots/snapshot 768 "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format. 769 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 770 "storageType": "A String", # [Deprecated] Storage type of the persistent disk. 771 "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. 772 # 773 # To see the latest fingerprint, make a get() request to retrieve a disk. 774 "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. 775 "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set. 776 # 777 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image: 778 # 779 # projects/debian-cloud/global/images/family/debian-8 780 # 781 # Alternatively, use a specific version of a public operating system image: 782 # 783 # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD 784 # 785 # To create a disk with a private image that you created, specify the image name in the following format: 786 # 787 # global/images/my-private-image 788 # 789 # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: 790 # 791 # global/images/family/my-private-family 792 "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. 793 "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks. 794 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 795 "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. 796 # 797 # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. 798 "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. 799 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 800 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 801 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 802 # 803 # The key must meet the following requirements before you can provide it to Compute Engine: 804 # - The key is wrapped using a RSA public key certificate provided by Google. 805 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 806 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 807 }, 808 "options": "A String", # Internal use only. 809 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 810 }, 811 ], 812 "kind": "compute#diskList", # [Output Only] Type of resource. Always compute#diskList for lists of disks. 813 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 814 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 815 }</pre> 816 </div> 817 818 <div class="method"> 819 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 820 <pre>Retrieves the next page of results. 821 822 Args: 823 previous_request: The request for the previous page. (required) 824 previous_response: The response from the request for the previous page. (required) 825 826 Returns: 827 A request object that you can call 'execute()' on to request the next 828 page. Returns None if there are no more items in the collection. 829 </pre> 830 </div> 831 832 <div class="method"> 833 <code class="details" id="resize">resize(project, zone, disk, body)</code> 834 <pre>Resizes the specified persistent disk. 835 836 Args: 837 project: string, Project ID for this request. (required) 838 zone: string, The name of the zone for this request. (required) 839 disk: string, The name of the persistent disk. (required) 840 body: object, The request body. (required) 841 The object takes the form of: 842 843 { 844 "sizeGb": "A String", # The new size of the persistent disk, which is specified in GB. 845 } 846 847 848 Returns: 849 An object of the form: 850 851 { # An Operation resource, used to manage asynchronous API requests. 852 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 853 "clientOperationId": "A String", # [Output Only] Reserved for future use. 854 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 855 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 856 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 857 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 858 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 859 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 860 "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. 861 "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. 862 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 863 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 864 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 865 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 866 { 867 "message": "A String", # [Output Only] A human-readable description of the warning code. 868 "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. 869 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 870 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 871 { 872 "value": "A String", # [Output Only] A warning data value corresponding to the key. 873 "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). 874 }, 875 ], 876 }, 877 ], 878 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 879 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 880 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 881 "name": "A String", # [Output Only] Name of the resource. 882 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 883 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 884 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 885 { 886 "message": "A String", # [Output Only] An optional, human-readable error message. 887 "code": "A String", # [Output Only] The error type identifier for this error. 888 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 889 }, 890 ], 891 }, 892 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 893 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 894 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 895 }</pre> 896 </div> 897 898 <div class="method"> 899 <code class="details" id="setLabels">setLabels(project, zone, resource, body)</code> 900 <pre>Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation. 901 902 Args: 903 project: string, Project ID for this request. (required) 904 zone: string, The name of the zone for this request. (required) 905 resource: string, Name of the resource for this request. (required) 906 body: object, The request body. (required) 907 The object takes the form of: 908 909 { 910 "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. 911 "labels": { # The labels to set for this resource. 912 "a_key": "A String", 913 }, 914 } 915 916 917 Returns: 918 An object of the form: 919 920 { # An Operation resource, used to manage asynchronous API requests. 921 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 922 "clientOperationId": "A String", # [Output Only] Reserved for future use. 923 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 924 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 925 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 926 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 927 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 928 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 929 "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. 930 "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. 931 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 932 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 933 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 934 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 935 { 936 "message": "A String", # [Output Only] A human-readable description of the warning code. 937 "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. 938 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 939 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 940 { 941 "value": "A String", # [Output Only] A warning data value corresponding to the key. 942 "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). 943 }, 944 ], 945 }, 946 ], 947 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 948 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 949 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 950 "name": "A String", # [Output Only] Name of the resource. 951 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 952 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 953 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 954 { 955 "message": "A String", # [Output Only] An optional, human-readable error message. 956 "code": "A String", # [Output Only] The error type identifier for this error. 957 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 958 }, 959 ], 960 }, 961 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 962 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 963 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 964 }</pre> 965 </div> 966 967 <div class="method"> 968 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code> 969 <pre>Returns permissions that a caller has on the specified resource. 970 971 Args: 972 project: string, Project ID for this request. (required) 973 zone: string, The name of the zone for this request. (required) 974 resource: string, Name of the resource for this request. (required) 975 body: object, The request body. (required) 976 The object takes the form of: 977 978 { 979 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 980 "A String", 981 ], 982 } 983 984 985 Returns: 986 An object of the form: 987 988 { 989 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 990 "A String", 991 ], 992 }</pre> 993 </div> 994 995 </body></html>
