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.backendBuckets.html">backendBuckets</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#addSignedUrlKey">addSignedUrlKey(project, backendBucket, body, requestId=None)</a></code></p> 79<p class="firstline">Adds a key for validating requests with signed URLs for this backend bucket.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, backendBucket, requestId=None)</a></code></p> 82<p class="firstline">Deletes the specified BackendBucket resource.</p> 83<p class="toc_element"> 84 <code><a href="#deleteSignedUrlKey">deleteSignedUrlKey(project, backendBucket, keyName, requestId=None)</a></code></p> 85<p class="firstline">Deletes a key for validating requests with signed URLs for this backend bucket.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(project, backendBucket)</a></code></p> 88<p class="firstline">Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.</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)</a></code></p> 94<p class="firstline">Creates a BackendBucket resource 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 BackendBucket resources available to the specified project.</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="#patch">patch(project, backendBucket, body, requestId=None)</a></code></p> 103<p class="firstline">Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p> 104<p class="toc_element"> 105 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body)</a></code></p> 106<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</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<p class="toc_element"> 111 <code><a href="#update">update(project, backendBucket, body, requestId=None)</a></code></p> 112<p class="firstline">Updates the specified BackendBucket resource with the data included in the request.</p> 113<h3>Method Details</h3> 114<div class="method"> 115 <code class="details" id="addSignedUrlKey">addSignedUrlKey(project, backendBucket, body, requestId=None)</code> 116 <pre>Adds a key for validating requests with signed URLs for this backend bucket. 117 118Args: 119 project: string, Project ID for this request. (required) 120 backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required) 121 body: object, The request body. (required) 122 The object takes the form of: 123 124{ # Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs 125 "keyName": "A String", # Name of the key. 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. 126 "keyValue": "A String", # 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string. 127 } 128 129 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 130 131For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 132 133The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 134 135Returns: 136 An object of the form: 137 138 { # Represents an Operation resource. 139 # 140 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 141 # 142 # Operations can be global, regional or zonal. 143 # - For global operations, use the globalOperations resource. 144 # - For regional operations, use the regionOperations resource. 145 # - For zonal operations, use the zonalOperations resource. 146 # 147 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 148 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 149 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 150 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 151 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 152 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 153 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 154 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 155 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 156 "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. 157 "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. 158 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 159 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 160 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 161 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 162 { 163 "message": "A String", # [Output Only] A human-readable description of the warning code. 164 "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. 165 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 166 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 167 { 168 "value": "A String", # [Output Only] A warning data value corresponding to the key. 169 "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). 170 }, 171 ], 172 }, 173 ], 174 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 175 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 176 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 177 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 178 "name": "A String", # [Output Only] Name of the resource. 179 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 180 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 181 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 182 { 183 "message": "A String", # [Output Only] An optional, human-readable error message. 184 "code": "A String", # [Output Only] The error type identifier for this error. 185 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 186 }, 187 ], 188 }, 189 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 190 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 191 "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. 192 }</pre> 193</div> 194 195<div class="method"> 196 <code class="details" id="delete">delete(project, backendBucket, requestId=None)</code> 197 <pre>Deletes the specified BackendBucket resource. 198 199Args: 200 project: string, Project ID for this request. (required) 201 backendBucket: string, Name of the BackendBucket resource to delete. (required) 202 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 203 204For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 205 206The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 207 208Returns: 209 An object of the form: 210 211 { # Represents an Operation resource. 212 # 213 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 214 # 215 # Operations can be global, regional or zonal. 216 # - For global operations, use the globalOperations resource. 217 # - For regional operations, use the regionOperations resource. 218 # - For zonal operations, use the zonalOperations resource. 219 # 220 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 221 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 222 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 223 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 224 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 225 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 226 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 227 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 228 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 229 "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. 230 "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. 231 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 232 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 233 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 234 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 235 { 236 "message": "A String", # [Output Only] A human-readable description of the warning code. 237 "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. 238 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 239 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 240 { 241 "value": "A String", # [Output Only] A warning data value corresponding to the key. 242 "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). 243 }, 244 ], 245 }, 246 ], 247 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 248 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 249 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 250 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 251 "name": "A String", # [Output Only] Name of the resource. 252 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 253 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 254 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 255 { 256 "message": "A String", # [Output Only] An optional, human-readable error message. 257 "code": "A String", # [Output Only] The error type identifier for this error. 258 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 259 }, 260 ], 261 }, 262 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 263 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 264 "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. 265 }</pre> 266</div> 267 268<div class="method"> 269 <code class="details" id="deleteSignedUrlKey">deleteSignedUrlKey(project, backendBucket, keyName, requestId=None)</code> 270 <pre>Deletes a key for validating requests with signed URLs for this backend bucket. 271 272Args: 273 project: string, Project ID for this request. (required) 274 backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required) 275 keyName: string, The name of the Signed URL Key to delete. (required) 276 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 277 278For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 279 280The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 281 282Returns: 283 An object of the form: 284 285 { # Represents an Operation resource. 286 # 287 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 288 # 289 # Operations can be global, regional or zonal. 290 # - For global operations, use the globalOperations resource. 291 # - For regional operations, use the regionOperations resource. 292 # - For zonal operations, use the zonalOperations resource. 293 # 294 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 295 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 296 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 297 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 298 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 299 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 300 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 301 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 302 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 303 "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. 304 "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. 305 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 306 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 307 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 308 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 309 { 310 "message": "A String", # [Output Only] A human-readable description of the warning code. 311 "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. 312 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 313 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 314 { 315 "value": "A String", # [Output Only] A warning data value corresponding to the key. 316 "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). 317 }, 318 ], 319 }, 320 ], 321 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 322 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 323 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 324 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 325 "name": "A String", # [Output Only] Name of the resource. 326 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 327 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 328 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 329 { 330 "message": "A String", # [Output Only] An optional, human-readable error message. 331 "code": "A String", # [Output Only] The error type identifier for this error. 332 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 333 }, 334 ], 335 }, 336 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 337 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 338 "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. 339 }</pre> 340</div> 341 342<div class="method"> 343 <code class="details" id="get">get(project, backendBucket)</code> 344 <pre>Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. 345 346Args: 347 project: string, Project ID for this request. (required) 348 backendBucket: string, Name of the BackendBucket resource to return. (required) 349 350Returns: 351 An object of the form: 352 353 { # A BackendBucket resource. This resource defines a Cloud Storage bucket. 354 "kind": "compute#backendBucket", # Type of the resource. 355 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 356 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 357 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 358 "A String", 359 ], 360 "signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. 361 }, 362 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 363 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 364 "bucketName": "A String", # Cloud Storage bucket name. 365 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 366 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 367 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 368 "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. 369 }</pre> 370</div> 371 372<div class="method"> 373 <code class="details" id="getIamPolicy">getIamPolicy(project, resource)</code> 374 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 375 376Args: 377 project: string, Project ID for this request. (required) 378 resource: string, Name or id of the resource for this request. (required) 379 380Returns: 381 An object of the form: 382 383 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 384 # 385 # 386 # 387 # 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. 388 # 389 # **JSON Example** 390 # 391 # { "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"] } ] } 392 # 393 # **YAML Example** 394 # 395 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer 396 # 397 # 398 # 399 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). 400 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 401 { # 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. 402 # 403 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. 404 # 405 # Example Policy with multiple AuditConfigs: 406 # 407 # { "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" ] } ] } ] } 408 # 409 # 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. 410 "exemptedMembers": [ 411 "A String", 412 ], 413 "auditLogConfigs": [ # The configuration for logging of each type of permission. 414 { # Provides the configuration for logging a type of permissions. Example: 415 # 416 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 417 # 418 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 419 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 420 "A String", 421 ], 422 "logType": "A String", # The log type that this config enables. 423 }, 424 ], 425 "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. 426 }, 427 ], 428 "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. 429 { # A rule to be applied in a Policy. 430 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 431 { # Specifies what kind of log the caller must write 432 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. 433 # 434 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. 435 # 436 # Field names correspond to IAM request parameters and field values are their respective values. 437 # 438 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. 439 # 440 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} 441 # 442 # At this time we do not support multiple field names (though this may be supported in the future). 443 "field": "A String", # The field value to attribute. 444 "metric": "A String", # The metric to update. 445 }, 446 "dataAccess": { # Write a Data Access (Gin) log # Data access options. 447 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. 448 }, 449 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 450 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 451 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. 452 "permissionType": "A String", # The type of the permission that was checked. 453 }, 454 }, 455 }, 456 ], 457 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 458 "A String", 459 ], 460 "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. 461 "A String", 462 ], 463 "action": "A String", # Required 464 "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. 465 "A String", 466 ], 467 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. 468 { # A condition to be met. 469 "iam": "A String", # Trusted attributes supplied by the IAM system. 470 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 471 "values": [ # The objects of the condition. 472 "A String", 473 ], 474 "svc": "A String", # Trusted attributes discharged by the service. 475 "op": "A String", # An operator to apply the subject with. 476 }, 477 ], 478 "description": "A String", # Human-readable description of the rule. 479 }, 480 ], 481 "version": 42, # Deprecated. 482 "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. 483 # 484 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 485 "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. 486 { # Associates `members` with a `role`. 487 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 488 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 489 # 490 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 491 # 492 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 493 # 494 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 495 # 496 # 497 # 498 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 499 # 500 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 501 # 502 # 503 # 504 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 505 "A String", 506 ], 507 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 508 # 509 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 510 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 511 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 512 # 513 # The application context of the containing message determines which well-known feature set of CEL is supported. 514 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 515 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 516 }, 517 }, 518 ], 519 "iamOwned": True or False, 520 }</pre> 521</div> 522 523<div class="method"> 524 <code class="details" id="insert">insert(project, body, requestId=None)</code> 525 <pre>Creates a BackendBucket resource in the specified project using the data included in the request. 526 527Args: 528 project: string, Project ID for this request. (required) 529 body: object, The request body. (required) 530 The object takes the form of: 531 532{ # A BackendBucket resource. This resource defines a Cloud Storage bucket. 533 "kind": "compute#backendBucket", # Type of the resource. 534 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 535 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 536 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 537 "A String", 538 ], 539 "signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. 540 }, 541 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 542 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 543 "bucketName": "A String", # Cloud Storage bucket name. 544 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 545 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 546 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 547 "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. 548 } 549 550 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 551 552For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 553 554The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 555 556Returns: 557 An object of the form: 558 559 { # Represents an Operation resource. 560 # 561 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 562 # 563 # Operations can be global, regional or zonal. 564 # - For global operations, use the globalOperations resource. 565 # - For regional operations, use the regionOperations resource. 566 # - For zonal operations, use the zonalOperations resource. 567 # 568 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 569 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 570 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 571 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 572 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 573 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 574 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 575 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 576 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 577 "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. 578 "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. 579 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 580 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 581 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 582 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 583 { 584 "message": "A String", # [Output Only] A human-readable description of the warning code. 585 "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. 586 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 587 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 588 { 589 "value": "A String", # [Output Only] A warning data value corresponding to the key. 590 "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). 591 }, 592 ], 593 }, 594 ], 595 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 596 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 597 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 598 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 599 "name": "A String", # [Output Only] Name of the resource. 600 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 601 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 602 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 603 { 604 "message": "A String", # [Output Only] An optional, human-readable error message. 605 "code": "A String", # [Output Only] The error type identifier for this error. 606 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 607 }, 608 ], 609 }, 610 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 611 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 612 "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. 613 }</pre> 614</div> 615 616<div class="method"> 617 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 618 <pre>Retrieves the list of BackendBucket resources available to the specified project. 619 620Args: 621 project: string, Project ID for this request. (required) 622 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 623 624You 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. 625 626Currently, only sorting by name or creationTimestamp desc is supported. 627 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) 628 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. 629 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 630 631For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 632 633You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. 634 635To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). 636 637Returns: 638 An object of the form: 639 640 { # Contains a list of BackendBucket resources. 641 "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. 642 "kind": "compute#backendBucketList", # Type of resource. 643 "items": [ # A list of BackendBucket resources. 644 { # A BackendBucket resource. This resource defines a Cloud Storage bucket. 645 "kind": "compute#backendBucket", # Type of the resource. 646 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 647 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 648 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 649 "A String", 650 ], 651 "signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. 652 }, 653 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 654 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 655 "bucketName": "A String", # Cloud Storage bucket name. 656 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 657 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 658 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 659 "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. 660 }, 661 ], 662 "warning": { # [Output Only] Informational warning message. 663 "message": "A String", # [Output Only] A human-readable description of the warning code. 664 "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. 665 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 666 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 667 { 668 "value": "A String", # [Output Only] A warning data value corresponding to the key. 669 "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). 670 }, 671 ], 672 }, 673 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 674 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 675 }</pre> 676</div> 677 678<div class="method"> 679 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 680 <pre>Retrieves the next page of results. 681 682Args: 683 previous_request: The request for the previous page. (required) 684 previous_response: The response from the request for the previous page. (required) 685 686Returns: 687 A request object that you can call 'execute()' on to request the next 688 page. Returns None if there are no more items in the collection. 689 </pre> 690</div> 691 692<div class="method"> 693 <code class="details" id="patch">patch(project, backendBucket, body, requestId=None)</code> 694 <pre>Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. 695 696Args: 697 project: string, Project ID for this request. (required) 698 backendBucket: string, Name of the BackendBucket resource to patch. (required) 699 body: object, The request body. (required) 700 The object takes the form of: 701 702{ # A BackendBucket resource. This resource defines a Cloud Storage bucket. 703 "kind": "compute#backendBucket", # Type of the resource. 704 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 705 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 706 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 707 "A String", 708 ], 709 "signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. 710 }, 711 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 712 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 713 "bucketName": "A String", # Cloud Storage bucket name. 714 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 715 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 716 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 717 "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. 718 } 719 720 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 721 722For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 723 724The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 725 726Returns: 727 An object of the form: 728 729 { # Represents an Operation resource. 730 # 731 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 732 # 733 # Operations can be global, regional or zonal. 734 # - For global operations, use the globalOperations resource. 735 # - For regional operations, use the regionOperations resource. 736 # - For zonal operations, use the zonalOperations resource. 737 # 738 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 739 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 740 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 741 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 742 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 743 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 744 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 745 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 746 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 747 "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. 748 "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. 749 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 750 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 751 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 752 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 753 { 754 "message": "A String", # [Output Only] A human-readable description of the warning code. 755 "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. 756 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 757 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 758 { 759 "value": "A String", # [Output Only] A warning data value corresponding to the key. 760 "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). 761 }, 762 ], 763 }, 764 ], 765 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 766 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 767 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 768 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 769 "name": "A String", # [Output Only] Name of the resource. 770 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 771 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 772 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 773 { 774 "message": "A String", # [Output Only] An optional, human-readable error message. 775 "code": "A String", # [Output Only] The error type identifier for this error. 776 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 777 }, 778 ], 779 }, 780 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 781 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 782 "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. 783 }</pre> 784</div> 785 786<div class="method"> 787 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body)</code> 788 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 789 790Args: 791 project: string, Project ID for this request. (required) 792 resource: string, Name or id of the resource for this request. (required) 793 body: object, The request body. (required) 794 The object takes the form of: 795 796{ 797 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. 798 # 799 # 800 # 801 # 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. 802 # 803 # **JSON Example** 804 # 805 # { "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"] } ] } 806 # 807 # **YAML Example** 808 # 809 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer 810 # 811 # 812 # 813 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). 814 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 815 { # 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. 816 # 817 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. 818 # 819 # Example Policy with multiple AuditConfigs: 820 # 821 # { "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" ] } ] } ] } 822 # 823 # 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. 824 "exemptedMembers": [ 825 "A String", 826 ], 827 "auditLogConfigs": [ # The configuration for logging of each type of permission. 828 { # Provides the configuration for logging a type of permissions. Example: 829 # 830 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 831 # 832 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 833 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 834 "A String", 835 ], 836 "logType": "A String", # The log type that this config enables. 837 }, 838 ], 839 "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. 840 }, 841 ], 842 "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. 843 { # A rule to be applied in a Policy. 844 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 845 { # Specifies what kind of log the caller must write 846 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. 847 # 848 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. 849 # 850 # Field names correspond to IAM request parameters and field values are their respective values. 851 # 852 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. 853 # 854 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} 855 # 856 # At this time we do not support multiple field names (though this may be supported in the future). 857 "field": "A String", # The field value to attribute. 858 "metric": "A String", # The metric to update. 859 }, 860 "dataAccess": { # Write a Data Access (Gin) log # Data access options. 861 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. 862 }, 863 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 864 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 865 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. 866 "permissionType": "A String", # The type of the permission that was checked. 867 }, 868 }, 869 }, 870 ], 871 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 872 "A String", 873 ], 874 "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. 875 "A String", 876 ], 877 "action": "A String", # Required 878 "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. 879 "A String", 880 ], 881 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. 882 { # A condition to be met. 883 "iam": "A String", # Trusted attributes supplied by the IAM system. 884 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 885 "values": [ # The objects of the condition. 886 "A String", 887 ], 888 "svc": "A String", # Trusted attributes discharged by the service. 889 "op": "A String", # An operator to apply the subject with. 890 }, 891 ], 892 "description": "A String", # Human-readable description of the rule. 893 }, 894 ], 895 "version": 42, # Deprecated. 896 "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. 897 # 898 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 899 "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. 900 { # Associates `members` with a `role`. 901 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 902 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 903 # 904 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 905 # 906 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 907 # 908 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 909 # 910 # 911 # 912 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 913 # 914 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 915 # 916 # 917 # 918 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 919 "A String", 920 ], 921 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 922 # 923 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 924 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 925 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 926 # 927 # The application context of the containing message determines which well-known feature set of CEL is supported. 928 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 929 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 930 }, 931 }, 932 ], 933 "iamOwned": True or False, 934 }, 935 "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. 936 { # Associates `members` with a `role`. 937 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 938 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 939 # 940 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 941 # 942 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 943 # 944 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 945 # 946 # 947 # 948 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 949 # 950 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 951 # 952 # 953 # 954 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 955 "A String", 956 ], 957 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 958 # 959 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 960 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 961 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 962 # 963 # The application context of the containing message determines which well-known feature set of CEL is supported. 964 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 965 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 966 }, 967 }, 968 ], 969 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. 970 } 971 972 973Returns: 974 An object of the form: 975 976 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 977 # 978 # 979 # 980 # 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. 981 # 982 # **JSON Example** 983 # 984 # { "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"] } ] } 985 # 986 # **YAML Example** 987 # 988 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer 989 # 990 # 991 # 992 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). 993 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 994 { # 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. 995 # 996 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. 997 # 998 # Example Policy with multiple AuditConfigs: 999 # 1000 # { "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" ] } ] } ] } 1001 # 1002 # 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. 1003 "exemptedMembers": [ 1004 "A String", 1005 ], 1006 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1007 { # Provides the configuration for logging a type of permissions. Example: 1008 # 1009 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 1010 # 1011 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 1012 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 1013 "A String", 1014 ], 1015 "logType": "A String", # The log type that this config enables. 1016 }, 1017 ], 1018 "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. 1019 }, 1020 ], 1021 "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. 1022 { # A rule to be applied in a Policy. 1023 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 1024 { # Specifies what kind of log the caller must write 1025 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. 1026 # 1027 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. 1028 # 1029 # Field names correspond to IAM request parameters and field values are their respective values. 1030 # 1031 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. 1032 # 1033 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} 1034 # 1035 # At this time we do not support multiple field names (though this may be supported in the future). 1036 "field": "A String", # The field value to attribute. 1037 "metric": "A String", # The metric to update. 1038 }, 1039 "dataAccess": { # Write a Data Access (Gin) log # Data access options. 1040 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. 1041 }, 1042 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 1043 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 1044 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. 1045 "permissionType": "A String", # The type of the permission that was checked. 1046 }, 1047 }, 1048 }, 1049 ], 1050 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 1051 "A String", 1052 ], 1053 "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. 1054 "A String", 1055 ], 1056 "action": "A String", # Required 1057 "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. 1058 "A String", 1059 ], 1060 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. 1061 { # A condition to be met. 1062 "iam": "A String", # Trusted attributes supplied by the IAM system. 1063 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 1064 "values": [ # The objects of the condition. 1065 "A String", 1066 ], 1067 "svc": "A String", # Trusted attributes discharged by the service. 1068 "op": "A String", # An operator to apply the subject with. 1069 }, 1070 ], 1071 "description": "A String", # Human-readable description of the rule. 1072 }, 1073 ], 1074 "version": 42, # Deprecated. 1075 "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. 1076 # 1077 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 1078 "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. 1079 { # Associates `members` with a `role`. 1080 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1081 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 1082 # 1083 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 1084 # 1085 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1086 # 1087 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 1088 # 1089 # 1090 # 1091 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 1092 # 1093 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 1094 # 1095 # 1096 # 1097 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1098 "A String", 1099 ], 1100 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1101 # 1102 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 1103 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 1104 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1105 # 1106 # The application context of the containing message determines which well-known feature set of CEL is supported. 1107 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1108 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1109 }, 1110 }, 1111 ], 1112 "iamOwned": True or False, 1113 }</pre> 1114</div> 1115 1116<div class="method"> 1117 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 1118 <pre>Returns permissions that a caller has on the specified resource. 1119 1120Args: 1121 project: string, Project ID for this request. (required) 1122 resource: string, Name or id of the resource for this request. (required) 1123 body: object, The request body. (required) 1124 The object takes the form of: 1125 1126{ 1127 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1128 "A String", 1129 ], 1130 } 1131 1132 1133Returns: 1134 An object of the form: 1135 1136 { 1137 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1138 "A String", 1139 ], 1140 }</pre> 1141</div> 1142 1143<div class="method"> 1144 <code class="details" id="update">update(project, backendBucket, body, requestId=None)</code> 1145 <pre>Updates the specified BackendBucket resource with the data included in the request. 1146 1147Args: 1148 project: string, Project ID for this request. (required) 1149 backendBucket: string, Name of the BackendBucket resource to update. (required) 1150 body: object, The request body. (required) 1151 The object takes the form of: 1152 1153{ # A BackendBucket resource. This resource defines a Cloud Storage bucket. 1154 "kind": "compute#backendBucket", # Type of the resource. 1155 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 1156 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 1157 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 1158 "A String", 1159 ], 1160 "signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. 1161 }, 1162 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 1163 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1164 "bucketName": "A String", # Cloud Storage bucket name. 1165 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1166 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 1167 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1168 "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. 1169 } 1170 1171 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 1172 1173For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 1174 1175The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 1176 1177Returns: 1178 An object of the form: 1179 1180 { # Represents an Operation resource. 1181 # 1182 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1183 # 1184 # Operations can be global, regional or zonal. 1185 # - For global operations, use the globalOperations resource. 1186 # - For regional operations, use the regionOperations resource. 1187 # - For zonal operations, use the zonalOperations resource. 1188 # 1189 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 1190 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1191 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1192 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1193 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1194 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1195 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1196 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1197 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1198 "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. 1199 "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. 1200 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1201 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1202 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1203 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1204 { 1205 "message": "A String", # [Output Only] A human-readable description of the warning code. 1206 "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. 1207 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1208 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1209 { 1210 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1211 "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). 1212 }, 1213 ], 1214 }, 1215 ], 1216 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1217 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1218 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1219 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1220 "name": "A String", # [Output Only] Name of the resource. 1221 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1222 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1223 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1224 { 1225 "message": "A String", # [Output Only] An optional, human-readable error message. 1226 "code": "A String", # [Output Only] The error type identifier for this error. 1227 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1228 }, 1229 ], 1230 }, 1231 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1232 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1233 "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. 1234 }</pre> 1235</div> 1236 1237</body></html>