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 message google.cloud.compute.v1.BackendBucket
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ bucket_name |
string
Cloud Storage bucket name. |
↳ cdn_policy |
BackendBucketCdnPolicy
Cloud CDN configuration for this BackendBucket. |
↳ compression_mode |
string
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 |
↳ self_link |
string
[Output Only] Server-defined URL for the resource. |
↳ used_by |
array<BackendBucketUsedBy>
[Output Only] List of resources referencing that backend bucket. |
getBucketName
Cloud Storage bucket name.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasBucketName
clearBucketName
setBucketName
Cloud Storage bucket name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCdnPolicy
Cloud CDN configuration for this BackendBucket.
| Returns | |
|---|---|
| Type | Description |
BackendBucketCdnPolicy|null |
|
hasCdnPolicy
clearCdnPolicy
setCdnPolicy
Cloud CDN configuration for this BackendBucket.
| Parameter | |
|---|---|
| Name | Description |
var |
BackendBucketCdnPolicy
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCompressionMode
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCompressionMode
clearCompressionMode
setCompressionMode
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCustomResponseHeaders
Headers that the Application Load Balancer should add to proxied responses.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCustomResponseHeaders
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 |
|
getSelfLink
[Output Only] Server-defined URL for the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUsedBy
[Output Only] List of resources referencing that backend bucket.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setUsedBy
[Output Only] List of resources referencing that backend bucket.
| Parameter | |
|---|---|
| Name | Description |
var |
array<BackendBucketUsedBy>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|