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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.images.html">images</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#delete">delete(project, image, requestId=None)</a></code></p> 79<p class="firstline">Deletes the specified image.</p> 80<p class="toc_element"> 81 <code><a href="#deprecate">deprecate(project, image, body, requestId=None)</a></code></p> 82<p class="firstline">Sets the deprecation status of an image.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, image)</a></code></p> 85<p class="firstline">Returns the specified image. Get a list of available images by making a list() request.</p> 86<p class="toc_element"> 87 <code><a href="#getFromFamily">getFromFamily(project, family)</a></code></p> 88<p class="firstline">Returns the latest image that is part of an image family and is not deprecated.</p> 89<p class="toc_element"> 90 <code><a href="#getIamPolicy">getIamPolicy(project, 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, body, requestId=None, forceCreate=None)</a></code></p> 94<p class="firstline">Creates an image in the specified project using the data included in the request.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 97<p class="firstline">Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.</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="#setIamPolicy">setIamPolicy(project, resource, body)</a></code></p> 103<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 104<p class="toc_element"> 105 <code><a href="#setLabels">setLabels(project, resource, body)</a></code></p> 106<p class="firstline">Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.</p> 107<p class="toc_element"> 108 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 109<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 110<h3>Method Details</h3> 111<div class="method"> 112 <code class="details" id="delete">delete(project, image, requestId=None)</code> 113 <pre>Deletes the specified image. 114 115Args: 116 project: string, Project ID for this request. (required) 117 image: string, Name of the image resource to delete. (required) 118 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 119 120Returns: 121 An object of the form: 122 123 { # An Operation resource, used to manage asynchronous API requests. 124 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 125 "clientOperationId": "A String", # [Output Only] Reserved for future use. 126 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 127 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 128 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 129 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 130 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 131 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 132 "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. 133 "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. 134 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 135 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 136 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 137 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 138 { 139 "message": "A String", # [Output Only] A human-readable description of the warning code. 140 "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. 141 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 142 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 143 { 144 "value": "A String", # [Output Only] A warning data value corresponding to the key. 145 "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). 146 }, 147 ], 148 }, 149 ], 150 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 151 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 152 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 153 "name": "A String", # [Output Only] Name of the resource. 154 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 155 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 156 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 157 { 158 "message": "A String", # [Output Only] An optional, human-readable error message. 159 "code": "A String", # [Output Only] The error type identifier for this error. 160 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 161 }, 162 ], 163 }, 164 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 165 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 166 "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. 167 }</pre> 168</div> 169 170<div class="method"> 171 <code class="details" id="deprecate">deprecate(project, image, body, requestId=None)</code> 172 <pre>Sets the deprecation status of an image. 173 174If an empty request body is given, clears the deprecation status instead. 175 176Args: 177 project: string, Project ID for this request. (required) 178 image: string, Image name. (required) 179 body: object, The request body. (required) 180 The object takes the form of: 181 182{ # Deprecation status for a public resource. 183 "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. 184 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. 185 "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. 186 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. 187 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. 188} 189 190 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 191 192Returns: 193 An object of the form: 194 195 { # An Operation resource, used to manage asynchronous API requests. 196 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 197 "clientOperationId": "A String", # [Output Only] Reserved for future use. 198 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 199 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 200 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 201 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 202 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 203 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 204 "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. 205 "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. 206 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 207 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 208 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 209 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 210 { 211 "message": "A String", # [Output Only] A human-readable description of the warning code. 212 "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. 213 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 214 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 215 { 216 "value": "A String", # [Output Only] A warning data value corresponding to the key. 217 "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). 218 }, 219 ], 220 }, 221 ], 222 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 223 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 224 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 225 "name": "A String", # [Output Only] Name of the resource. 226 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 227 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 228 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 229 { 230 "message": "A String", # [Output Only] An optional, human-readable error message. 231 "code": "A String", # [Output Only] The error type identifier for this error. 232 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 233 }, 234 ], 235 }, 236 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 237 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 238 "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. 239 }</pre> 240</div> 241 242<div class="method"> 243 <code class="details" id="get">get(project, image)</code> 244 <pre>Returns the specified image. Get a list of available images by making a list() request. 245 246Args: 247 project: string, Project ID for this request. (required) 248 image: string, Name of the image resource to return. (required) 249 250Returns: 251 An object of the form: 252 253 { # An Image resource. 254 "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. 255 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 256 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 257 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 258 # 259 # The key must meet the following requirements before you can provide it to Compute Engine: 260 # - The key is wrapped using a RSA public key certificate provided by Google. 261 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 262 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 263 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 264 }, 265 "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. 266 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 267 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 268 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 269 # 270 # The key must meet the following requirements before you can provide it to Compute Engine: 271 # - The key is wrapped using a RSA public key certificate provided by Google. 272 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 273 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 274 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 275 }, 276 "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. 277 "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. 278 "a_key": "A String", 279 }, 280 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). 281 "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE. 282 # 283 # For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features. 284 { # Guest OS features. 285 "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. For newer Windows images, the server might also populate this property with the value WINDOWS to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features. 286 }, 287 ], 288 "licenses": [ # Any applicable license URI. 289 "A String", 290 ], 291 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 292 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 293 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW 294 "sourceDisk": "A String", # URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: 295 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk 296 # - projects/project/zones/zone/disks/disk 297 # - zones/zone/disks/disk 298 "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key. 299 # 300 # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). 301 # 302 # Customer-supplied encryption keys do not protect access to metadata of the disk. 303 # 304 # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. 305 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 306 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 307 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 308 # 309 # The key must meet the following requirements before you can provide it to Compute Engine: 310 # - The key is wrapped using a RSA public key certificate provided by Google. 311 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 312 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 313 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 314 }, 315 "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. 316 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 317 "rawDisk": { # The parameters of the raw disk image. 318 "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created. 319 "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both. 320 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created. 321 }, 322 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels 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. 323 # 324 # To see the latest fingerprint, make a get() request to retrieve an image. 325 "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. 326 "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. 327 "sourceImage": "A String", # URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: 328 # - this property, or 329 # - the rawDisk.source property, or 330 # - the sourceDisk property in order to create an image. 331 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images. 332 "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. 333 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image. 334 "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. 335 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. 336 "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. 337 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. 338 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. 339 }, 340 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). 341 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 342 }</pre> 343</div> 344 345<div class="method"> 346 <code class="details" id="getFromFamily">getFromFamily(project, family)</code> 347 <pre>Returns the latest image that is part of an image family and is not deprecated. 348 349Args: 350 project: string, Project ID for this request. (required) 351 family: string, Name of the image family to search for. (required) 352 353Returns: 354 An object of the form: 355 356 { # An Image resource. 357 "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. 358 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 359 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 360 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 361 # 362 # The key must meet the following requirements before you can provide it to Compute Engine: 363 # - The key is wrapped using a RSA public key certificate provided by Google. 364 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 365 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 366 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 367 }, 368 "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. 369 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 370 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 371 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 372 # 373 # The key must meet the following requirements before you can provide it to Compute Engine: 374 # - The key is wrapped using a RSA public key certificate provided by Google. 375 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 376 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 377 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 378 }, 379 "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. 380 "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. 381 "a_key": "A String", 382 }, 383 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). 384 "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE. 385 # 386 # For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features. 387 { # Guest OS features. 388 "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. For newer Windows images, the server might also populate this property with the value WINDOWS to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features. 389 }, 390 ], 391 "licenses": [ # Any applicable license URI. 392 "A String", 393 ], 394 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 395 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 396 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW 397 "sourceDisk": "A String", # URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: 398 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk 399 # - projects/project/zones/zone/disks/disk 400 # - zones/zone/disks/disk 401 "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key. 402 # 403 # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). 404 # 405 # Customer-supplied encryption keys do not protect access to metadata of the disk. 406 # 407 # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. 408 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 409 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 410 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 411 # 412 # The key must meet the following requirements before you can provide it to Compute Engine: 413 # - The key is wrapped using a RSA public key certificate provided by Google. 414 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 415 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 416 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 417 }, 418 "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. 419 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 420 "rawDisk": { # The parameters of the raw disk image. 421 "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created. 422 "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both. 423 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created. 424 }, 425 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels 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. 426 # 427 # To see the latest fingerprint, make a get() request to retrieve an image. 428 "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. 429 "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. 430 "sourceImage": "A String", # URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: 431 # - this property, or 432 # - the rawDisk.source property, or 433 # - the sourceDisk property in order to create an image. 434 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images. 435 "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. 436 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image. 437 "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. 438 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. 439 "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. 440 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. 441 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. 442 }, 443 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). 444 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 445 }</pre> 446</div> 447 448<div class="method"> 449 <code class="details" id="getIamPolicy">getIamPolicy(project, resource)</code> 450 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 451 452Args: 453 project: string, Project ID for this request. (required) 454 resource: string, Name of the resource for this request. (required) 455 456Returns: 457 An object of the form: 458 459 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 460 # 461 # 462 # 463 # 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. 464 # 465 # **Example** 466 # 467 # { "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"] } ] } 468 # 469 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 470 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 471 { # 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. 472 # 473 # 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 AuditConfig are exempted. 474 # 475 # Example Policy with multiple AuditConfigs: 476 # 477 # { "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" ] } ] } ] } 478 # 479 # 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. 480 "exemptedMembers": [ 481 "A String", 482 ], 483 "auditLogConfigs": [ # The configuration for logging of each type of permission. 484 { # Provides the configuration for logging a type of permissions. Example: 485 # 486 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 487 # 488 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 489 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 490 "A String", 491 ], 492 "logType": "A String", # The log type that this config enables. 493 }, 494 ], 495 "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. 496 }, 497 ], 498 "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. 499 { # A rule to be applied in a Policy. 500 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 501 { # Specifies what kind of log the caller must write 502 "counter": { # Options for counters # Counter options. 503 "field": "A String", # The field value to attribute. 504 "metric": "A String", # The metric to update. 505 }, 506 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 507 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 508 }, 509 }, 510 ], 511 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 512 "A String", 513 ], 514 "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. 515 "A String", 516 ], 517 "action": "A String", # Required 518 "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. 519 "A String", 520 ], 521 "conditions": [ # Additional restrictions that must be met 522 { # A condition to be met. 523 "iam": "A String", # Trusted attributes supplied by the IAM system. 524 "svc": "A String", # Trusted attributes discharged by the service. 525 "value": "A String", # DEPRECATED. Use 'values' instead. 526 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 527 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 528 "A String", 529 ], 530 "op": "A String", # An operator to apply the subject with. 531 }, 532 ], 533 "description": "A String", # Human-readable description of the rule. 534 }, 535 ], 536 "version": 42, # Version of the `Policy`. The default version is 0. 537 "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. 538 # 539 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 540 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 541 { # Associates `members` with a `role`. 542 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 543 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 544 # 545 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 546 # 547 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 548 # 549 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. 550 # 551 # 552 # 553 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 554 # 555 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 556 # 557 # 558 # 559 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 560 "A String", 561 ], 562 }, 563 ], 564 "iamOwned": True or False, 565 }</pre> 566</div> 567 568<div class="method"> 569 <code class="details" id="insert">insert(project, body, requestId=None, forceCreate=None)</code> 570 <pre>Creates an image in the specified project using the data included in the request. 571 572Args: 573 project: string, Project ID for this request. (required) 574 body: object, The request body. (required) 575 The object takes the form of: 576 577{ # An Image resource. 578 "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. 579 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 580 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 581 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 582 # 583 # The key must meet the following requirements before you can provide it to Compute Engine: 584 # - The key is wrapped using a RSA public key certificate provided by Google. 585 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 586 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 587 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 588 }, 589 "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. 590 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 591 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 592 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 593 # 594 # The key must meet the following requirements before you can provide it to Compute Engine: 595 # - The key is wrapped using a RSA public key certificate provided by Google. 596 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 597 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 598 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 599 }, 600 "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. 601 "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. 602 "a_key": "A String", 603 }, 604 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). 605 "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE. 606 # 607 # For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features. 608 { # Guest OS features. 609 "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. For newer Windows images, the server might also populate this property with the value WINDOWS to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features. 610 }, 611 ], 612 "licenses": [ # Any applicable license URI. 613 "A String", 614 ], 615 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 616 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 617 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW 618 "sourceDisk": "A String", # URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: 619 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk 620 # - projects/project/zones/zone/disks/disk 621 # - zones/zone/disks/disk 622 "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key. 623 # 624 # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). 625 # 626 # Customer-supplied encryption keys do not protect access to metadata of the disk. 627 # 628 # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. 629 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 630 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 631 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 632 # 633 # The key must meet the following requirements before you can provide it to Compute Engine: 634 # - The key is wrapped using a RSA public key certificate provided by Google. 635 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 636 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 637 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 638 }, 639 "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. 640 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 641 "rawDisk": { # The parameters of the raw disk image. 642 "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created. 643 "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both. 644 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created. 645 }, 646 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels 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. 647 # 648 # To see the latest fingerprint, make a get() request to retrieve an image. 649 "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. 650 "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. 651 "sourceImage": "A String", # URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: 652 # - this property, or 653 # - the rawDisk.source property, or 654 # - the sourceDisk property in order to create an image. 655 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images. 656 "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. 657 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image. 658 "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. 659 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. 660 "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. 661 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. 662 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. 663 }, 664 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). 665 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 666 } 667 668 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 669 forceCreate: boolean, Force image creation if true. 670 671Returns: 672 An object of the form: 673 674 { # An Operation resource, used to manage asynchronous API requests. 675 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 676 "clientOperationId": "A String", # [Output Only] Reserved for future use. 677 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 678 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 679 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 680 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 681 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 682 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 683 "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. 684 "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. 685 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 686 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 687 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 688 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 689 { 690 "message": "A String", # [Output Only] A human-readable description of the warning code. 691 "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. 692 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 693 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 694 { 695 "value": "A String", # [Output Only] A warning data value corresponding to the key. 696 "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). 697 }, 698 ], 699 }, 700 ], 701 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 702 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 703 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 704 "name": "A String", # [Output Only] Name of the resource. 705 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 706 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 707 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 708 { 709 "message": "A String", # [Output Only] An optional, human-readable error message. 710 "code": "A String", # [Output Only] The error type identifier for this error. 711 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 712 }, 713 ], 714 }, 715 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 716 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 717 "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. 718 }</pre> 719</div> 720 721<div class="method"> 722 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 723 <pre>Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. 724 725Args: 726 project: string, Project ID for this request. (required) 727 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 728 729You 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. 730 731Currently, only sorting by name or creationTimestamp desc is supported. 732 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) 733 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. 734 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 735 736The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 737 738For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 739 740You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 741 742To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 743 744Returns: 745 An object of the form: 746 747 { # Contains a list of images. 748 "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. 749 "items": [ # [Output Only] A list of Image resources. 750 { # An Image resource. 751 "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. 752 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 753 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 754 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 755 # 756 # The key must meet the following requirements before you can provide it to Compute Engine: 757 # - The key is wrapped using a RSA public key certificate provided by Google. 758 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 759 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 760 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 761 }, 762 "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. 763 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 764 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 765 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 766 # 767 # The key must meet the following requirements before you can provide it to Compute Engine: 768 # - The key is wrapped using a RSA public key certificate provided by Google. 769 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 770 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 771 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 772 }, 773 "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. 774 "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. 775 "a_key": "A String", 776 }, 777 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). 778 "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE. 779 # 780 # For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features. 781 { # Guest OS features. 782 "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. For newer Windows images, the server might also populate this property with the value WINDOWS to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features. 783 }, 784 ], 785 "licenses": [ # Any applicable license URI. 786 "A String", 787 ], 788 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 789 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 790 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW 791 "sourceDisk": "A String", # URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: 792 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk 793 # - projects/project/zones/zone/disks/disk 794 # - zones/zone/disks/disk 795 "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key. 796 # 797 # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). 798 # 799 # Customer-supplied encryption keys do not protect access to metadata of the disk. 800 # 801 # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. 802 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 803 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 804 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 805 # 806 # The key must meet the following requirements before you can provide it to Compute Engine: 807 # - The key is wrapped using a RSA public key certificate provided by Google. 808 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 809 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 810 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 811 }, 812 "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. 813 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 814 "rawDisk": { # The parameters of the raw disk image. 815 "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created. 816 "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both. 817 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created. 818 }, 819 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels 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. 820 # 821 # To see the latest fingerprint, make a get() request to retrieve an image. 822 "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. 823 "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. 824 "sourceImage": "A String", # URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: 825 # - this property, or 826 # - the rawDisk.source property, or 827 # - the sourceDisk property in order to create an image. 828 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images. 829 "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. 830 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image. 831 "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. 832 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. 833 "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. 834 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. 835 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. 836 }, 837 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). 838 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 839 }, 840 ], 841 "kind": "compute#imageList", # Type of resource. 842 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 843 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 844 }</pre> 845</div> 846 847<div class="method"> 848 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 849 <pre>Retrieves the next page of results. 850 851Args: 852 previous_request: The request for the previous page. (required) 853 previous_response: The response from the request for the previous page. (required) 854 855Returns: 856 A request object that you can call 'execute()' on to request the next 857 page. Returns None if there are no more items in the collection. 858 </pre> 859</div> 860 861<div class="method"> 862 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body)</code> 863 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 864 865Args: 866 project: string, Project ID for this request. (required) 867 resource: string, Name of the resource for this request. (required) 868 body: object, The request body. (required) 869 The object takes the form of: 870 871{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 872 # 873 # 874 # 875 # 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. 876 # 877 # **Example** 878 # 879 # { "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"] } ] } 880 # 881 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 882 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 883 { # 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. 884 # 885 # 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 AuditConfig are exempted. 886 # 887 # Example Policy with multiple AuditConfigs: 888 # 889 # { "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" ] } ] } ] } 890 # 891 # 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. 892 "exemptedMembers": [ 893 "A String", 894 ], 895 "auditLogConfigs": [ # The configuration for logging of each type of permission. 896 { # Provides the configuration for logging a type of permissions. Example: 897 # 898 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 899 # 900 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 901 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 902 "A String", 903 ], 904 "logType": "A String", # The log type that this config enables. 905 }, 906 ], 907 "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. 908 }, 909 ], 910 "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. 911 { # A rule to be applied in a Policy. 912 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 913 { # Specifies what kind of log the caller must write 914 "counter": { # Options for counters # Counter options. 915 "field": "A String", # The field value to attribute. 916 "metric": "A String", # The metric to update. 917 }, 918 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 919 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 920 }, 921 }, 922 ], 923 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 924 "A String", 925 ], 926 "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. 927 "A String", 928 ], 929 "action": "A String", # Required 930 "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. 931 "A String", 932 ], 933 "conditions": [ # Additional restrictions that must be met 934 { # A condition to be met. 935 "iam": "A String", # Trusted attributes supplied by the IAM system. 936 "svc": "A String", # Trusted attributes discharged by the service. 937 "value": "A String", # DEPRECATED. Use 'values' instead. 938 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 939 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 940 "A String", 941 ], 942 "op": "A String", # An operator to apply the subject with. 943 }, 944 ], 945 "description": "A String", # Human-readable description of the rule. 946 }, 947 ], 948 "version": 42, # Version of the `Policy`. The default version is 0. 949 "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. 950 # 951 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 952 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 953 { # Associates `members` with a `role`. 954 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 955 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 956 # 957 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 958 # 959 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 960 # 961 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. 962 # 963 # 964 # 965 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 966 # 967 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 968 # 969 # 970 # 971 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 972 "A String", 973 ], 974 }, 975 ], 976 "iamOwned": True or False, 977} 978 979 980Returns: 981 An object of the form: 982 983 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 984 # 985 # 986 # 987 # 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. 988 # 989 # **Example** 990 # 991 # { "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"] } ] } 992 # 993 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 994 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 995 { # 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. 996 # 997 # 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 AuditConfig are exempted. 998 # 999 # Example Policy with multiple AuditConfigs: 1000 # 1001 # { "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" ] } ] } ] } 1002 # 1003 # 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. 1004 "exemptedMembers": [ 1005 "A String", 1006 ], 1007 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1008 { # Provides the configuration for logging a type of permissions. Example: 1009 # 1010 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 1011 # 1012 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 1013 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 1014 "A String", 1015 ], 1016 "logType": "A String", # The log type that this config enables. 1017 }, 1018 ], 1019 "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. 1020 }, 1021 ], 1022 "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. 1023 { # A rule to be applied in a Policy. 1024 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 1025 { # Specifies what kind of log the caller must write 1026 "counter": { # Options for counters # Counter options. 1027 "field": "A String", # The field value to attribute. 1028 "metric": "A String", # The metric to update. 1029 }, 1030 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 1031 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 1032 }, 1033 }, 1034 ], 1035 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 1036 "A String", 1037 ], 1038 "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. 1039 "A String", 1040 ], 1041 "action": "A String", # Required 1042 "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. 1043 "A String", 1044 ], 1045 "conditions": [ # Additional restrictions that must be met 1046 { # A condition to be met. 1047 "iam": "A String", # Trusted attributes supplied by the IAM system. 1048 "svc": "A String", # Trusted attributes discharged by the service. 1049 "value": "A String", # DEPRECATED. Use 'values' instead. 1050 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 1051 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 1052 "A String", 1053 ], 1054 "op": "A String", # An operator to apply the subject with. 1055 }, 1056 ], 1057 "description": "A String", # Human-readable description of the rule. 1058 }, 1059 ], 1060 "version": 42, # Version of the `Policy`. The default version is 0. 1061 "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. 1062 # 1063 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 1064 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 1065 { # Associates `members` with a `role`. 1066 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1067 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 1068 # 1069 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 1070 # 1071 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1072 # 1073 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. 1074 # 1075 # 1076 # 1077 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 1078 # 1079 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 1080 # 1081 # 1082 # 1083 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 1084 "A String", 1085 ], 1086 }, 1087 ], 1088 "iamOwned": True or False, 1089 }</pre> 1090</div> 1091 1092<div class="method"> 1093 <code class="details" id="setLabels">setLabels(project, resource, body)</code> 1094 <pre>Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation. 1095 1096Args: 1097 project: string, Project ID for this request. (required) 1098 resource: string, Name of the resource for this request. (required) 1099 body: object, The request body. (required) 1100 The object takes the form of: 1101 1102{ 1103 "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 when updating or changing labels. Make a get() request to the resource to get the latest fingerprint. 1104 "labels": { # A list of labels to apply for this resource. Each label key & value must 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. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": ""). 1105 "a_key": "A String", 1106 }, 1107 } 1108 1109 1110Returns: 1111 An object of the form: 1112 1113 { # An Operation resource, used to manage asynchronous API requests. 1114 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1115 "clientOperationId": "A String", # [Output Only] Reserved for future use. 1116 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1117 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1118 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 1119 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1120 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1121 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1122 "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. 1123 "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. 1124 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1125 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1126 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1127 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1128 { 1129 "message": "A String", # [Output Only] A human-readable description of the warning code. 1130 "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. 1131 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1132 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1133 { 1134 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1135 "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). 1136 }, 1137 ], 1138 }, 1139 ], 1140 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1141 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1142 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1143 "name": "A String", # [Output Only] Name of the resource. 1144 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 1145 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1146 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1147 { 1148 "message": "A String", # [Output Only] An optional, human-readable error message. 1149 "code": "A String", # [Output Only] The error type identifier for this error. 1150 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1151 }, 1152 ], 1153 }, 1154 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1155 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1156 "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. 1157 }</pre> 1158</div> 1159 1160<div class="method"> 1161 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 1162 <pre>Returns permissions that a caller has on the specified resource. 1163 1164Args: 1165 project: string, Project ID for this request. (required) 1166 resource: string, Name of the resource for this request. (required) 1167 body: object, The request body. (required) 1168 The object takes the form of: 1169 1170{ 1171 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1172 "A String", 1173 ], 1174 } 1175 1176 1177Returns: 1178 An object of the form: 1179 1180 { 1181 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1182 "A String", 1183 ], 1184 }</pre> 1185</div> 1186 1187</body></html>