public static final class ListBucketsRequest.Builder extends GeneratedMessageV3.Builder<ListBucketsRequest.Builder> implements ListBucketsRequestOrBuilderRequest message for ListBuckets.
Protobuf type google.storage.v2.ListBucketsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListBucketsRequest.BuilderImplements
ListBucketsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListBucketsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
build()
public ListBucketsRequest build()| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest |
|
buildPartial()
public ListBucketsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest |
|
clear()
public ListBucketsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListBucketsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public ListBucketsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
clearPageSize()
public ListBucketsRequest.Builder clearPageSize()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 |
ListBucketsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListBucketsRequest.Builder clearPageToken()A previously-returned page token representing part of the larger set of results to view.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
This builder for chaining. |
clearParent()
public ListBucketsRequest.Builder clearParent()Required. The project whose buckets we are listing.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
This builder for chaining. |
clearPrefix()
public ListBucketsRequest.Builder clearPrefix()Filter results to buckets whose names begin with this prefix.
string prefix = 4;
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
This builder for chaining. |
clearReadMask()
public ListBucketsRequest.Builder clearReadMask()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 |
ListBucketsRequest.Builder |
|
clone()
public ListBucketsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
getDefaultInstanceForType()
public ListBucketsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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. |
getReadMaskBuilder()
public FieldMask.Builder getReadMaskBuilder()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 |
Builder |
|
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 |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListBucketsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListBucketsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
mergeFrom(ListBucketsRequest other)
public ListBucketsRequest.Builder mergeFrom(ListBucketsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListBucketsRequest |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
mergeReadMask(FieldMask value)
public ListBucketsRequest.Builder mergeReadMask(FieldMask value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
FieldMask |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListBucketsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListBucketsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
setPageSize(int value)
public ListBucketsRequest.Builder setPageSize(int value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListBucketsRequest.Builder setPageToken(String value)A previously-returned page token representing part of the larger set of results to view.
string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListBucketsRequest.Builder setPageTokenBytes(ByteString value)A previously-returned page token representing part of the larger set of results to view.
string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListBucketsRequest.Builder setParent(String value)Required. The project whose buckets we are listing.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListBucketsRequest.Builder setParentBytes(ByteString value)Required. The project whose buckets we are listing.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
This builder for chaining. |
setPrefix(String value)
public ListBucketsRequest.Builder setPrefix(String value)Filter results to buckets whose names begin with this prefix.
string prefix = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe prefix to set. |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
This builder for chaining. |
setPrefixBytes(ByteString value)
public ListBucketsRequest.Builder setPrefixBytes(ByteString value)Filter results to buckets whose names begin with this prefix.
string prefix = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for prefix to set. |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
This builder for chaining. |
setReadMask(FieldMask value)
public ListBucketsRequest.Builder setReadMask(FieldMask value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
FieldMask |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
setReadMask(FieldMask.Builder builderForValue)
public ListBucketsRequest.Builder setReadMask(FieldMask.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListBucketsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListBucketsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListBucketsRequest.Builder |
|