1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.backendBuckets.html">backendBuckets</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#addSignedUrlKey">addSignedUrlKey(project, backendBucket, body=None, requestId=None, x__xgafv=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="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(project, backendBucket, requestId=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes the specified BackendBucket resource.</p> 86<p class="toc_element"> 87 <code><a href="#deleteSignedUrlKey">deleteSignedUrlKey(project, backendBucket, keyName, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes a key for validating requests with signed URLs for this backend bucket.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(project, backendBucket, x__xgafv=None)</a></code></p> 91<p class="firstline">Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.</p> 92<p class="toc_element"> 93 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> 95<p class="toc_element"> 96 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Creates a BackendBucket resource in the specified project using the data included in the request.</p> 98<p class="toc_element"> 99 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Retrieves the list of BackendBucket resources available to the specified project.</p> 101<p class="toc_element"> 102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 103<p class="firstline">Retrieves the next page of results.</p> 104<p class="toc_element"> 105 <code><a href="#patch">patch(project, backendBucket, body=None, requestId=None, x__xgafv=None)</a></code></p> 106<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> 107<p class="toc_element"> 108 <code><a href="#setEdgeSecurityPolicy">setEdgeSecurityPolicy(project, backendBucket, body=None, requestId=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Sets the edge security policy for the specified backend bucket.</p> 110<p class="toc_element"> 111 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 113<p class="toc_element"> 114 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 116<p class="toc_element"> 117 <code><a href="#update">update(project, backendBucket, body=None, requestId=None, x__xgafv=None)</a></code></p> 118<p class="firstline">Updates the specified BackendBucket resource with the data included in the request.</p> 119<h3>Method Details</h3> 120<div class="method"> 121 <code class="details" id="addSignedUrlKey">addSignedUrlKey(project, backendBucket, body=None, requestId=None, x__xgafv=None)</code> 122 <pre>Adds a key for validating requests with signed URLs for this backend bucket. 123 124Args: 125 project: string, Project ID for this request. (required) 126 backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required) 127 body: object, The request body. 128 The object takes the form of: 129 130{ # Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs 131 "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. 132 "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. 133} 134 135 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 136 x__xgafv: string, V1 error format. 137 Allowed values 138 1 - v1 error format 139 2 - v2 error format 140 141Returns: 142 An object of the form: 143 144 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 145 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 146 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 147 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 148 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 149 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 150 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 151 { 152 "code": "A String", # [Output Only] The error type identifier for this error. 153 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 154 "message": "A String", # [Output Only] An optional, human-readable error message. 155 }, 156 ], 157 }, 158 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 159 "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. 160 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 161 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 162 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 163 "name": "A String", # [Output Only] Name of the operation. 164 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 165 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 166 "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. 167 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 168 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 169 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 170 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 171 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 172 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 173 "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. 174 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 175 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 176 { 177 "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. 178 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 179 { 180 "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). 181 "value": "A String", # [Output Only] A warning data value corresponding to the key. 182 }, 183 ], 184 "message": "A String", # [Output Only] A human-readable description of the warning code. 185 }, 186 ], 187 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 188}</pre> 189</div> 190 191<div class="method"> 192 <code class="details" id="close">close()</code> 193 <pre>Close httplib2 connections.</pre> 194</div> 195 196<div class="method"> 197 <code class="details" id="delete">delete(project, backendBucket, requestId=None, x__xgafv=None)</code> 198 <pre>Deletes the specified BackendBucket resource. 199 200Args: 201 project: string, Project ID for this request. (required) 202 backendBucket: string, Name of the BackendBucket resource to delete. (required) 203 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 204 x__xgafv: string, V1 error format. 205 Allowed values 206 1 - v1 error format 207 2 - v2 error format 208 209Returns: 210 An object of the form: 211 212 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 213 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 214 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 215 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 216 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 217 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 218 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 219 { 220 "code": "A String", # [Output Only] The error type identifier for this error. 221 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 222 "message": "A String", # [Output Only] An optional, human-readable error message. 223 }, 224 ], 225 }, 226 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 227 "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. 228 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 229 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 230 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 231 "name": "A String", # [Output Only] Name of the operation. 232 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 233 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 234 "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. 235 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 236 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 237 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 238 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 239 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 240 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 241 "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. 242 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 243 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 244 { 245 "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. 246 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 247 { 248 "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). 249 "value": "A String", # [Output Only] A warning data value corresponding to the key. 250 }, 251 ], 252 "message": "A String", # [Output Only] A human-readable description of the warning code. 253 }, 254 ], 255 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 256}</pre> 257</div> 258 259<div class="method"> 260 <code class="details" id="deleteSignedUrlKey">deleteSignedUrlKey(project, backendBucket, keyName, requestId=None, x__xgafv=None)</code> 261 <pre>Deletes a key for validating requests with signed URLs for this backend bucket. 262 263Args: 264 project: string, Project ID for this request. (required) 265 backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required) 266 keyName: string, The name of the Signed URL Key to delete. (required) 267 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 268 x__xgafv: string, V1 error format. 269 Allowed values 270 1 - v1 error format 271 2 - v2 error format 272 273Returns: 274 An object of the form: 275 276 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 277 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 278 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 279 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 280 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 281 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 282 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 283 { 284 "code": "A String", # [Output Only] The error type identifier for this error. 285 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 286 "message": "A String", # [Output Only] An optional, human-readable error message. 287 }, 288 ], 289 }, 290 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 291 "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. 292 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 293 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 294 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 295 "name": "A String", # [Output Only] Name of the operation. 296 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 297 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 298 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 299 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 300 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 301 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 302 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 303 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 304 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 305 "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. 306 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 307 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 308 { 309 "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. 310 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 311 { 312 "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). 313 "value": "A String", # [Output Only] A warning data value corresponding to the key. 314 }, 315 ], 316 "message": "A String", # [Output Only] A human-readable description of the warning code. 317 }, 318 ], 319 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 320}</pre> 321</div> 322 323<div class="method"> 324 <code class="details" id="get">get(project, backendBucket, x__xgafv=None)</code> 325 <pre>Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. 326 327Args: 328 project: string, Project ID for this request. (required) 329 backendBucket: string, Name of the BackendBucket resource to return. (required) 330 x__xgafv: string, V1 error format. 331 Allowed values 332 1 - v1 error format 333 2 - v2 error format 334 335Returns: 336 An object of the form: 337 338 { # Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets. 339 "bucketName": "A String", # Cloud Storage bucket name. 340 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 341 "bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings. 342 { # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting. 343 "headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive. 344 }, 345 ], 346 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 347 "includeHttpHeaders": [ # Allows HTTP request headers (by name) to be used in the cache key. 348 "A String", 349 ], 350 "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. '&' and '=' will be percent encoded and not treated as delimiters. 351 "A String", 352 ], 353 }, 354 "cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. 355 "clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year). 356 "defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 357 "maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 358 "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. 359 "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists. 360 { # Specify CDN TTLs for response error codes. 361 "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once. 362 "ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 363 }, 364 ], 365 "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin. 366 "serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. 367 "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. 368 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 369 "A String", 370 ], 371 }, 372 "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. 373 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 374 "customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses. 375 "A String", 376 ], 377 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 378 "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend bucket. 379 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 380 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 381 "kind": "compute#backendBucket", # Type of the resource. 382 "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. 383 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 384}</pre> 385</div> 386 387<div class="method"> 388 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code> 389 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 390 391Args: 392 project: string, Project ID for this request. (required) 393 resource: string, Name or id of the resource for this request. (required) 394 optionsRequestedPolicyVersion: integer, Requested IAM Policy version. 395 x__xgafv: string, V1 error format. 396 Allowed values 397 1 - v1 error format 398 2 - v2 error format 399 400Returns: 401 An object of the form: 402 403 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 404 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 405 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 406 "auditLogConfigs": [ # The configuration for logging of each type of permission. 407 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 408 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 409 "A String", 410 ], 411 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 412 "logType": "A String", # The log type that this config enables. 413 }, 414 ], 415 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 416 "A String", 417 ], 418 "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. 419 }, 420 ], 421 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 422 { # Associates `members`, or principals, with a `role`. 423 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 424 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 425 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 426 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 427 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 428 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 429 }, 430 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 431 "A String", 432 ], 433 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 434 }, 435 ], 436 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 437 "rules": [ # This is deprecated and has no effect. Do not use. 438 { # This is deprecated and has no effect. Do not use. 439 "action": "A String", # This is deprecated and has no effect. Do not use. 440 "conditions": [ # This is deprecated and has no effect. Do not use. 441 { # This is deprecated and has no effect. Do not use. 442 "iam": "A String", # This is deprecated and has no effect. Do not use. 443 "op": "A String", # This is deprecated and has no effect. Do not use. 444 "svc": "A String", # This is deprecated and has no effect. Do not use. 445 "sys": "A String", # This is deprecated and has no effect. Do not use. 446 "values": [ # This is deprecated and has no effect. Do not use. 447 "A String", 448 ], 449 }, 450 ], 451 "description": "A String", # This is deprecated and has no effect. Do not use. 452 "ins": [ # This is deprecated and has no effect. Do not use. 453 "A String", 454 ], 455 "logConfigs": [ # This is deprecated and has no effect. Do not use. 456 { # This is deprecated and has no effect. Do not use. 457 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 458 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 459 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 460 }, 461 "logName": "A String", # This is deprecated and has no effect. Do not use. 462 }, 463 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 464 "customFields": [ # This is deprecated and has no effect. Do not use. 465 { # This is deprecated and has no effect. Do not use. 466 "name": "A String", # This is deprecated and has no effect. Do not use. 467 "value": "A String", # This is deprecated and has no effect. Do not use. 468 }, 469 ], 470 "field": "A String", # This is deprecated and has no effect. Do not use. 471 "metric": "A String", # This is deprecated and has no effect. Do not use. 472 }, 473 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 474 "logMode": "A String", # This is deprecated and has no effect. Do not use. 475 }, 476 }, 477 ], 478 "notIns": [ # This is deprecated and has no effect. Do not use. 479 "A String", 480 ], 481 "permissions": [ # This is deprecated and has no effect. Do not use. 482 "A String", 483 ], 484 }, 485 ], 486 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 487}</pre> 488</div> 489 490<div class="method"> 491 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 492 <pre>Creates a BackendBucket resource in the specified project using the data included in the request. 493 494Args: 495 project: string, Project ID for this request. (required) 496 body: object, The request body. 497 The object takes the form of: 498 499{ # Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets. 500 "bucketName": "A String", # Cloud Storage bucket name. 501 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 502 "bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings. 503 { # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting. 504 "headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive. 505 }, 506 ], 507 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 508 "includeHttpHeaders": [ # Allows HTTP request headers (by name) to be used in the cache key. 509 "A String", 510 ], 511 "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. '&' and '=' will be percent encoded and not treated as delimiters. 512 "A String", 513 ], 514 }, 515 "cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. 516 "clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year). 517 "defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 518 "maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 519 "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. 520 "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists. 521 { # Specify CDN TTLs for response error codes. 522 "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once. 523 "ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 524 }, 525 ], 526 "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin. 527 "serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. 528 "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. 529 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 530 "A String", 531 ], 532 }, 533 "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. 534 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 535 "customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses. 536 "A String", 537 ], 538 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 539 "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend bucket. 540 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 541 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 542 "kind": "compute#backendBucket", # Type of the resource. 543 "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. 544 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 545} 546 547 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 548 x__xgafv: string, V1 error format. 549 Allowed values 550 1 - v1 error format 551 2 - v2 error format 552 553Returns: 554 An object of the form: 555 556 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 557 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 558 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 559 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 560 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 561 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 562 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 563 { 564 "code": "A String", # [Output Only] The error type identifier for this error. 565 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 566 "message": "A String", # [Output Only] An optional, human-readable error message. 567 }, 568 ], 569 }, 570 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 571 "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. 572 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 573 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 574 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 575 "name": "A String", # [Output Only] Name of the operation. 576 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 577 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 578 "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. 579 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 580 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 581 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 582 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 583 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 584 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 585 "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. 586 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 587 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 588 { 589 "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. 590 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 591 { 592 "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). 593 "value": "A String", # [Output Only] A warning data value corresponding to the key. 594 }, 595 ], 596 "message": "A String", # [Output Only] A human-readable description of the warning code. 597 }, 598 ], 599 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 600}</pre> 601</div> 602 603<div class="method"> 604 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 605 <pre>Retrieves the list of BackendBucket resources available to the specified project. 606 607Args: 608 project: string, Project ID for this request. (required) 609 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 610 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`) 611 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 612 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. 613 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 614 x__xgafv: string, V1 error format. 615 Allowed values 616 1 - v1 error format 617 2 - v2 error format 618 619Returns: 620 An object of the form: 621 622 { # Contains a list of BackendBucket resources. 623 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 624 "items": [ # A list of BackendBucket resources. 625 { # Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets. 626 "bucketName": "A String", # Cloud Storage bucket name. 627 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 628 "bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings. 629 { # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting. 630 "headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive. 631 }, 632 ], 633 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 634 "includeHttpHeaders": [ # Allows HTTP request headers (by name) to be used in the cache key. 635 "A String", 636 ], 637 "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. '&' and '=' will be percent encoded and not treated as delimiters. 638 "A String", 639 ], 640 }, 641 "cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. 642 "clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year). 643 "defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 644 "maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 645 "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. 646 "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists. 647 { # Specify CDN TTLs for response error codes. 648 "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once. 649 "ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 650 }, 651 ], 652 "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin. 653 "serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. 654 "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. 655 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 656 "A String", 657 ], 658 }, 659 "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. 660 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 661 "customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses. 662 "A String", 663 ], 664 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 665 "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend bucket. 666 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 667 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 668 "kind": "compute#backendBucket", # Type of the resource. 669 "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. 670 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 671 }, 672 ], 673 "kind": "compute#backendBucketList", # Type of resource. 674 "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. 675 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 676 "warning": { # [Output Only] Informational warning message. 677 "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. 678 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 679 { 680 "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). 681 "value": "A String", # [Output Only] A warning data value corresponding to the key. 682 }, 683 ], 684 "message": "A String", # [Output Only] A human-readable description of the warning code. 685 }, 686}</pre> 687</div> 688 689<div class="method"> 690 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 691 <pre>Retrieves the next page of results. 692 693Args: 694 previous_request: The request for the previous page. (required) 695 previous_response: The response from the request for the previous page. (required) 696 697Returns: 698 A request object that you can call 'execute()' on to request the next 699 page. Returns None if there are no more items in the collection. 700 </pre> 701</div> 702 703<div class="method"> 704 <code class="details" id="patch">patch(project, backendBucket, body=None, requestId=None, x__xgafv=None)</code> 705 <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. 706 707Args: 708 project: string, Project ID for this request. (required) 709 backendBucket: string, Name of the BackendBucket resource to patch. (required) 710 body: object, The request body. 711 The object takes the form of: 712 713{ # Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets. 714 "bucketName": "A String", # Cloud Storage bucket name. 715 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 716 "bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings. 717 { # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting. 718 "headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive. 719 }, 720 ], 721 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 722 "includeHttpHeaders": [ # Allows HTTP request headers (by name) to be used in the cache key. 723 "A String", 724 ], 725 "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. '&' and '=' will be percent encoded and not treated as delimiters. 726 "A String", 727 ], 728 }, 729 "cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. 730 "clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year). 731 "defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 732 "maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 733 "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. 734 "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists. 735 { # Specify CDN TTLs for response error codes. 736 "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once. 737 "ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 738 }, 739 ], 740 "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin. 741 "serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. 742 "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. 743 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 744 "A String", 745 ], 746 }, 747 "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. 748 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 749 "customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses. 750 "A String", 751 ], 752 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 753 "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend bucket. 754 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 755 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 756 "kind": "compute#backendBucket", # Type of the resource. 757 "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. 758 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 759} 760 761 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 762 x__xgafv: string, V1 error format. 763 Allowed values 764 1 - v1 error format 765 2 - v2 error format 766 767Returns: 768 An object of the form: 769 770 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 771 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 772 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 773 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 774 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 775 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 776 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 777 { 778 "code": "A String", # [Output Only] The error type identifier for this error. 779 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 780 "message": "A String", # [Output Only] An optional, human-readable error message. 781 }, 782 ], 783 }, 784 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 785 "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. 786 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 787 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 788 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 789 "name": "A String", # [Output Only] Name of the operation. 790 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 791 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 792 "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. 793 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 794 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 795 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 796 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 797 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 798 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 799 "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. 800 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 801 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 802 { 803 "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. 804 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 805 { 806 "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). 807 "value": "A String", # [Output Only] A warning data value corresponding to the key. 808 }, 809 ], 810 "message": "A String", # [Output Only] A human-readable description of the warning code. 811 }, 812 ], 813 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 814}</pre> 815</div> 816 817<div class="method"> 818 <code class="details" id="setEdgeSecurityPolicy">setEdgeSecurityPolicy(project, backendBucket, body=None, requestId=None, x__xgafv=None)</code> 819 <pre>Sets the edge security policy for the specified backend bucket. 820 821Args: 822 project: string, Project ID for this request. (required) 823 backendBucket: string, Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. (required) 824 body: object, The request body. 825 The object takes the form of: 826 827{ 828 "securityPolicy": "A String", 829} 830 831 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 832 x__xgafv: string, V1 error format. 833 Allowed values 834 1 - v1 error format 835 2 - v2 error format 836 837Returns: 838 An object of the form: 839 840 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 841 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 842 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 843 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 844 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 845 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 846 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 847 { 848 "code": "A String", # [Output Only] The error type identifier for this error. 849 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 850 "message": "A String", # [Output Only] An optional, human-readable error message. 851 }, 852 ], 853 }, 854 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 855 "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. 856 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 857 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 858 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 859 "name": "A String", # [Output Only] Name of the operation. 860 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 861 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 862 "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. 863 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 864 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 865 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 866 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 867 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 868 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 869 "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. 870 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 871 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 872 { 873 "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. 874 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 875 { 876 "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). 877 "value": "A String", # [Output Only] A warning data value corresponding to the key. 878 }, 879 ], 880 "message": "A String", # [Output Only] A human-readable description of the warning code. 881 }, 882 ], 883 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 884}</pre> 885</div> 886 887<div class="method"> 888 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code> 889 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 890 891Args: 892 project: string, Project ID for this request. (required) 893 resource: string, Name or id of the resource for this request. (required) 894 body: object, The request body. 895 The object takes the form of: 896 897{ 898 "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. 899 { # Associates `members`, or principals, with a `role`. 900 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 901 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 902 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 903 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 904 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 905 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 906 }, 907 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 908 "A String", 909 ], 910 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 911 }, 912 ], 913 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. 914 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # 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. 915 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 916 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 917 "auditLogConfigs": [ # The configuration for logging of each type of permission. 918 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 919 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 920 "A String", 921 ], 922 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 923 "logType": "A String", # The log type that this config enables. 924 }, 925 ], 926 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 927 "A String", 928 ], 929 "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. 930 }, 931 ], 932 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 933 { # Associates `members`, or principals, with a `role`. 934 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 935 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 936 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 937 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 938 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 939 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 940 }, 941 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 942 "A String", 943 ], 944 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 945 }, 946 ], 947 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 948 "rules": [ # This is deprecated and has no effect. Do not use. 949 { # This is deprecated and has no effect. Do not use. 950 "action": "A String", # This is deprecated and has no effect. Do not use. 951 "conditions": [ # This is deprecated and has no effect. Do not use. 952 { # This is deprecated and has no effect. Do not use. 953 "iam": "A String", # This is deprecated and has no effect. Do not use. 954 "op": "A String", # This is deprecated and has no effect. Do not use. 955 "svc": "A String", # This is deprecated and has no effect. Do not use. 956 "sys": "A String", # This is deprecated and has no effect. Do not use. 957 "values": [ # This is deprecated and has no effect. Do not use. 958 "A String", 959 ], 960 }, 961 ], 962 "description": "A String", # This is deprecated and has no effect. Do not use. 963 "ins": [ # This is deprecated and has no effect. Do not use. 964 "A String", 965 ], 966 "logConfigs": [ # This is deprecated and has no effect. Do not use. 967 { # This is deprecated and has no effect. Do not use. 968 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 969 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 970 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 971 }, 972 "logName": "A String", # This is deprecated and has no effect. Do not use. 973 }, 974 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 975 "customFields": [ # This is deprecated and has no effect. Do not use. 976 { # This is deprecated and has no effect. Do not use. 977 "name": "A String", # This is deprecated and has no effect. Do not use. 978 "value": "A String", # This is deprecated and has no effect. Do not use. 979 }, 980 ], 981 "field": "A String", # This is deprecated and has no effect. Do not use. 982 "metric": "A String", # This is deprecated and has no effect. Do not use. 983 }, 984 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 985 "logMode": "A String", # This is deprecated and has no effect. Do not use. 986 }, 987 }, 988 ], 989 "notIns": [ # This is deprecated and has no effect. Do not use. 990 "A String", 991 ], 992 "permissions": [ # This is deprecated and has no effect. Do not use. 993 "A String", 994 ], 995 }, 996 ], 997 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 998 }, 999} 1000 1001 x__xgafv: string, V1 error format. 1002 Allowed values 1003 1 - v1 error format 1004 2 - v2 error format 1005 1006Returns: 1007 An object of the form: 1008 1009 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 1010 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1011 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 1012 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1013 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 1014 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 1015 "A String", 1016 ], 1017 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 1018 "logType": "A String", # The log type that this config enables. 1019 }, 1020 ], 1021 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 1022 "A String", 1023 ], 1024 "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. 1025 }, 1026 ], 1027 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 1028 { # Associates `members`, or principals, with a `role`. 1029 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 1030 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1031 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1032 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1033 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1034 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 1035 }, 1036 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1037 "A String", 1038 ], 1039 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1040 }, 1041 ], 1042 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 1043 "rules": [ # This is deprecated and has no effect. Do not use. 1044 { # This is deprecated and has no effect. Do not use. 1045 "action": "A String", # This is deprecated and has no effect. Do not use. 1046 "conditions": [ # This is deprecated and has no effect. Do not use. 1047 { # This is deprecated and has no effect. Do not use. 1048 "iam": "A String", # This is deprecated and has no effect. Do not use. 1049 "op": "A String", # This is deprecated and has no effect. Do not use. 1050 "svc": "A String", # This is deprecated and has no effect. Do not use. 1051 "sys": "A String", # This is deprecated and has no effect. Do not use. 1052 "values": [ # This is deprecated and has no effect. Do not use. 1053 "A String", 1054 ], 1055 }, 1056 ], 1057 "description": "A String", # This is deprecated and has no effect. Do not use. 1058 "ins": [ # This is deprecated and has no effect. Do not use. 1059 "A String", 1060 ], 1061 "logConfigs": [ # This is deprecated and has no effect. Do not use. 1062 { # This is deprecated and has no effect. Do not use. 1063 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1064 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1065 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 1066 }, 1067 "logName": "A String", # This is deprecated and has no effect. Do not use. 1068 }, 1069 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1070 "customFields": [ # This is deprecated and has no effect. Do not use. 1071 { # This is deprecated and has no effect. Do not use. 1072 "name": "A String", # This is deprecated and has no effect. Do not use. 1073 "value": "A String", # This is deprecated and has no effect. Do not use. 1074 }, 1075 ], 1076 "field": "A String", # This is deprecated and has no effect. Do not use. 1077 "metric": "A String", # This is deprecated and has no effect. Do not use. 1078 }, 1079 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1080 "logMode": "A String", # This is deprecated and has no effect. Do not use. 1081 }, 1082 }, 1083 ], 1084 "notIns": [ # This is deprecated and has no effect. Do not use. 1085 "A String", 1086 ], 1087 "permissions": [ # This is deprecated and has no effect. Do not use. 1088 "A String", 1089 ], 1090 }, 1091 ], 1092 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1093}</pre> 1094</div> 1095 1096<div class="method"> 1097 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> 1098 <pre>Returns permissions that a caller has on the specified resource. 1099 1100Args: 1101 project: string, Project ID for this request. (required) 1102 resource: string, Name or id of the resource for this request. (required) 1103 body: object, The request body. 1104 The object takes the form of: 1105 1106{ 1107 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1108 "A String", 1109 ], 1110} 1111 1112 x__xgafv: string, V1 error format. 1113 Allowed values 1114 1 - v1 error format 1115 2 - v2 error format 1116 1117Returns: 1118 An object of the form: 1119 1120 { 1121 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1122 "A String", 1123 ], 1124}</pre> 1125</div> 1126 1127<div class="method"> 1128 <code class="details" id="update">update(project, backendBucket, body=None, requestId=None, x__xgafv=None)</code> 1129 <pre>Updates the specified BackendBucket resource with the data included in the request. 1130 1131Args: 1132 project: string, Project ID for this request. (required) 1133 backendBucket: string, Name of the BackendBucket resource to update. (required) 1134 body: object, The request body. 1135 The object takes the form of: 1136 1137{ # Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets. 1138 "bucketName": "A String", # Cloud Storage bucket name. 1139 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 1140 "bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings. 1141 { # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting. 1142 "headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive. 1143 }, 1144 ], 1145 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 1146 "includeHttpHeaders": [ # Allows HTTP request headers (by name) to be used in the cache key. 1147 "A String", 1148 ], 1149 "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. '&' and '=' will be percent encoded and not treated as delimiters. 1150 "A String", 1151 ], 1152 }, 1153 "cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. 1154 "clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year). 1155 "defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 1156 "maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 1157 "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy. 1158 "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists. 1159 { # Specify CDN TTLs for response error codes. 1160 "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once. 1161 "ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL. 1162 }, 1163 ], 1164 "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin. 1165 "serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale. 1166 "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. 1167 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 1168 "A String", 1169 ], 1170 }, 1171 "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. 1172 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1173 "customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses. 1174 "A String", 1175 ], 1176 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 1177 "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend bucket. 1178 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 1179 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 1180 "kind": "compute#backendBucket", # Type of the resource. 1181 "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. 1182 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1183} 1184 1185 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 1186 x__xgafv: string, V1 error format. 1187 Allowed values 1188 1 - v1 error format 1189 2 - v2 error format 1190 1191Returns: 1192 An object of the form: 1193 1194 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1195 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1196 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1197 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1198 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1199 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1200 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1201 { 1202 "code": "A String", # [Output Only] The error type identifier for this error. 1203 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1204 "message": "A String", # [Output Only] An optional, human-readable error message. 1205 }, 1206 ], 1207 }, 1208 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1209 "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. 1210 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1211 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1212 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1213 "name": "A String", # [Output Only] Name of the operation. 1214 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1215 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1216 "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. 1217 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1218 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1219 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1220 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1221 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1222 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1223 "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. 1224 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1225 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1226 { 1227 "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. 1228 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1229 { 1230 "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). 1231 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1232 }, 1233 ], 1234 "message": "A String", # [Output Only] A human-readable description of the warning code. 1235 }, 1236 ], 1237 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1238}</pre> 1239</div> 1240 1241</body></html>