Class BackendBucket (1.14.0)

public final class BackendBucket extends GeneratedMessageV3 implements BackendBucketOrBuilder

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.

Protobuf type google.cloud.compute.v1.BackendBucket

Static Fields

BUCKET_NAME_FIELD_NUMBER

public static final int BUCKET_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

CDN_POLICY_FIELD_NUMBER

public static final int CDN_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

COMPRESSION_MODE_FIELD_NUMBER

public static final int COMPRESSION_MODE_FIELD_NUMBER
Field Value
TypeDescription
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

CUSTOM_RESPONSE_HEADERS_FIELD_NUMBER

public static final int CUSTOM_RESPONSE_HEADERS_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

EDGE_SECURITY_POLICY_FIELD_NUMBER

public static final int EDGE_SECURITY_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_CDN_FIELD_NUMBER

public static final int ENABLE_CDN_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BackendBucket getDefaultInstance()
Returns
TypeDescription
BackendBucket

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static BackendBucket.Builder newBuilder()
Returns
TypeDescription
BackendBucket.Builder

newBuilder(BackendBucket prototype)

public static BackendBucket.Builder newBuilder(BackendBucket prototype)
Parameter
NameDescription
prototypeBackendBucket
Returns
TypeDescription
BackendBucket.Builder

parseDelimitedFrom(InputStream input)

public static BackendBucket parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BackendBucket
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendBucket parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendBucket
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BackendBucket parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BackendBucket
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BackendBucket parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendBucket
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BackendBucket parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BackendBucket
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BackendBucket parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendBucket
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BackendBucket parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BackendBucket
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendBucket parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendBucket
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BackendBucket parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BackendBucket
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendBucket parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendBucket
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BackendBucket parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BackendBucket
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BackendBucket parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendBucket
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BackendBucket> parser()
Returns
TypeDescription
Parser<BackendBucket>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBucketName()

public String getBucketName()

Cloud Storage bucket name.

optional string bucket_name = 283610048;

Returns
TypeDescription
String

The bucketName.

getBucketNameBytes()

public ByteString getBucketNameBytes()

Cloud Storage bucket name.

optional string bucket_name = 283610048;

Returns
TypeDescription
ByteString

The bytes for bucketName.

getCdnPolicy()

public BackendBucketCdnPolicy getCdnPolicy()

Cloud CDN configuration for this BackendBucket.

optional .google.cloud.compute.v1.BackendBucketCdnPolicy cdn_policy = 213976452;

Returns
TypeDescription
BackendBucketCdnPolicy

The cdnPolicy.

getCdnPolicyOrBuilder()

public BackendBucketCdnPolicyOrBuilder getCdnPolicyOrBuilder()

Cloud CDN configuration for this BackendBucket.

optional .google.cloud.compute.v1.BackendBucketCdnPolicy cdn_policy = 213976452;

Returns
TypeDescription
BackendBucketCdnPolicyOrBuilder

getCompressionMode()

public String 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.

optional string compression_mode = 95520988;

Returns
TypeDescription
String

The compressionMode.

getCompressionModeBytes()

public ByteString getCompressionModeBytes()

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.

optional string compression_mode = 95520988;

Returns
TypeDescription
ByteString

The bytes for compressionMode.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getCustomResponseHeaders(int index)

public String getCustomResponseHeaders(int index)

Headers that the HTTP/S load balancer should add to proxied responses.

repeated string custom_response_headers = 387539094;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The customResponseHeaders at the given index.

getCustomResponseHeadersBytes(int index)

public ByteString getCustomResponseHeadersBytes(int index)

Headers that the HTTP/S load balancer should add to proxied responses.

repeated string custom_response_headers = 387539094;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the customResponseHeaders at the given index.

getCustomResponseHeadersCount()

public int getCustomResponseHeadersCount()

Headers that the HTTP/S load balancer should add to proxied responses.

repeated string custom_response_headers = 387539094;

Returns
TypeDescription
int

The count of customResponseHeaders.

getCustomResponseHeadersList()

public ProtocolStringList getCustomResponseHeadersList()

Headers that the HTTP/S load balancer should add to proxied responses.

repeated string custom_response_headers = 387539094;

Returns
TypeDescription
ProtocolStringList

A list containing the customResponseHeaders.

getDefaultInstanceForType()

public BackendBucket getDefaultInstanceForType()
Returns
TypeDescription
BackendBucket

getDescription()

public String getDescription()

An optional textual description of the resource; provided by the client when the resource is created.

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional textual description of the resource; provided by the client when the resource is created.

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

getEdgeSecurityPolicy()

public String getEdgeSecurityPolicy()

[Output Only] The resource URL for the edge security policy associated with this backend bucket.

optional string edge_security_policy = 41036943;

Returns
TypeDescription
String

The edgeSecurityPolicy.

getEdgeSecurityPolicyBytes()

public ByteString getEdgeSecurityPolicyBytes()

[Output Only] The resource URL for the edge security policy associated with this backend bucket.

optional string edge_security_policy = 41036943;

Returns
TypeDescription
ByteString

The bytes for edgeSecurityPolicy.

getEnableCdn()

public boolean getEnableCdn()

If true, enable Cloud CDN for this BackendBucket.

optional bool enable_cdn = 282942321;

Returns
TypeDescription
boolean

The enableCdn.

getId()

public long getId()

[Output Only] Unique identifier for the resource; defined by the server.

optional uint64 id = 3355;

Returns
TypeDescription
long

The id.

getKind()

public String getKind()

Type of the resource.

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

Type of the resource.

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getName()

public String 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? 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.

optional string name = 3373707;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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? 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.

optional string name = 3373707;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<BackendBucket> getParserForType()
Returns
TypeDescription
Parser<BackendBucket>
Overrides
public String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasBucketName()

public boolean hasBucketName()

Cloud Storage bucket name.

optional string bucket_name = 283610048;

Returns
TypeDescription
boolean

Whether the bucketName field is set.

hasCdnPolicy()

public boolean hasCdnPolicy()

Cloud CDN configuration for this BackendBucket.

optional .google.cloud.compute.v1.BackendBucketCdnPolicy cdn_policy = 213976452;

Returns
TypeDescription
boolean

Whether the cdnPolicy field is set.

hasCompressionMode()

public boolean hasCompressionMode()

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.

optional string compression_mode = 95520988;

Returns
TypeDescription
boolean

Whether the compressionMode field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional textual description of the resource; provided by the client when the resource is created.

optional string description = 422937596;

Returns
TypeDescription
boolean

Whether the description field is set.

hasEdgeSecurityPolicy()

public boolean hasEdgeSecurityPolicy()

[Output Only] The resource URL for the edge security policy associated with this backend bucket.

optional string edge_security_policy = 41036943;

Returns
TypeDescription
boolean

Whether the edgeSecurityPolicy field is set.

hasEnableCdn()

public boolean hasEnableCdn()

If true, enable Cloud CDN for this BackendBucket.

optional bool enable_cdn = 282942321;

Returns
TypeDescription
boolean

Whether the enableCdn field is set.

hasId()

public boolean hasId()

[Output Only] Unique identifier for the resource; defined by the server.

optional uint64 id = 3355;

Returns
TypeDescription
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

Type of the resource.

optional string kind = 3292052;

Returns
TypeDescription
boolean

Whether the kind field is set.

hasName()

public boolean hasName()

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? 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.

optional string name = 3373707;

Returns
TypeDescription
boolean

Whether the name field is set.

public boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
boolean

Whether the selfLink field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public BackendBucket.Builder newBuilderForType()
Returns
TypeDescription
BackendBucket.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BackendBucket.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BackendBucket.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public BackendBucket.Builder toBuilder()
Returns
TypeDescription
BackendBucket.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException