1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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.regionDisks.html">regionDisks</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#addResourcePolicies">addResourcePolicies(project, region, disk, body, requestId=None)</a></code></p> 79<p class="firstline">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.</p> 80<p class="toc_element"> 81 <code><a href="#createSnapshot">createSnapshot(project, region, disk, body, requestId=None)</a></code></p> 82<p class="firstline">Creates a snapshot of this regional disk.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(project, region, disk, requestId=None)</a></code></p> 85<p class="firstline">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 any snapshots previously made from the disk. You must separately delete snapshots.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(project, region, disk)</a></code></p> 88<p class="firstline">Returns a specified regional persistent disk.</p> 89<p class="toc_element"> 90 <code><a href="#getIamPolicy">getIamPolicy(project, region, resource)</a></code></p> 91<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> 92<p class="toc_element"> 93 <code><a href="#insert">insert(project, region, body, requestId=None, sourceImage=None)</a></code></p> 94<p class="firstline">Creates a persistent regional disk in the specified project using the data included in the request.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 97<p class="firstline">Retrieves the list of persistent disks contained within the specified region.</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="#removeResourcePolicies">removeResourcePolicies(project, region, disk, body, requestId=None)</a></code></p> 103<p class="firstline">Removes resource policies from a regional disk.</p> 104<p class="toc_element"> 105 <code><a href="#resize">resize(project, region, disk, body, requestId=None)</a></code></p> 106<p class="firstline">Resizes the specified regional persistent disk.</p> 107<p class="toc_element"> 108 <code><a href="#setIamPolicy">setIamPolicy(project, region, resource, body)</a></code></p> 109<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 110<p class="toc_element"> 111 <code><a href="#setLabels">setLabels(project, region, resource, body, requestId=None)</a></code></p> 112<p class="firstline">Sets the labels on the target regional disk.</p> 113<p class="toc_element"> 114 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p> 115<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 116<h3>Method Details</h3> 117<div class="method"> 118 <code class="details" id="addResourcePolicies">addResourcePolicies(project, region, disk, body, requestId=None)</code> 119 <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. 120 121Args: 122 project: string, Project ID for this request. (required) 123 region: string, The name of the region for this request. (required) 124 disk: string, The disk name for this request. (required) 125 body: object, The request body. (required) 126 The object takes the form of: 127 128{ 129 "resourcePolicies": [ # Resource policies to be added to this disk. 130 "A String", 131 ], 132 } 133 134 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. 135 136For 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. 137 138The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 139 140Returns: 141 An object of the form: 142 143 { # Represents an Operation resource. 144 # 145 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 146 # 147 # Operations can be global, regional or zonal. 148 # - For global operations, use the globalOperations resource. 149 # - For regional operations, use the regionOperations resource. 150 # - For zonal operations, use the zonalOperations resource. 151 # 152 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 153 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 154 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 155 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 156 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 157 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 158 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 159 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 160 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 161 "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. 162 "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. 163 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 164 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 165 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 166 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 167 { 168 "message": "A String", # [Output Only] A human-readable description of the warning code. 169 "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. 170 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 171 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 172 { 173 "value": "A String", # [Output Only] A warning data value corresponding to the key. 174 "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). 175 }, 176 ], 177 }, 178 ], 179 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 180 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 181 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 182 "name": "A String", # [Output Only] Name of the resource. 183 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 184 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 185 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 186 { 187 "message": "A String", # [Output Only] An optional, human-readable error message. 188 "code": "A String", # [Output Only] The error type identifier for this error. 189 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 190 }, 191 ], 192 }, 193 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 194 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 195 "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. 196 }</pre> 197</div> 198 199<div class="method"> 200 <code class="details" id="createSnapshot">createSnapshot(project, region, disk, body, requestId=None)</code> 201 <pre>Creates a snapshot of this regional disk. 202 203Args: 204 project: string, Project ID for this request. (required) 205 region: string, Name of the region for this request. (required) 206 disk: string, Name of the regional persistent disk to snapshot. (required) 207 body: object, The request body. (required) 208 The object takes the form of: 209 210{ # Represents a Persistent Disk Snapshot resource. 211 # 212 # You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) 213 "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk. 214 "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. 215 "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. 216 "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. 217 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 218 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 219 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 220 # 221 # The key must meet the following requirements before you can provide it to Compute Engine: 222 # - The key is wrapped using a RSA public key certificate provided by Google. 223 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: 224 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 225 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 226 }, 227 "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. 228 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 229 "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot. 230 "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key. 231 # 232 # 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. 233 # 234 # Customer-supplied encryption keys do not protect access to metadata of the snapshot. 235 # 236 # 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. 237 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 238 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 239 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 240 # 241 # The key must meet the following requirements before you can provide it to Compute Engine: 242 # - The key is wrapped using a RSA public key certificate provided by Google. 243 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: 244 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 245 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 246 }, 247 "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. 248 "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 error 412 conditionNotMet. 249 # 250 # To see the latest fingerprint, make a get() request to retrieve a snapshot. 251 "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. 252 "a_key": "A String", 253 }, 254 "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. 255 "diskSizeGb": "A String", # [Output Only] Size of the snapshot, specified in GB. 256 "storageLocations": [ # GCS bucket storage location of the snapshot (regional or multi-regional). 257 "A String", 258 ], 259 "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). 260 "A String", 261 ], 262 "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. 263 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 264 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 265 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 266 "licenseCodes": [ # [Output Only] Integer license codes indicating which licenses are attached to this snapshot. 267 "A String", 268 ], 269 } 270 271 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. 272 273For 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. 274 275The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 276 277Returns: 278 An object of the form: 279 280 { # Represents an Operation resource. 281 # 282 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 283 # 284 # Operations can be global, regional or zonal. 285 # - For global operations, use the globalOperations resource. 286 # - For regional operations, use the regionOperations resource. 287 # - For zonal operations, use the zonalOperations resource. 288 # 289 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 290 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 291 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 292 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 293 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 294 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 295 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 296 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 297 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 298 "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. 299 "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. 300 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 301 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 302 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 303 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 304 { 305 "message": "A String", # [Output Only] A human-readable description of the warning code. 306 "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. 307 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 308 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 309 { 310 "value": "A String", # [Output Only] A warning data value corresponding to the key. 311 "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). 312 }, 313 ], 314 }, 315 ], 316 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 317 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 318 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 319 "name": "A String", # [Output Only] Name of the resource. 320 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 321 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 322 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 323 { 324 "message": "A String", # [Output Only] An optional, human-readable error message. 325 "code": "A String", # [Output Only] The error type identifier for this error. 326 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 327 }, 328 ], 329 }, 330 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 331 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 332 "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. 333 }</pre> 334</div> 335 336<div class="method"> 337 <code class="details" id="delete">delete(project, region, disk, requestId=None)</code> 338 <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 any snapshots previously made from the disk. You must separately delete snapshots. 339 340Args: 341 project: string, Project ID for this request. (required) 342 region: string, Name of the region for this request. (required) 343 disk: string, Name of the regional persistent disk to delete. (required) 344 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. 345 346For 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. 347 348The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 349 350Returns: 351 An object of the form: 352 353 { # Represents an Operation resource. 354 # 355 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 356 # 357 # Operations can be global, regional or zonal. 358 # - For global operations, use the globalOperations resource. 359 # - For regional operations, use the regionOperations resource. 360 # - For zonal operations, use the zonalOperations resource. 361 # 362 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 363 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 364 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 365 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 366 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 367 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 368 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 369 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 370 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 371 "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. 372 "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. 373 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 374 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 375 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 376 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 377 { 378 "message": "A String", # [Output Only] A human-readable description of the warning code. 379 "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. 380 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 381 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 382 { 383 "value": "A String", # [Output Only] A warning data value corresponding to the key. 384 "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). 385 }, 386 ], 387 }, 388 ], 389 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 390 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 391 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 392 "name": "A String", # [Output Only] Name of the resource. 393 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 394 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 395 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 396 { 397 "message": "A String", # [Output Only] An optional, human-readable error message. 398 "code": "A String", # [Output Only] The error type identifier for this error. 399 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 400 }, 401 ], 402 }, 403 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 404 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 405 "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. 406 }</pre> 407</div> 408 409<div class="method"> 410 <code class="details" id="get">get(project, region, disk)</code> 411 <pre>Returns a specified regional persistent disk. 412 413Args: 414 project: string, Project ID for this request. (required) 415 region: string, Name of the region for this request. (required) 416 disk: string, Name of the regional persistent disk to return. (required) 417 418Returns: 419 An object of the form: 420 421 { # Represents a Persistent Disk resource. 422 # 423 # 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. 424 # 425 # The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. 426 # 427 # The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==) 428 "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. 429 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 430 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 431 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 432 # 433 # The key must meet the following requirements before you can provide it to Compute Engine: 434 # - The key is wrapped using a RSA public key certificate provided by Google. 435 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: 436 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 437 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 438 }, 439 "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. 440 "a_key": "A String", 441 }, 442 "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. 443 { # Guest OS features. 444 "type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. 445 }, 446 ], 447 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 448 "A String", 449 ], 450 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 451 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 452 "licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk. 453 "A String", 454 ], 455 "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key. 456 # 457 # 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, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). 458 # 459 # Customer-supplied encryption keys do not protect access to metadata of the disk. 460 # 461 # 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. 462 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 463 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 464 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 465 # 466 # The key must meet the following requirements before you can provide it to Compute Engine: 467 # - The key is wrapped using a RSA public key certificate provided by Google. 468 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: 469 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 470 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 471 }, 472 "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. 473 "physicalBlockSizeBytes": "A String", # Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, 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. 474 "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format. 475 "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-standard or pd-ssd 476 "status": "A String", # [Output Only] The status of disk creation. 477 "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: 478 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot 479 # - projects/project/global/snapshots/snapshot 480 # - global/snapshots/snapshot 481 "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format. 482 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 483 "storageType": "A String", # [Deprecated] Storage type of the persistent disk. 484 "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 error 412 conditionNotMet. 485 # 486 # To see the latest fingerprint, make a get() request to retrieve a disk. 487 "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. 488 "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. 489 "A String", 490 ], 491 "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources. 492 "A String", 493 ], 494 "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. 495 "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance 496 "A String", 497 ], 498 "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks. 499 "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. 500 "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. 501 # 502 # 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. Acceptable values are 1 to 65536, inclusive. 503 "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. 504 "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. 505 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 506 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 507 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 508 # 509 # The key must meet the following requirements before you can provide it to Compute Engine: 510 # - The key is wrapped using a RSA public key certificate provided by Google. 511 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: 512 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 513 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 514 }, 515 "options": "A String", # Internal use only. 516 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 517 "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set. 518 # 519 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: 520 # projects/debian-cloud/global/images/family/debian-9 521 # 522 # 523 # Alternatively, use a specific version of a public operating system image: 524 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD 525 # 526 # 527 # To create a disk with a custom image that you created, specify the image name in the following format: 528 # global/images/my-custom-image 529 # 530 # 531 # 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: 532 # global/images/family/my-image-family 533 }</pre> 534</div> 535 536<div class="method"> 537 <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource)</code> 538 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 539 540Args: 541 project: string, Project ID for this request. (required) 542 region: string, The name of the region for this request. (required) 543 resource: string, Name or id of the resource for this request. (required) 544 545Returns: 546 An object of the form: 547 548 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 549 # 550 # 551 # 552 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 553 # 554 # **JSON Example** 555 # 556 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } 557 # 558 # **YAML Example** 559 # 560 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer 561 # 562 # 563 # 564 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). 565 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 566 { # 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. 567 # 568 # 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. 569 # 570 # Example Policy with multiple AuditConfigs: 571 # 572 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } 573 # 574 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. 575 "exemptedMembers": [ 576 "A String", 577 ], 578 "auditLogConfigs": [ # The configuration for logging of each type of permission. 579 { # Provides the configuration for logging a type of permissions. Example: 580 # 581 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 582 # 583 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 584 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 585 "A String", 586 ], 587 "logType": "A String", # The log type that this config enables. 588 }, 589 ], 590 "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. 591 }, 592 ], 593 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 594 { # A rule to be applied in a Policy. 595 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 596 { # Specifies what kind of log the caller must write 597 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. 598 # 599 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. 600 # 601 # Field names correspond to IAM request parameters and field values are their respective values. 602 # 603 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. 604 # 605 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} 606 # 607 # At this time we do not support multiple field names (though this may be supported in the future). 608 "field": "A String", # The field value to attribute. 609 "metric": "A String", # The metric to update. 610 }, 611 "dataAccess": { # Write a Data Access (Gin) log # Data access options. 612 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. 613 }, 614 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 615 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 616 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. 617 "permissionType": "A String", # The type of the permission that was checked. 618 }, 619 }, 620 }, 621 ], 622 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 623 "A String", 624 ], 625 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 626 "A String", 627 ], 628 "action": "A String", # Required 629 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 630 "A String", 631 ], 632 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. 633 { # A condition to be met. 634 "iam": "A String", # Trusted attributes supplied by the IAM system. 635 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 636 "values": [ # The objects of the condition. 637 "A String", 638 ], 639 "svc": "A String", # Trusted attributes discharged by the service. 640 "op": "A String", # An operator to apply the subject with. 641 }, 642 ], 643 "description": "A String", # Human-readable description of the rule. 644 }, 645 ], 646 "version": 42, # Deprecated. 647 "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. 648 # 649 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 650 "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. 651 { # Associates `members` with a `role`. 652 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 653 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 654 # 655 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 656 # 657 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 658 # 659 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 660 # 661 # 662 # 663 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 664 # 665 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 666 # 667 # 668 # 669 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 670 "A String", 671 ], 672 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 673 # 674 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 675 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 676 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 677 # 678 # The application context of the containing message determines which well-known feature set of CEL is supported. 679 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 680 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 681 }, 682 }, 683 ], 684 "iamOwned": True or False, 685 }</pre> 686</div> 687 688<div class="method"> 689 <code class="details" id="insert">insert(project, region, body, requestId=None, sourceImage=None)</code> 690 <pre>Creates a persistent regional disk in the specified project using the data included in the request. 691 692Args: 693 project: string, Project ID for this request. (required) 694 region: string, Name of the region for this request. (required) 695 body: object, The request body. (required) 696 The object takes the form of: 697 698{ # Represents a Persistent Disk resource. 699 # 700 # 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. 701 # 702 # The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. 703 # 704 # The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==) 705 "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. 706 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 707 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 708 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 709 # 710 # The key must meet the following requirements before you can provide it to Compute Engine: 711 # - The key is wrapped using a RSA public key certificate provided by Google. 712 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: 713 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 714 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 715 }, 716 "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. 717 "a_key": "A String", 718 }, 719 "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. 720 { # Guest OS features. 721 "type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. 722 }, 723 ], 724 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 725 "A String", 726 ], 727 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 728 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 729 "licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk. 730 "A String", 731 ], 732 "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key. 733 # 734 # 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, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). 735 # 736 # Customer-supplied encryption keys do not protect access to metadata of the disk. 737 # 738 # 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. 739 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 740 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 741 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 742 # 743 # The key must meet the following requirements before you can provide it to Compute Engine: 744 # - The key is wrapped using a RSA public key certificate provided by Google. 745 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: 746 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 747 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 748 }, 749 "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. 750 "physicalBlockSizeBytes": "A String", # Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, 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. 751 "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format. 752 "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-standard or pd-ssd 753 "status": "A String", # [Output Only] The status of disk creation. 754 "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: 755 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot 756 # - projects/project/global/snapshots/snapshot 757 # - global/snapshots/snapshot 758 "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format. 759 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 760 "storageType": "A String", # [Deprecated] Storage type of the persistent disk. 761 "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 error 412 conditionNotMet. 762 # 763 # To see the latest fingerprint, make a get() request to retrieve a disk. 764 "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. 765 "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. 766 "A String", 767 ], 768 "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources. 769 "A String", 770 ], 771 "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. 772 "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance 773 "A String", 774 ], 775 "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks. 776 "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. 777 "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. 778 # 779 # 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. Acceptable values are 1 to 65536, inclusive. 780 "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. 781 "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. 782 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 783 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 784 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 785 # 786 # The key must meet the following requirements before you can provide it to Compute Engine: 787 # - The key is wrapped using a RSA public key certificate provided by Google. 788 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: 789 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 790 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 791 }, 792 "options": "A String", # Internal use only. 793 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 794 "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set. 795 # 796 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: 797 # projects/debian-cloud/global/images/family/debian-9 798 # 799 # 800 # Alternatively, use a specific version of a public operating system image: 801 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD 802 # 803 # 804 # To create a disk with a custom image that you created, specify the image name in the following format: 805 # global/images/my-custom-image 806 # 807 # 808 # 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: 809 # global/images/family/my-image-family 810 } 811 812 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. 813 814For 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. 815 816The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 817 sourceImage: string, Optional. Source image to restore onto a disk. 818 819Returns: 820 An object of the form: 821 822 { # Represents an Operation resource. 823 # 824 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 825 # 826 # Operations can be global, regional or zonal. 827 # - For global operations, use the globalOperations resource. 828 # - For regional operations, use the regionOperations resource. 829 # - For zonal operations, use the zonalOperations resource. 830 # 831 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 832 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 833 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 834 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 835 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 836 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 837 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 838 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 839 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 840 "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. 841 "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. 842 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 843 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 844 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 845 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 846 { 847 "message": "A String", # [Output Only] A human-readable description of the warning code. 848 "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. 849 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 850 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 851 { 852 "value": "A String", # [Output Only] A warning data value corresponding to the key. 853 "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). 854 }, 855 ], 856 }, 857 ], 858 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 859 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 860 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 861 "name": "A String", # [Output Only] Name of the resource. 862 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 863 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 864 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 865 { 866 "message": "A String", # [Output Only] An optional, human-readable error message. 867 "code": "A String", # [Output Only] The error type identifier for this error. 868 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 869 }, 870 ], 871 }, 872 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 873 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 874 "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. 875 }</pre> 876</div> 877 878<div class="method"> 879 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 880 <pre>Retrieves the list of persistent disks contained within the specified region. 881 882Args: 883 project: string, Project ID for this request. (required) 884 region: string, Name of the region for this request. (required) 885 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 886 887You 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. 888 889Currently, only sorting by name or creationTimestamp desc is supported. 890 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) 891 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. 892 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 893 894For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 895 896You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. 897 898To 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). 899 900Returns: 901 An object of the form: 902 903 { # A list of Disk resources. 904 "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. 905 "kind": "compute#diskList", # [Output Only] Type of resource. Always compute#diskList for lists of disks. 906 "items": [ # A list of Disk resources. 907 { # Represents a Persistent Disk resource. 908 # 909 # 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. 910 # 911 # The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. 912 # 913 # The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==) 914 "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. 915 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 916 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 917 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 918 # 919 # The key must meet the following requirements before you can provide it to Compute Engine: 920 # - The key is wrapped using a RSA public key certificate provided by Google. 921 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: 922 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 923 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 924 }, 925 "labels": { # Labels to apply to this disk. These can be later modified by the setLabels method. 926 "a_key": "A String", 927 }, 928 "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. 929 { # Guest OS features. 930 "type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. 931 }, 932 ], 933 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 934 "A String", 935 ], 936 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 937 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 938 "licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk. 939 "A String", 940 ], 941 "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key. 942 # 943 # 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, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). 944 # 945 # Customer-supplied encryption keys do not protect access to metadata of the disk. 946 # 947 # 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. 948 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 949 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 950 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 951 # 952 # The key must meet the following requirements before you can provide it to Compute Engine: 953 # - The key is wrapped using a RSA public key certificate provided by Google. 954 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: 955 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 956 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 957 }, 958 "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. 959 "physicalBlockSizeBytes": "A String", # Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, 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. 960 "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format. 961 "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-standard or pd-ssd 962 "status": "A String", # [Output Only] The status of disk creation. 963 "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: 964 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot 965 # - projects/project/global/snapshots/snapshot 966 # - global/snapshots/snapshot 967 "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format. 968 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 969 "storageType": "A String", # [Deprecated] Storage type of the persistent disk. 970 "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 error 412 conditionNotMet. 971 # 972 # To see the latest fingerprint, make a get() request to retrieve a disk. 973 "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. 974 "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. 975 "A String", 976 ], 977 "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources. 978 "A String", 979 ], 980 "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. 981 "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance 982 "A String", 983 ], 984 "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks. 985 "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. 986 "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. 987 # 988 # 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. Acceptable values are 1 to 65536, inclusive. 989 "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. 990 "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. 991 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 992 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 993 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 994 # 995 # The key must meet the following requirements before you can provide it to Compute Engine: 996 # - The key is wrapped using a RSA public key certificate provided by Google. 997 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: 998 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 999 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 1000 }, 1001 "options": "A String", # Internal use only. 1002 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 1003 "sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set. 1004 # 1005 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: 1006 # projects/debian-cloud/global/images/family/debian-9 1007 # 1008 # 1009 # Alternatively, use a specific version of a public operating system image: 1010 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD 1011 # 1012 # 1013 # To create a disk with a custom image that you created, specify the image name in the following format: 1014 # global/images/my-custom-image 1015 # 1016 # 1017 # 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: 1018 # global/images/family/my-image-family 1019 }, 1020 ], 1021 "warning": { # [Output Only] Informational warning message. 1022 "message": "A String", # [Output Only] A human-readable description of the warning code. 1023 "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. 1024 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1025 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1026 { 1027 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1028 "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). 1029 }, 1030 ], 1031 }, 1032 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 1033 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1034 }</pre> 1035</div> 1036 1037<div class="method"> 1038 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1039 <pre>Retrieves the next page of results. 1040 1041Args: 1042 previous_request: The request for the previous page. (required) 1043 previous_response: The response from the request for the previous page. (required) 1044 1045Returns: 1046 A request object that you can call 'execute()' on to request the next 1047 page. Returns None if there are no more items in the collection. 1048 </pre> 1049</div> 1050 1051<div class="method"> 1052 <code class="details" id="removeResourcePolicies">removeResourcePolicies(project, region, disk, body, requestId=None)</code> 1053 <pre>Removes resource policies from a regional disk. 1054 1055Args: 1056 project: string, Project ID for this request. (required) 1057 region: string, The name of the region for this request. (required) 1058 disk: string, The disk name for this request. (required) 1059 body: object, The request body. (required) 1060 The object takes the form of: 1061 1062{ 1063 "resourcePolicies": [ # Resource policies to be removed from this disk. 1064 "A String", 1065 ], 1066 } 1067 1068 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. 1069 1070For 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. 1071 1072The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 1073 1074Returns: 1075 An object of the form: 1076 1077 { # Represents an Operation resource. 1078 # 1079 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1080 # 1081 # Operations can be global, regional or zonal. 1082 # - For global operations, use the globalOperations resource. 1083 # - For regional operations, use the regionOperations resource. 1084 # - For zonal operations, use the zonalOperations resource. 1085 # 1086 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 1087 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1088 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1089 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1090 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1091 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1092 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1093 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1094 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1095 "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. 1096 "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. 1097 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1098 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1099 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1100 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1101 { 1102 "message": "A String", # [Output Only] A human-readable description of the warning code. 1103 "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. 1104 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1105 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1106 { 1107 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1108 "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). 1109 }, 1110 ], 1111 }, 1112 ], 1113 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1114 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1115 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1116 "name": "A String", # [Output Only] Name of the resource. 1117 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1118 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1119 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1120 { 1121 "message": "A String", # [Output Only] An optional, human-readable error message. 1122 "code": "A String", # [Output Only] The error type identifier for this error. 1123 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1124 }, 1125 ], 1126 }, 1127 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1128 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1129 "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. 1130 }</pre> 1131</div> 1132 1133<div class="method"> 1134 <code class="details" id="resize">resize(project, region, disk, body, requestId=None)</code> 1135 <pre>Resizes the specified regional persistent disk. 1136 1137Args: 1138 project: string, The project ID for this request. (required) 1139 region: string, Name of the region for this request. (required) 1140 disk: string, Name of the regional persistent disk. (required) 1141 body: object, The request body. (required) 1142 The object takes the form of: 1143 1144{ 1145 "sizeGb": "A String", # The new size of the regional persistent disk, which is specified in GB. 1146 } 1147 1148 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. 1149 1150For 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. 1151 1152The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 1153 1154Returns: 1155 An object of the form: 1156 1157 { # Represents an Operation resource. 1158 # 1159 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1160 # 1161 # Operations can be global, regional or zonal. 1162 # - For global operations, use the globalOperations resource. 1163 # - For regional operations, use the regionOperations resource. 1164 # - For zonal operations, use the zonalOperations resource. 1165 # 1166 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 1167 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1168 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1169 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1170 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1171 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1172 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1173 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1174 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1175 "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. 1176 "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. 1177 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1178 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1179 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1180 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1181 { 1182 "message": "A String", # [Output Only] A human-readable description of the warning code. 1183 "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. 1184 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1185 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1186 { 1187 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1188 "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). 1189 }, 1190 ], 1191 }, 1192 ], 1193 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1194 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1195 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1196 "name": "A String", # [Output Only] Name of the resource. 1197 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1198 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1199 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1200 { 1201 "message": "A String", # [Output Only] An optional, human-readable error message. 1202 "code": "A String", # [Output Only] The error type identifier for this error. 1203 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1204 }, 1205 ], 1206 }, 1207 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1208 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1209 "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. 1210 }</pre> 1211</div> 1212 1213<div class="method"> 1214 <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body)</code> 1215 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 1216 1217Args: 1218 project: string, Project ID for this request. (required) 1219 region: string, The name of the region for this request. (required) 1220 resource: string, Name or id of the resource for this request. (required) 1221 body: object, The request body. (required) 1222 The object takes the form of: 1223 1224{ 1225 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. 1226 # 1227 # 1228 # 1229 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 1230 # 1231 # **JSON Example** 1232 # 1233 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } 1234 # 1235 # **YAML Example** 1236 # 1237 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer 1238 # 1239 # 1240 # 1241 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). 1242 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1243 { # 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. 1244 # 1245 # 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. 1246 # 1247 # Example Policy with multiple AuditConfigs: 1248 # 1249 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } 1250 # 1251 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. 1252 "exemptedMembers": [ 1253 "A String", 1254 ], 1255 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1256 { # Provides the configuration for logging a type of permissions. Example: 1257 # 1258 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 1259 # 1260 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 1261 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 1262 "A String", 1263 ], 1264 "logType": "A String", # The log type that this config enables. 1265 }, 1266 ], 1267 "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. 1268 }, 1269 ], 1270 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 1271 { # A rule to be applied in a Policy. 1272 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 1273 { # Specifies what kind of log the caller must write 1274 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. 1275 # 1276 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. 1277 # 1278 # Field names correspond to IAM request parameters and field values are their respective values. 1279 # 1280 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. 1281 # 1282 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} 1283 # 1284 # At this time we do not support multiple field names (though this may be supported in the future). 1285 "field": "A String", # The field value to attribute. 1286 "metric": "A String", # The metric to update. 1287 }, 1288 "dataAccess": { # Write a Data Access (Gin) log # Data access options. 1289 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. 1290 }, 1291 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 1292 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 1293 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. 1294 "permissionType": "A String", # The type of the permission that was checked. 1295 }, 1296 }, 1297 }, 1298 ], 1299 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 1300 "A String", 1301 ], 1302 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 1303 "A String", 1304 ], 1305 "action": "A String", # Required 1306 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 1307 "A String", 1308 ], 1309 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. 1310 { # A condition to be met. 1311 "iam": "A String", # Trusted attributes supplied by the IAM system. 1312 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 1313 "values": [ # The objects of the condition. 1314 "A String", 1315 ], 1316 "svc": "A String", # Trusted attributes discharged by the service. 1317 "op": "A String", # An operator to apply the subject with. 1318 }, 1319 ], 1320 "description": "A String", # Human-readable description of the rule. 1321 }, 1322 ], 1323 "version": 42, # Deprecated. 1324 "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. 1325 # 1326 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 1327 "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. 1328 { # Associates `members` with a `role`. 1329 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1330 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 1331 # 1332 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 1333 # 1334 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1335 # 1336 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 1337 # 1338 # 1339 # 1340 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 1341 # 1342 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 1343 # 1344 # 1345 # 1346 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1347 "A String", 1348 ], 1349 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1350 # 1351 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 1352 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 1353 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1354 # 1355 # The application context of the containing message determines which well-known feature set of CEL is supported. 1356 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1357 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1358 }, 1359 }, 1360 ], 1361 "iamOwned": True or False, 1362 }, 1363 "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. 1364 { # Associates `members` with a `role`. 1365 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1366 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 1367 # 1368 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 1369 # 1370 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1371 # 1372 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 1373 # 1374 # 1375 # 1376 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 1377 # 1378 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 1379 # 1380 # 1381 # 1382 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1383 "A String", 1384 ], 1385 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1386 # 1387 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 1388 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 1389 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1390 # 1391 # The application context of the containing message determines which well-known feature set of CEL is supported. 1392 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1393 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1394 }, 1395 }, 1396 ], 1397 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. 1398 } 1399 1400 1401Returns: 1402 An object of the form: 1403 1404 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 1405 # 1406 # 1407 # 1408 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 1409 # 1410 # **JSON Example** 1411 # 1412 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } 1413 # 1414 # **YAML Example** 1415 # 1416 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer 1417 # 1418 # 1419 # 1420 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). 1421 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1422 { # 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. 1423 # 1424 # 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. 1425 # 1426 # Example Policy with multiple AuditConfigs: 1427 # 1428 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } 1429 # 1430 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. 1431 "exemptedMembers": [ 1432 "A String", 1433 ], 1434 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1435 { # Provides the configuration for logging a type of permissions. Example: 1436 # 1437 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 1438 # 1439 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 1440 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 1441 "A String", 1442 ], 1443 "logType": "A String", # The log type that this config enables. 1444 }, 1445 ], 1446 "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. 1447 }, 1448 ], 1449 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 1450 { # A rule to be applied in a Policy. 1451 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 1452 { # Specifies what kind of log the caller must write 1453 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. 1454 # 1455 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. 1456 # 1457 # Field names correspond to IAM request parameters and field values are their respective values. 1458 # 1459 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. 1460 # 1461 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} 1462 # 1463 # At this time we do not support multiple field names (though this may be supported in the future). 1464 "field": "A String", # The field value to attribute. 1465 "metric": "A String", # The metric to update. 1466 }, 1467 "dataAccess": { # Write a Data Access (Gin) log # Data access options. 1468 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. 1469 }, 1470 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 1471 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 1472 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. 1473 "permissionType": "A String", # The type of the permission that was checked. 1474 }, 1475 }, 1476 }, 1477 ], 1478 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 1479 "A String", 1480 ], 1481 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 1482 "A String", 1483 ], 1484 "action": "A String", # Required 1485 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 1486 "A String", 1487 ], 1488 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. 1489 { # A condition to be met. 1490 "iam": "A String", # Trusted attributes supplied by the IAM system. 1491 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 1492 "values": [ # The objects of the condition. 1493 "A String", 1494 ], 1495 "svc": "A String", # Trusted attributes discharged by the service. 1496 "op": "A String", # An operator to apply the subject with. 1497 }, 1498 ], 1499 "description": "A String", # Human-readable description of the rule. 1500 }, 1501 ], 1502 "version": 42, # Deprecated. 1503 "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. 1504 # 1505 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 1506 "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. 1507 { # Associates `members` with a `role`. 1508 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1509 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 1510 # 1511 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 1512 # 1513 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1514 # 1515 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 1516 # 1517 # 1518 # 1519 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 1520 # 1521 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 1522 # 1523 # 1524 # 1525 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1526 "A String", 1527 ], 1528 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1529 # 1530 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 1531 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 1532 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1533 # 1534 # The application context of the containing message determines which well-known feature set of CEL is supported. 1535 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1536 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1537 }, 1538 }, 1539 ], 1540 "iamOwned": True or False, 1541 }</pre> 1542</div> 1543 1544<div class="method"> 1545 <code class="details" id="setLabels">setLabels(project, region, resource, body, requestId=None)</code> 1546 <pre>Sets the labels on the target regional disk. 1547 1548Args: 1549 project: string, Project ID for this request. (required) 1550 region: string, The region for this request. (required) 1551 resource: string, Name or id of the resource for this request. (required) 1552 body: object, The request body. (required) 1553 The object takes the form of: 1554 1555{ 1556 "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. 1557 "labels": { # The labels to set for this resource. 1558 "a_key": "A String", 1559 }, 1560 } 1561 1562 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. 1563 1564For 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. 1565 1566The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 1567 1568Returns: 1569 An object of the form: 1570 1571 { # Represents an Operation resource. 1572 # 1573 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1574 # 1575 # Operations can be global, regional or zonal. 1576 # - For global operations, use the globalOperations resource. 1577 # - For regional operations, use the regionOperations resource. 1578 # - For zonal operations, use the zonalOperations resource. 1579 # 1580 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 1581 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1582 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1583 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1584 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1585 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1586 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1587 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1588 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1589 "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. 1590 "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. 1591 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1592 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1593 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1594 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1595 { 1596 "message": "A String", # [Output Only] A human-readable description of the warning code. 1597 "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. 1598 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1599 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1600 { 1601 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1602 "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). 1603 }, 1604 ], 1605 }, 1606 ], 1607 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1608 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1609 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1610 "name": "A String", # [Output Only] Name of the resource. 1611 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1612 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1613 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1614 { 1615 "message": "A String", # [Output Only] An optional, human-readable error message. 1616 "code": "A String", # [Output Only] The error type identifier for this error. 1617 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1618 }, 1619 ], 1620 }, 1621 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1622 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1623 "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. 1624 }</pre> 1625</div> 1626 1627<div class="method"> 1628 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code> 1629 <pre>Returns permissions that a caller has on the specified resource. 1630 1631Args: 1632 project: string, Project ID for this request. (required) 1633 region: string, The name of the region for this request. (required) 1634 resource: string, Name or id of the resource for this request. (required) 1635 body: object, The request body. (required) 1636 The object takes the form of: 1637 1638{ 1639 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1640 "A String", 1641 ], 1642 } 1643 1644 1645Returns: 1646 An object of the form: 1647 1648 { 1649 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1650 "A String", 1651 ], 1652 }</pre> 1653</div> 1654 1655</body></html>