Interface ListBucketsRequestOrBuilder (2.62.0)

public interface ListBucketsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getPageSize()

public abstract int getPageSize()

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

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

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

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

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

getPrefix()

public abstract String getPrefix()

Optional. Filter results to buckets whose names begin with this prefix.

string prefix = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The prefix.

getPrefixBytes()

public abstract ByteString getPrefixBytes()

Optional. Filter results to buckets whose names begin with this prefix.

string prefix = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for prefix.

getReadMask()

public abstract FieldMask getReadMask()

Mask specifying which fields to read from each result. If no mask is specified, it defaults to all fields except items. owner, items.acl, and items.default_object_acl. * might be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
FieldMask

The readMask.

getReadMaskOrBuilder()

public abstract FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read from each result. If no mask is specified, it defaults to all fields except items. owner, items.acl, and items.default_object_acl. * might be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
FieldMaskOrBuilder

getReturnPartialSuccess()

public abstract boolean getReturnPartialSuccess()

Optional. Allows listing of buckets, even if there are buckets that are unreachable.

bool return_partial_success = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The returnPartialSuccess.

hasReadMask()

public abstract boolean hasReadMask()

Mask specifying which fields to read from each result. If no mask is specified, it defaults to all fields except items. owner, items.acl, and items.default_object_acl. * might be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
boolean

Whether the readMask field is set.