Class ListBucketsRequest (2.19.0) 

public final class ListBucketsRequest extends GeneratedMessageV3 implements ListBucketsRequestOrBuilder

Request message for ListBuckets.

Protobuf type google.storage.v2.ListBucketsRequest

Inheritance

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

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PREFIX_FIELD_NUMBER

public static final int PREFIX_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 ListBucketsRequest getDefaultInstance()
Returns
Type Description
ListBucketsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ListBucketsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListBucketsRequest getDefaultInstanceForType()
Returns
Type Description
ListBucketsRequest

getPageSize()

public int getPageSize()

Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller. If "acl" is present in the read_mask, the service will use this parameter of 200 items, whichever is smaller.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A previously-returned page token representing part of the larger set of results to view.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A previously-returned page token representing part of the larger set of results to view.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The project whose buckets we are listing.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The project whose buckets we are listing.

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getPrefix()

public String getPrefix()

Filter results to buckets whose names begin with this prefix.

string prefix = 4;

Returns
Type Description
String

The prefix.

getPrefixBytes()

public ByteString getPrefixBytes()

Filter results to buckets whose names begin with this prefix.

string prefix = 4;

Returns
Type Description
ByteString

The bytes for prefix.

getReadMask()

public FieldMask getReadMask()

Mask specifying which fields to read from each result. If no mask is specified, will default to all fields except items.owner, items.acl, and items.default_object_acl.

  • may be used to mean "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 from each result. If no mask is specified, will default to all fields except items.owner, items.acl, and items.default_object_acl.

  • may be used to mean "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

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read from each result. If no mask is specified, will default to all fields except items.owner, items.acl, and items.default_object_acl.

  • may be used to mean "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 ListBucketsRequest.Builder newBuilderForType()
Returns
Type Description
ListBucketsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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