Class GetBucketRequest (2.4.5) 

public final class GetBucketRequest extends GeneratedMessageV3 implements GetBucketRequestOrBuilder

Request message for GetBucket.

Protobuf type google.storage.v2.GetBucketRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GetBucketRequest

Static Fields

COMMON_REQUEST_PARAMS_FIELD_NUMBER

public static final int COMMON_REQUEST_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

IF_METAGENERATION_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

READ_MASK_FIELD_NUMBER

public static final int READ_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GetBucketRequest getDefaultInstance()
Returns
Type Description
GetBucketRequest

getDescriptor()

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

newBuilder()

public static GetBucketRequest.Builder newBuilder()
Returns
Type Description
GetBucketRequest.Builder

newBuilder(GetBucketRequest prototype)

public static GetBucketRequest.Builder newBuilder(GetBucketRequest prototype)
Parameter
Name Description
prototype GetBucketRequest
Returns
Type Description
GetBucketRequest.Builder

parseDelimitedFrom(InputStream input)

public static GetBucketRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GetBucketRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetBucketRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetBucketRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GetBucketRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GetBucketRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GetBucketRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetBucketRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GetBucketRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GetBucketRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GetBucketRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetBucketRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GetBucketRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GetBucketRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GetBucketRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetBucketRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GetBucketRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GetBucketRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetBucketRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetBucketRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GetBucketRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GetBucketRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GetBucketRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetBucketRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GetBucketRequest> parser()
Returns
Type Description
Parser<GetBucketRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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.

getParserForType()

public Parser<GetBucketRequest> getParserForType()
Returns
Type Description
Parser<GetBucketRequest>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GetBucketRequest.Builder newBuilderForType()
Returns
Type Description
GetBucketRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GetBucketRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GetBucketRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GetBucketRequest.Builder toBuilder()
Returns
Type Description
GetBucketRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException