Class GetBucketRequest.Builder (2.5.1)

public static final class GetBucketRequest.Builder extends GeneratedMessageV3.Builder<GetBucketRequest.Builder> implements GetBucketRequestOrBuilder

Request message for GetBucket.

Protobuf type google.storage.v2.GetBucketRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GetBucketRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GetBucketRequest.Builder
Overrides

build()

public GetBucketRequest build()
Returns
Type Description
GetBucketRequest

buildPartial()

public GetBucketRequest buildPartial()
Returns
Type Description
GetBucketRequest

clear()

public GetBucketRequest.Builder clear()
Returns
Type Description
GetBucketRequest.Builder
Overrides

clearCommonRequestParams()

public GetBucketRequest.Builder clearCommonRequestParams()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 4;

Returns
Type Description
GetBucketRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public GetBucketRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GetBucketRequest.Builder
Overrides

clearIfMetagenerationMatch()

public GetBucketRequest.Builder clearIfMetagenerationMatch()

If set, and if the bucket's current metageneration does not match the specified value, the request will return an error.

optional int64 if_metageneration_match = 2;

Returns
Type Description
GetBucketRequest.Builder

This builder for chaining.

clearIfMetagenerationNotMatch()

public GetBucketRequest.Builder clearIfMetagenerationNotMatch()

If set, and if the bucket's current metageneration matches the specified value, the request will return an error.

optional int64 if_metageneration_not_match = 3;

Returns
Type Description
GetBucketRequest.Builder

This builder for chaining.

clearName()

public GetBucketRequest.Builder clearName()

Required. Name of a bucket.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
GetBucketRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GetBucketRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GetBucketRequest.Builder
Overrides

clearReadMask()

public GetBucketRequest.Builder clearReadMask()

Mask specifying which fields to read. A "*" field may be used to indicate all fields. If no mask is specified, will default to all fields.

optional .google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
GetBucketRequest.Builder

clone()

public GetBucketRequest.Builder clone()
Returns
Type Description
GetBucketRequest.Builder
Overrides

getCommonRequestParams()

public CommonRequestParams getCommonRequestParams()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 4;

Returns
Type Description
CommonRequestParams

The commonRequestParams.

getCommonRequestParamsBuilder()

public CommonRequestParams.Builder getCommonRequestParamsBuilder()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 4;

Returns
Type Description
CommonRequestParams.Builder

getCommonRequestParamsOrBuilder()

public CommonRequestParamsOrBuilder getCommonRequestParamsOrBuilder()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 4;

Returns
Type Description
CommonRequestParamsOrBuilder

getDefaultInstanceForType()

public GetBucketRequest getDefaultInstanceForType()
Returns
Type Description
GetBucketRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getIfMetagenerationMatch()

public long getIfMetagenerationMatch()

If set, and if the bucket's current metageneration does not match the specified value, the request will return an error.

optional int64 if_metageneration_match = 2;

Returns
Type Description
long

The ifMetagenerationMatch.

getIfMetagenerationNotMatch()

public long getIfMetagenerationNotMatch()

If set, and if the bucket's current metageneration matches the specified value, the request will return an error.

optional int64 if_metageneration_not_match = 3;

Returns
Type Description
long

The ifMetagenerationNotMatch.

getName()

public String getName()

Required. Name of a bucket.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Name of a bucket.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getReadMask()

public FieldMask getReadMask()

Mask specifying which fields to read. A "*" field may be used to indicate all fields. If no mask is specified, will default to all fields.

optional .google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Mask specifying which fields to read. A "*" field may be used to indicate all fields. If no mask is specified, will default to all fields.

optional .google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read. A "*" field may be used to indicate all fields. If no mask is specified, will default to all fields.

optional .google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
FieldMaskOrBuilder

hasCommonRequestParams()

public boolean hasCommonRequestParams()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 4;

Returns
Type Description
boolean

Whether the commonRequestParams field is set.

hasIfMetagenerationMatch()

public boolean hasIfMetagenerationMatch()

If set, and if the bucket's current metageneration does not match the specified value, the request will return an error.

optional int64 if_metageneration_match = 2;

Returns
Type Description
boolean

Whether the ifMetagenerationMatch field is set.

hasIfMetagenerationNotMatch()

public boolean hasIfMetagenerationNotMatch()

If set, and if the bucket's current metageneration matches the specified value, the request will return an error.

optional int64 if_metageneration_not_match = 3;

Returns
Type Description
boolean

Whether the ifMetagenerationNotMatch field is set.

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read. A "*" field may be used to indicate all fields. If no mask is specified, will default to all fields.

optional .google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCommonRequestParams(CommonRequestParams value)

public GetBucketRequest.Builder mergeCommonRequestParams(CommonRequestParams value)

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 4;

Parameter
Name Description
value CommonRequestParams
Returns
Type Description
GetBucketRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GetBucketRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetBucketRequest.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public GetBucketRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GetBucketRequest.Builder
Overrides

mergeFrom(GetBucketRequest other)

public GetBucketRequest.Builder mergeFrom(GetBucketRequest other)
Parameter
Name Description
other GetBucketRequest
Returns
Type Description
GetBucketRequest.Builder

mergeReadMask(FieldMask value)

public GetBucketRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read. A "*" field may be used to indicate all fields. If no mask is specified, will default to all fields.

optional .google.protobuf.FieldMask read_mask = 5;

Parameter
Name Description
value FieldMask
Returns
Type Description
GetBucketRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GetBucketRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GetBucketRequest.Builder
Overrides

setCommonRequestParams(CommonRequestParams value)

public GetBucketRequest.Builder setCommonRequestParams(CommonRequestParams value)

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 4;

Parameter
Name Description
value CommonRequestParams
Returns
Type Description
GetBucketRequest.Builder

setCommonRequestParams(CommonRequestParams.Builder builderForValue)

public GetBucketRequest.Builder setCommonRequestParams(CommonRequestParams.Builder builderForValue)

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 4;

Parameter
Name Description
builderForValue CommonRequestParams.Builder
Returns
Type Description
GetBucketRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public GetBucketRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GetBucketRequest.Builder
Overrides

setIfMetagenerationMatch(long value)

public GetBucketRequest.Builder setIfMetagenerationMatch(long value)

If set, and if the bucket's current metageneration does not match the specified value, the request will return an error.

optional int64 if_metageneration_match = 2;

Parameter
Name Description
value long

The ifMetagenerationMatch to set.

Returns
Type Description
GetBucketRequest.Builder

This builder for chaining.

setIfMetagenerationNotMatch(long value)

public GetBucketRequest.Builder setIfMetagenerationNotMatch(long value)

If set, and if the bucket's current metageneration matches the specified value, the request will return an error.

optional int64 if_metageneration_not_match = 3;

Parameter
Name Description
value long

The ifMetagenerationNotMatch to set.

Returns
Type Description
GetBucketRequest.Builder

This builder for chaining.

setName(String value)

public GetBucketRequest.Builder setName(String value)

Required. Name of a bucket.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
GetBucketRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GetBucketRequest.Builder setNameBytes(ByteString value)

Required. Name of a bucket.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
GetBucketRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public GetBucketRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read. A "*" field may be used to indicate all fields. If no mask is specified, will default to all fields.

optional .google.protobuf.FieldMask read_mask = 5;

Parameter
Name Description
value FieldMask
Returns
Type Description
GetBucketRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public GetBucketRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read. A "*" field may be used to indicate all fields. If no mask is specified, will default to all fields.

optional .google.protobuf.FieldMask read_mask = 5;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
GetBucketRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GetBucketRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GetBucketRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final GetBucketRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GetBucketRequest.Builder
Overrides