Interface ListBucketsRequestOrBuilder (2.4.5)

public interface ListBucketsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCommonRequestParams()

public abstract CommonRequestParams getCommonRequestParams()

A set of parameters common to all Storage API requests.

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

Returns
Type Description
CommonRequestParams

The commonRequestParams.

getCommonRequestParamsOrBuilder()

public abstract CommonRequestParamsOrBuilder getCommonRequestParamsOrBuilder()

A set of parameters common to all Storage API requests.

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

Returns
Type Description
CommonRequestParamsOrBuilder

getPageSize()

public abstract 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 abstract 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 abstract 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 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()

Filter results to buckets whose names begin with this prefix.

string prefix = 4;

Returns
Type Description
String

The prefix.

getPrefixBytes()

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

hasCommonRequestParams()

public abstract boolean hasCommonRequestParams()

A set of parameters common to all Storage API requests.

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

Returns
Type Description
boolean

Whether the commonRequestParams field is set.

hasReadMask()

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