Reference documentation and code samples for the Compute V1 Client class BackendBucket.
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.
Generated from protobuf messagegoogle.cloud.compute.v1.BackendBucket
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Check the CompressionMode enum for the list of possible values.
↳ creation_timestamp
string
[Output Only] Creation timestamp in RFC3339 text format.
↳ custom_response_headers
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.
↳ edge_security_policy
string
[Output Only] The resource URL for the edge security policy associated with this backend bucket.
↳ enable_cdn
bool
If true, enable Cloud CDN for this BackendBucket.
↳ id
int|string
[Output Only] Unique identifier for the resource; defined by the server.
↳ kind
string
Type of the resource.
↳ load_balancing_scheme
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. Check the LoadBalancingScheme enum for the list of possible values.
↳ 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 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.
Headers that the Application Load Balancer should add to proxied responses.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getDescription
An optional textual description of the resource; provided by the client when the resource is created.
Returns
Type
Description
string
hasDescription
clearDescription
setDescription
An optional textual description of the resource; provided by the client when the resource is created.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEdgeSecurityPolicy
[Output Only] The resource URL for the edge security policy associated with this backend bucket.
Returns
Type
Description
string
hasEdgeSecurityPolicy
clearEdgeSecurityPolicy
setEdgeSecurityPolicy
[Output Only] The resource URL for the edge security policy associated with this backend bucket.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEnableCdn
If true, enable Cloud CDN for this BackendBucket.
Returns
Type
Description
bool
hasEnableCdn
clearEnableCdn
setEnableCdn
If true, enable Cloud CDN for this BackendBucket.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getId
[Output Only] Unique identifier for the resource; defined by the server.
Returns
Type
Description
int|string
hasId
clearId
setId
[Output Only] Unique identifier for the resource; defined by the server.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getKind
Type of the resource.
Returns
Type
Description
string
hasKind
clearKind
setKind
Type of the resource.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLoadBalancingScheme
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.
Check the LoadBalancingScheme enum for the list of possible values.
Returns
Type
Description
string
hasLoadBalancingScheme
clearLoadBalancingScheme
setLoadBalancingScheme
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.
Check the LoadBalancingScheme enum for the list of possible values.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getName
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.
Returns
Type
Description
string
hasName
clearName
setName
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getParams
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Compute V1 Client - Class BackendBucket (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.BackendBucket)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.BackendBucket)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.BackendBucket)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.BackendBucket)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.BackendBucket)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.BackendBucket)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.BackendBucket)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.BackendBucket)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.BackendBucket)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.BackendBucket)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.BackendBucket)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.BackendBucket)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.BackendBucket)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.BackendBucket)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.BackendBucket)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.BackendBucket)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.BackendBucket)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.BackendBucket)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.BackendBucket)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.BackendBucket)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.BackendBucket)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.BackendBucket)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.BackendBucket)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.BackendBucket)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.BackendBucket)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.BackendBucket)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.BackendBucket)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.BackendBucket)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.BackendBucket)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.BackendBucket) \nReference documentation and code samples for the Compute V1 Client class BackendBucket.\n\nRepresents 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.\n\nGenerated from protobuf message `google.cloud.compute.v1.BackendBucket`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getBucketName\n\nCloud Storage bucket name.\n\n### hasBucketName\n\n### clearBucketName\n\n### setBucketName\n\nCloud Storage bucket name.\n\n### getCdnPolicy\n\nCloud CDN configuration for this BackendBucket.\n\n### hasCdnPolicy\n\n### clearCdnPolicy\n\n### setCdnPolicy\n\nCloud CDN configuration for this BackendBucket.\n\n### getCompressionMode\n\nCompress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.\n\nCheck the CompressionMode enum for the list of possible values.\n\n### hasCompressionMode\n\n### clearCompressionMode\n\n### setCompressionMode\n\nCompress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.\n\nCheck the CompressionMode enum for the list of possible values.\n\n### getCreationTimestamp\n\n\\[Output Only\\] Creation timestamp in RFC3339 text format.\n\n### hasCreationTimestamp\n\n### clearCreationTimestamp\n\n### setCreationTimestamp\n\n\\[Output Only\\] Creation timestamp in RFC3339 text format.\n\n### getCustomResponseHeaders\n\nHeaders that the Application Load Balancer should add to proxied responses.\n\n### setCustomResponseHeaders\n\nHeaders that the Application Load Balancer should add to proxied responses.\n\n### getDescription\n\nAn optional textual description of the resource; provided by the client when the resource is created.\n\n### hasDescription\n\n### clearDescription\n\n### setDescription\n\nAn optional textual description of the resource; provided by the client when the resource is created.\n\n### getEdgeSecurityPolicy\n\n\\[Output Only\\] The resource URL for the edge security policy associated with this backend bucket.\n\n### hasEdgeSecurityPolicy\n\n### clearEdgeSecurityPolicy\n\n### setEdgeSecurityPolicy\n\n\\[Output Only\\] The resource URL for the edge security policy associated with this backend bucket.\n\n### getEnableCdn\n\nIf true, enable Cloud CDN for this BackendBucket.\n\n### hasEnableCdn\n\n### clearEnableCdn\n\n### setEnableCdn\n\nIf true, enable Cloud CDN for this BackendBucket.\n\n### getId\n\n\\[Output Only\\] Unique identifier for the resource; defined by the server.\n\n### hasId\n\n### clearId\n\n### setId\n\n\\[Output Only\\] Unique identifier for the resource; defined by the server.\n\n### getKind\n\nType of the resource.\n\n### hasKind\n\n### clearKind\n\n### setKind\n\nType of the resource.\n\n### getLoadBalancingScheme\n\nThe 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.\n\nCheck the LoadBalancingScheme enum for the list of possible values.\n\n### hasLoadBalancingScheme\n\n### clearLoadBalancingScheme\n\n### setLoadBalancingScheme\n\nThe 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.\n\nCheck the LoadBalancingScheme enum for the list of possible values.\n\n### getName\n\nName 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.\n\n### hasName\n\n### clearName\n\n### setName\n\nName 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.\n\n### getParams\n\nInput only. \\[Input Only\\] Additional params passed with the request, but not persisted as part of resource payload.\n\n### hasParams\n\n### clearParams\n\n### setParams\n\nInput only. \\[Input Only\\] Additional params passed with the request, but not persisted as part of resource payload.\n\n### getSelfLink\n\n\\[Output Only\\] Server-defined URL for the resource.\n\n### hasSelfLink\n\n### clearSelfLink\n\n### setSelfLink\n\n\\[Output Only\\] Server-defined URL for the resource.\n\n### getUsedBy\n\n\\[Output Only\\] List of resources referencing that backend bucket.\n\n### setUsedBy\n\n\\[Output Only\\] List of resources referencing that backend bucket."]]
