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_v1.html">Compute Engine API</a> . <a href="compute_v1.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="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Creates a BackendBucket resource in the specified project using the data included in the request.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Retrieves the list of BackendBucket resources available to the specified project.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#patch">patch(project, backendBucket, body=None, requestId=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p> 104<p class="toc_element"> 105 <code><a href="#setEdgeSecurityPolicy">setEdgeSecurityPolicy(project, backendBucket, body=None, requestId=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Sets the edge security policy for the specified backend bucket.</p> 107<p class="toc_element"> 108 <code><a href="#update">update(project, backendBucket, body=None, requestId=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Updates the specified BackendBucket resource with the data included in the request.</p> 110<h3>Method Details</h3> 111<div class="method"> 112 <code class="details" id="addSignedUrlKey">addSignedUrlKey(project, backendBucket, body=None, requestId=None, x__xgafv=None)</code> 113 <pre>Adds a key for validating requests with signed URLs for this backend bucket. 114 115Args: 116 project: string, Project ID for this request. (required) 117 backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required) 118 body: object, The request body. 119 The object takes the form of: 120 121{ # Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs 122 "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. 123 "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. 124} 125 126 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). 127 x__xgafv: string, V1 error format. 128 Allowed values 129 1 - v1 error format 130 2 - v2 error format 131 132Returns: 133 An object of the form: 134 135 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 136 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 137 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 138 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 139 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 140 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 141 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 142 { 143 "code": "A String", # [Output Only] The error type identifier for this error. 144 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 145 "message": "A String", # [Output Only] An optional, human-readable error message. 146 }, 147 ], 148 }, 149 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 150 "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. 151 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 152 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 153 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 154 "name": "A String", # [Output Only] Name of the operation. 155 "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. 156 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 157 "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. 158 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 159 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 160 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 161 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 162 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 163 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 164 "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. 165 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 166 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 167 { 168 "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. 169 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 170 { 171 "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). 172 "value": "A String", # [Output Only] A warning data value corresponding to the key. 173 }, 174 ], 175 "message": "A String", # [Output Only] A human-readable description of the warning code. 176 }, 177 ], 178 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 179}</pre> 180</div> 181 182<div class="method"> 183 <code class="details" id="close">close()</code> 184 <pre>Close httplib2 connections.</pre> 185</div> 186 187<div class="method"> 188 <code class="details" id="delete">delete(project, backendBucket, requestId=None, x__xgafv=None)</code> 189 <pre>Deletes the specified BackendBucket resource. 190 191Args: 192 project: string, Project ID for this request. (required) 193 backendBucket: string, Name of the BackendBucket resource to delete. (required) 194 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). 195 x__xgafv: string, V1 error format. 196 Allowed values 197 1 - v1 error format 198 2 - v2 error format 199 200Returns: 201 An object of the form: 202 203 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 204 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 205 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 206 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 207 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 208 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 209 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 210 { 211 "code": "A String", # [Output Only] The error type identifier for this error. 212 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 213 "message": "A String", # [Output Only] An optional, human-readable error message. 214 }, 215 ], 216 }, 217 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 218 "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. 219 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 220 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 221 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 222 "name": "A String", # [Output Only] Name of the operation. 223 "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. 224 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 225 "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. 226 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 227 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 228 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 229 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 230 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 231 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 232 "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. 233 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 234 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 235 { 236 "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. 237 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 238 { 239 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 240 "value": "A String", # [Output Only] A warning data value corresponding to the key. 241 }, 242 ], 243 "message": "A String", # [Output Only] A human-readable description of the warning code. 244 }, 245 ], 246 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 247}</pre> 248</div> 249 250<div class="method"> 251 <code class="details" id="deleteSignedUrlKey">deleteSignedUrlKey(project, backendBucket, keyName, requestId=None, x__xgafv=None)</code> 252 <pre>Deletes a key for validating requests with signed URLs for this backend bucket. 253 254Args: 255 project: string, Project ID for this request. (required) 256 backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required) 257 keyName: string, The name of the Signed URL Key to delete. (required) 258 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). 259 x__xgafv: string, V1 error format. 260 Allowed values 261 1 - v1 error format 262 2 - v2 error format 263 264Returns: 265 An object of the form: 266 267 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 268 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 269 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 270 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 271 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 272 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 273 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 274 { 275 "code": "A String", # [Output Only] The error type identifier for this error. 276 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 277 "message": "A String", # [Output Only] An optional, human-readable error message. 278 }, 279 ], 280 }, 281 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 282 "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. 283 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 284 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 285 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 286 "name": "A String", # [Output Only] Name of the operation. 287 "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. 288 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 289 "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. 290 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 291 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 292 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 293 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 294 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 295 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 296 "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. 297 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 298 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 299 { 300 "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. 301 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 302 { 303 "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). 304 "value": "A String", # [Output Only] A warning data value corresponding to the key. 305 }, 306 ], 307 "message": "A String", # [Output Only] A human-readable description of the warning code. 308 }, 309 ], 310 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 311}</pre> 312</div> 313 314<div class="method"> 315 <code class="details" id="get">get(project, backendBucket, x__xgafv=None)</code> 316 <pre>Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. 317 318Args: 319 project: string, Project ID for this request. (required) 320 backendBucket: string, Name of the BackendBucket resource to return. (required) 321 x__xgafv: string, V1 error format. 322 Allowed values 323 1 - v1 error format 324 2 - v2 error format 325 326Returns: 327 An object of the form: 328 329 { # 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. 330 "bucketName": "A String", # Cloud Storage bucket name. 331 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 332 "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. 333 { # 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. 334 "headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive. 335 }, 336 ], 337 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 338 "includeHttpHeaders": [ # Allows HTTP request headers (by name) to be used in the cache key. 339 "A String", 340 ], 341 "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. 342 "A String", 343 ], 344 }, 345 "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. 346 "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). 347 "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. 348 "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. 349 "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. 350 "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. 351 { # Specify CDN TTLs for response error codes. 352 "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. 353 "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. 354 }, 355 ], 356 "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. 357 "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. 358 "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. 359 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 360 "A String", 361 ], 362 }, 363 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 364 "customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses. 365 "A String", 366 ], 367 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 368 "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend bucket. 369 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 370 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 371 "kind": "compute#backendBucket", # Type of the resource. 372 "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. 373 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 374}</pre> 375</div> 376 377<div class="method"> 378 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 379 <pre>Creates a BackendBucket resource in the specified project using the data included in the request. 380 381Args: 382 project: string, Project ID for this request. (required) 383 body: object, The request body. 384 The object takes the form of: 385 386{ # 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. 387 "bucketName": "A String", # Cloud Storage bucket name. 388 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 389 "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. 390 { # 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. 391 "headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive. 392 }, 393 ], 394 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 395 "includeHttpHeaders": [ # Allows HTTP request headers (by name) to be used in the cache key. 396 "A String", 397 ], 398 "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. 399 "A String", 400 ], 401 }, 402 "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. 403 "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). 404 "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. 405 "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. 406 "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. 407 "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. 408 { # Specify CDN TTLs for response error codes. 409 "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. 410 "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. 411 }, 412 ], 413 "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. 414 "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. 415 "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. 416 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 417 "A String", 418 ], 419 }, 420 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 421 "customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses. 422 "A String", 423 ], 424 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 425 "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend bucket. 426 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 427 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 428 "kind": "compute#backendBucket", # Type of the resource. 429 "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. 430 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 431} 432 433 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). 434 x__xgafv: string, V1 error format. 435 Allowed values 436 1 - v1 error format 437 2 - v2 error format 438 439Returns: 440 An object of the form: 441 442 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 443 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 444 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 445 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 446 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 447 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 448 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 449 { 450 "code": "A String", # [Output Only] The error type identifier for this error. 451 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 452 "message": "A String", # [Output Only] An optional, human-readable error message. 453 }, 454 ], 455 }, 456 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 457 "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. 458 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 459 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 460 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 461 "name": "A String", # [Output Only] Name of the operation. 462 "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. 463 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 464 "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. 465 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 466 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 467 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 468 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 469 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 470 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 471 "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. 472 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 473 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 474 { 475 "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. 476 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 477 { 478 "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). 479 "value": "A String", # [Output Only] A warning data value corresponding to the key. 480 }, 481 ], 482 "message": "A String", # [Output Only] A human-readable description of the warning code. 483 }, 484 ], 485 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 486}</pre> 487</div> 488 489<div class="method"> 490 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 491 <pre>Retrieves the list of BackendBucket resources available to the specified project. 492 493Args: 494 project: string, Project ID for this request. (required) 495 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) ``` 496 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`) 497 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. 498 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. 499 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 500 x__xgafv: string, V1 error format. 501 Allowed values 502 1 - v1 error format 503 2 - v2 error format 504 505Returns: 506 An object of the form: 507 508 { # Contains a list of BackendBucket resources. 509 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 510 "items": [ # A list of BackendBucket resources. 511 { # 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. 512 "bucketName": "A String", # Cloud Storage bucket name. 513 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 514 "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. 515 { # 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. 516 "headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive. 517 }, 518 ], 519 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 520 "includeHttpHeaders": [ # Allows HTTP request headers (by name) to be used in the cache key. 521 "A String", 522 ], 523 "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. 524 "A String", 525 ], 526 }, 527 "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. 528 "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). 529 "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. 530 "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. 531 "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. 532 "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. 533 { # Specify CDN TTLs for response error codes. 534 "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. 535 "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. 536 }, 537 ], 538 "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. 539 "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. 540 "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. 541 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 542 "A String", 543 ], 544 }, 545 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 546 "customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses. 547 "A String", 548 ], 549 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 550 "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend bucket. 551 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 552 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 553 "kind": "compute#backendBucket", # Type of the resource. 554 "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. 555 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 556 }, 557 ], 558 "kind": "compute#backendBucketList", # Type of resource. 559 "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. 560 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 561 "warning": { # [Output Only] Informational warning message. 562 "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. 563 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 564 { 565 "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). 566 "value": "A String", # [Output Only] A warning data value corresponding to the key. 567 }, 568 ], 569 "message": "A String", # [Output Only] A human-readable description of the warning code. 570 }, 571}</pre> 572</div> 573 574<div class="method"> 575 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 576 <pre>Retrieves the next page of results. 577 578Args: 579 previous_request: The request for the previous page. (required) 580 previous_response: The response from the request for the previous page. (required) 581 582Returns: 583 A request object that you can call 'execute()' on to request the next 584 page. Returns None if there are no more items in the collection. 585 </pre> 586</div> 587 588<div class="method"> 589 <code class="details" id="patch">patch(project, backendBucket, body=None, requestId=None, x__xgafv=None)</code> 590 <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. 591 592Args: 593 project: string, Project ID for this request. (required) 594 backendBucket: string, Name of the BackendBucket resource to patch. (required) 595 body: object, The request body. 596 The object takes the form of: 597 598{ # 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. 599 "bucketName": "A String", # Cloud Storage bucket name. 600 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 601 "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. 602 { # 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. 603 "headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive. 604 }, 605 ], 606 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 607 "includeHttpHeaders": [ # Allows HTTP request headers (by name) to be used in the cache key. 608 "A String", 609 ], 610 "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. 611 "A String", 612 ], 613 }, 614 "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. 615 "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). 616 "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. 617 "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. 618 "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. 619 "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. 620 { # Specify CDN TTLs for response error codes. 621 "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. 622 "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. 623 }, 624 ], 625 "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. 626 "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. 627 "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. 628 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 629 "A String", 630 ], 631 }, 632 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 633 "customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses. 634 "A String", 635 ], 636 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 637 "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend bucket. 638 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 639 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 640 "kind": "compute#backendBucket", # Type of the resource. 641 "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. 642 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 643} 644 645 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). 646 x__xgafv: string, V1 error format. 647 Allowed values 648 1 - v1 error format 649 2 - v2 error format 650 651Returns: 652 An object of the form: 653 654 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 655 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 656 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 657 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 658 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 659 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 660 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 661 { 662 "code": "A String", # [Output Only] The error type identifier for this error. 663 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 664 "message": "A String", # [Output Only] An optional, human-readable error message. 665 }, 666 ], 667 }, 668 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 669 "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. 670 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 671 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 672 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 673 "name": "A String", # [Output Only] Name of the operation. 674 "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. 675 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 676 "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. 677 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 678 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 679 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 680 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 681 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 682 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 683 "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. 684 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 685 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 686 { 687 "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. 688 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 689 { 690 "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). 691 "value": "A String", # [Output Only] A warning data value corresponding to the key. 692 }, 693 ], 694 "message": "A String", # [Output Only] A human-readable description of the warning code. 695 }, 696 ], 697 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 698}</pre> 699</div> 700 701<div class="method"> 702 <code class="details" id="setEdgeSecurityPolicy">setEdgeSecurityPolicy(project, backendBucket, body=None, requestId=None, x__xgafv=None)</code> 703 <pre>Sets the edge security policy for the specified backend bucket. 704 705Args: 706 project: string, Project ID for this request. (required) 707 backendBucket: string, Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. (required) 708 body: object, The request body. 709 The object takes the form of: 710 711{ 712 "securityPolicy": "A String", 713} 714 715 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). 716 x__xgafv: string, V1 error format. 717 Allowed values 718 1 - v1 error format 719 2 - v2 error format 720 721Returns: 722 An object of the form: 723 724 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 725 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 726 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 727 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 728 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 729 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 730 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 731 { 732 "code": "A String", # [Output Only] The error type identifier for this error. 733 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 734 "message": "A String", # [Output Only] An optional, human-readable error message. 735 }, 736 ], 737 }, 738 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 739 "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. 740 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 741 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 742 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 743 "name": "A String", # [Output Only] Name of the operation. 744 "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. 745 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 746 "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. 747 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 748 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 749 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 750 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 751 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 752 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 753 "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. 754 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 755 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 756 { 757 "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. 758 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 759 { 760 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 761 "value": "A String", # [Output Only] A warning data value corresponding to the key. 762 }, 763 ], 764 "message": "A String", # [Output Only] A human-readable description of the warning code. 765 }, 766 ], 767 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 768}</pre> 769</div> 770 771<div class="method"> 772 <code class="details" id="update">update(project, backendBucket, body=None, requestId=None, x__xgafv=None)</code> 773 <pre>Updates the specified BackendBucket resource with the data included in the request. 774 775Args: 776 project: string, Project ID for this request. (required) 777 backendBucket: string, Name of the BackendBucket resource to update. (required) 778 body: object, The request body. 779 The object takes the form of: 780 781{ # 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. 782 "bucketName": "A String", # Cloud Storage bucket name. 783 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket. 784 "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. 785 { # 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. 786 "headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive. 787 }, 788 ], 789 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 790 "includeHttpHeaders": [ # Allows HTTP request headers (by name) to be used in the cache key. 791 "A String", 792 ], 793 "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. 794 "A String", 795 ], 796 }, 797 "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. 798 "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). 799 "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. 800 "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. 801 "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. 802 "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. 803 { # Specify CDN TTLs for response error codes. 804 "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. 805 "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. 806 }, 807 ], 808 "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. 809 "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. 810 "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. 811 "signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs. 812 "A String", 813 ], 814 }, 815 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 816 "customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses. 817 "A String", 818 ], 819 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. 820 "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend bucket. 821 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket. 822 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 823 "kind": "compute#backendBucket", # Type of the resource. 824 "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. 825 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 826} 827 828 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). 829 x__xgafv: string, V1 error format. 830 Allowed values 831 1 - v1 error format 832 2 - v2 error format 833 834Returns: 835 An object of the form: 836 837 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 838 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 839 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 840 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 841 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 842 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 843 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 844 { 845 "code": "A String", # [Output Only] The error type identifier for this error. 846 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 847 "message": "A String", # [Output Only] An optional, human-readable error message. 848 }, 849 ], 850 }, 851 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 852 "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. 853 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 854 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 855 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 856 "name": "A String", # [Output Only] Name of the operation. 857 "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. 858 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 859 "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. 860 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 861 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 862 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 863 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 864 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 865 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 866 "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. 867 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 868 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 869 { 870 "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. 871 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 872 { 873 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 874 "value": "A String", # [Output Only] A warning data value corresponding to the key. 875 }, 876 ], 877 "message": "A String", # [Output Only] A human-readable description of the warning code. 878 }, 879 ], 880 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 881}</pre> 882</div> 883 884</body></html>