region_backend_buckets

Creates, updates, deletes, gets or lists a region_backend_buckets resource.

Overview

Name	`region_backend_buckets`
Type	Resource
Id	`google.compute.region_backend_buckets`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`id`	`string (uint64)`	[Output Only] Unique identifier for the resource; defined by the server.
`name`	`string`	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`bucketName`	`string`	Cloud Storage bucket name.
`cdnPolicy`	`object`	Cloud CDN configuration for this BackendBucket. (id: BackendBucketCdnPolicy)
`compressionMode`	`string`	Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. (AUTOMATIC, DISABLED)
`creationTimestamp`	`string`	[Output Only] Creation timestamp inRFC3339 text format.
`customResponseHeaders`	`array`	Headers that the Application Load Balancer should add to proxied responses.
`description`	`string`	An optional textual description of the resource; provided by the client when the resource is created.
`edgeSecurityPolicy`	`string`	[Output Only] The resource URL for the edge security policy associated with this backend bucket.
`enableCdn`	`boolean`	If true, enable Cloud CDN for this BackendBucket.
`kind`	`string`	Output only. Type of the resource. (default: compute#backendBucket)
`loadBalancingScheme`	`string`	The value can only be INTERNAL_MANAGED for cross-region internal layer 7 load balancer. If loadBalancingScheme is not specified, the backend bucket can be used by classic global external load balancers, or global application external load balancers, or both. (EXTERNAL_MANAGED, INTERNAL_MANAGED)
`params`	`object`	Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: BackendBucketParams)
`region`	`string`	Output only. [Output Only] URL of the region where the regional backend bucket resides. This field is not applicable to global backend buckets. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`usedBy`	`array`	Output only. [Output Only] List of resources referencing that backend bucket.

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of BackendBucket resources.
`kind`	`string`	Output only. Type of resource. (default: compute#backendBucketList)
`nextPageToken`	`string`	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, 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.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for this resource.
`warning`	`object`	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `region`, `backendBucket`		Returns the specified regional BackendBucket resource.
`list`	`select`	`project`, `region`	`returnPartialSuccess`, `maxResults`, `pageToken`, `filter`, `orderBy`	Retrieves the list of BackendBucket resources available to the specified project in the given region.
`insert`	`insert`	`project`, `region`	`requestId`	Creates a RegionBackendBucket in the specified project in the given scope using the parameters that are included in the request.
`patch`	`update`	`project`, `region`, `backendBucket`	`requestId`	Updates the specified BackendBucket resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
`delete`	`delete`	`project`, `region`, `backendBucket`	`requestId`	Deletes the specified regional BackendBucket resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`backendBucket`	`string`
`project`	`string`
`region`	`string`
`filter`	`string`
`maxResults`	`integer (uint32)`
`orderBy`	`string`
`pageToken`	`string`
`requestId`	`string`
`returnPartialSuccess`	`boolean`

`SELECT` examples

get
list

Returns the specified regional BackendBucket resource.

SELECT
id,
name,
bucketName,
cdnPolicy,
compressionMode,
creationTimestamp,
customResponseHeaders,
description,
edgeSecurityPolicy,
enableCdn,
kind,
loadBalancingScheme,
params,
region,
selfLink,
usedBy
FROM google.compute.region_backend_buckets
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND backendBucket = '{{ backendBucket }}' -- required
;

Retrieves the list of BackendBucket resources available to the specified
project in the given region.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.region_backend_buckets
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

`INSERT` examples

insert
Manifest

Creates a RegionBackendBucket in the specified project in the given scope
using the parameters that are included in the request.

INSERT INTO google.compute.region_backend_buckets (
data__customResponseHeaders,
data__loadBalancingScheme,
data__description,
data__compressionMode,
data__id,
data__selfLink,
data__name,
data__params,
data__cdnPolicy,
data__edgeSecurityPolicy,
data__creationTimestamp,
data__enableCdn,
data__bucketName,
project,
region,
requestId
)
SELECT 
'{{ customResponseHeaders }}',
'{{ loadBalancingScheme }}',
'{{ description }}',
'{{ compressionMode }}',
'{{ id }}',
'{{ selfLink }}',
'{{ name }}',
'{{ params }}',
'{{ cdnPolicy }}',
'{{ edgeSecurityPolicy }}',
'{{ creationTimestamp }}',
{{ enableCdn }},
'{{ bucketName }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: region_backend_buckets
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the region_backend_buckets resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the region_backend_buckets resource.
  - name: customResponseHeaders
    value:
      - "{{ customResponseHeaders }}"
    description: |
      Headers that the Application Load Balancer should add to proxied responses.
  - name: loadBalancingScheme
    value: "{{ loadBalancingScheme }}"
    description: |
      The value can only be INTERNAL_MANAGED for cross-region internal layer 7
      load balancer.
      If loadBalancingScheme is not specified, the backend bucket can be used by
      classic global external load balancers, or global application external load
      balancers, or both.
    valid_values: ['EXTERNAL_MANAGED', 'INTERNAL_MANAGED']
  - name: description
    value: "{{ description }}"
    description: |
      An optional textual description of the resource; provided by the client
      when the resource is created.
  - name: compressionMode
    value: "{{ compressionMode }}"
    description: |
      Compress text responses using Brotli or gzip compression, based on
      the client's Accept-Encoding header.
    valid_values: ['AUTOMATIC', 'DISABLED']
  - name: id
    value: "{{ id }}"
    description: |
      [Output Only] Unique identifier for the resource; defined by the server.
  - name: selfLink
    value: "{{ selfLink }}"
    description: |
      [Output Only] Server-defined URL for the resource.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      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.
  - name: params
    description: |
      Input only. [Input Only] Additional params passed with the request, but not persisted
      as part of resource payload.
    value:
      resourceManagerTags: "{{ resourceManagerTags }}"
  - name: cdnPolicy
    description: |
      Cloud CDN configuration for this BackendBucket.
    value:
      negativeCachingPolicy:
        - ttl: {{ ttl }}
          code: {{ code }}
      cacheKeyPolicy:
        includeHttpHeaders:
          - "{{ includeHttpHeaders }}"
        queryStringWhitelist:
          - "{{ queryStringWhitelist }}"
      requestCoalescing: {{ requestCoalescing }}
      defaultTtl: {{ defaultTtl }}
      cacheMode: "{{ cacheMode }}"
      negativeCaching: {{ negativeCaching }}
      bypassCacheOnRequestHeaders:
        - headerName: "{{ headerName }}"
      serveWhileStale: {{ serveWhileStale }}
      signedUrlKeyNames:
        - "{{ signedUrlKeyNames }}"
      clientTtl: {{ clientTtl }}
      maxTtl: {{ maxTtl }}
      signedUrlCacheMaxAgeSec: "{{ signedUrlCacheMaxAgeSec }}"
  - name: edgeSecurityPolicy
    value: "{{ edgeSecurityPolicy }}"
    description: |
      [Output Only] The resource URL for the edge security policy associated with
      this backend bucket.
  - name: creationTimestamp
    value: "{{ creationTimestamp }}"
    description: |
      [Output Only] Creation timestamp inRFC3339
      text format.
  - name: enableCdn
    value: {{ enableCdn }}
    description: |
      If true, enable Cloud CDN for this BackendBucket.
  - name: bucketName
    value: "{{ bucketName }}"
    description: |
      Cloud Storage bucket name.
  - name: requestId
    value: "{{ requestId }}"

`UPDATE` examples

patch

Updates the specified BackendBucket resource with the data included in the
request. This method supportsPATCH
semantics and uses theJSON merge
patch format and processing rules.

UPDATE google.compute.region_backend_buckets
SET 
data__customResponseHeaders = '{{ customResponseHeaders }}',
data__loadBalancingScheme = '{{ loadBalancingScheme }}',
data__description = '{{ description }}',
data__compressionMode = '{{ compressionMode }}',
data__id = '{{ id }}',
data__selfLink = '{{ selfLink }}',
data__name = '{{ name }}',
data__params = '{{ params }}',
data__cdnPolicy = '{{ cdnPolicy }}',
data__edgeSecurityPolicy = '{{ edgeSecurityPolicy }}',
data__creationTimestamp = '{{ creationTimestamp }}',
data__enableCdn = {{ enableCdn }},
data__bucketName = '{{ bucketName }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND backendBucket = '{{ backendBucket }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

`DELETE` examples

delete

Deletes the specified regional BackendBucket resource.

DELETE FROM google.compute.region_backend_buckets
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND backendBucket = '{{ backendBucket }}' --required
AND requestId = '{{ requestId }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​