ListBucketsRequest.Builder (proto-google-cloud-storage-v2 2.22.0-alpha API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<ListBucketsRequest.Builder>
    - - com.google.storage.v2.ListBucketsRequest.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ListBucketsRequestOrBuilder, Cloneable

Enclosing class:

ListBucketsRequest
```
public static final class ListBucketsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListBucketsRequest.Builder>
implements ListBucketsRequestOrBuilder
```
```
 Request message for ListBuckets.
 
```
Protobuf type google.storage.v2.ListBucketsRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListBucketsRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListBucketsRequest`	`build()`
`ListBucketsRequest`	`buildPartial()`
`ListBucketsRequest.Builder`	`clear()`
`ListBucketsRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ListBucketsRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ListBucketsRequest.Builder`	`clearPageSize()` Maximum number of buckets to return in a single response.
`ListBucketsRequest.Builder`	`clearPageToken()` A previously-returned page token representing part of the larger set of results to view.
`ListBucketsRequest.Builder`	`clearParent()` Required.
`ListBucketsRequest.Builder`	`clearPrefix()` Filter results to buckets whose names begin with this prefix.
`ListBucketsRequest.Builder`	`clearReadMask()` Mask specifying which fields to read from each result.
`ListBucketsRequest.Builder`	`clone()`
`ListBucketsRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`int`	`getPageSize()` Maximum number of buckets to return in a single response.
`String`	`getPageToken()` A previously-returned page token representing part of the larger set of results to view.
`com.google.protobuf.ByteString`	`getPageTokenBytes()` A previously-returned page token representing part of the larger set of results to view.
`String`	`getParent()` Required.
`com.google.protobuf.ByteString`	`getParentBytes()` Required.
`String`	`getPrefix()` Filter results to buckets whose names begin with this prefix.
`com.google.protobuf.ByteString`	`getPrefixBytes()` Filter results to buckets whose names begin with this prefix.
`com.google.protobuf.FieldMask`	`getReadMask()` Mask specifying which fields to read from each result.
`com.google.protobuf.FieldMask.Builder`	`getReadMaskBuilder()` Mask specifying which fields to read from each result.
`com.google.protobuf.FieldMaskOrBuilder`	`getReadMaskOrBuilder()` Mask specifying which fields to read from each result.
`boolean`	`hasReadMask()` Mask specifying which fields to read from each result.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListBucketsRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListBucketsRequest.Builder`	`mergeFrom(ListBucketsRequest other)`
`ListBucketsRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListBucketsRequest.Builder`	`mergeReadMask(com.google.protobuf.FieldMask value)` Mask specifying which fields to read from each result.
`ListBucketsRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ListBucketsRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListBucketsRequest.Builder`	`setPageSize(int value)` Maximum number of buckets to return in a single response.
`ListBucketsRequest.Builder`	`setPageToken(String value)` A previously-returned page token representing part of the larger set of results to view.
`ListBucketsRequest.Builder`	`setPageTokenBytes(com.google.protobuf.ByteString value)` A previously-returned page token representing part of the larger set of results to view.
`ListBucketsRequest.Builder`	`setParent(String value)` Required.
`ListBucketsRequest.Builder`	`setParentBytes(com.google.protobuf.ByteString value)` Required.
`ListBucketsRequest.Builder`	`setPrefix(String value)` Filter results to buckets whose names begin with this prefix.
`ListBucketsRequest.Builder`	`setPrefixBytes(com.google.protobuf.ByteString value)` Filter results to buckets whose names begin with this prefix.
`ListBucketsRequest.Builder`	`setReadMask(com.google.protobuf.FieldMask.Builder builderForValue)` Mask specifying which fields to read from each result.
`ListBucketsRequest.Builder`	`setReadMask(com.google.protobuf.FieldMask value)` Mask specifying which fields to read from each result.
`ListBucketsRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`ListBucketsRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListBucketsRequest.Builder>

clear
```
public ListBucketsRequest.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListBucketsRequest.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListBucketsRequest.Builder>

getDefaultInstanceForType
```
public ListBucketsRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public ListBucketsRequest build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public ListBucketsRequest buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public ListBucketsRequest.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListBucketsRequest.Builder>

setField

public ListBucketsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListBucketsRequest.Builder>

clearField
```
public ListBucketsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListBucketsRequest.Builder>

clearOneof
```
public ListBucketsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListBucketsRequest.Builder>

setRepeatedField

public ListBucketsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   int index,
                                                   Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListBucketsRequest.Builder>

addRepeatedField

public ListBucketsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListBucketsRequest.Builder>

mergeFrom
```
public ListBucketsRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListBucketsRequest.Builder>

mergeFrom

public ListBucketsRequest.Builder mergeFrom(ListBucketsRequest other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListBucketsRequest.Builder>

mergeFrom
```
public ListBucketsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListBucketsRequest.Builder>

Throws:

IOException

getParent
```
public String getParent()
```
```
 Required. The project whose buckets we are listing.
 
```
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Specified by:

getParent in interface ListBucketsRequestOrBuilder

Returns:

The parent.

getParentBytes
```
public com.google.protobuf.ByteString getParentBytes()
```
```
 Required. The project whose buckets we are listing.
 
```
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Specified by:

getParentBytes in interface ListBucketsRequestOrBuilder

Returns:

The bytes for parent.

setParent
```
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) = { ... }
Parameters:

value - The parent to set.

Returns:

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:

This builder for chaining.

setParentBytes
```
public ListBucketsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
```
```
 Required. The project whose buckets we are listing.
 
```
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

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;

Specified by:: getPageSize in interface ListBucketsRequestOrBuilder
Returns:: The pageSize.

setPageSize

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;

Parameters:: value - The pageSize to set.
Returns:: This builder for chaining.

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:: This builder for chaining.

getPageToken

public String getPageToken()

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

string page_token = 3;

Specified by:: getPageToken in interface ListBucketsRequestOrBuilder
Returns:: The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

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

string page_token = 3;

Specified by:: getPageTokenBytes in interface ListBucketsRequestOrBuilder
Returns:: The bytes for pageToken.

setPageToken

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;

Parameters:: value - The pageToken to set.
Returns:: 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:: This builder for chaining.

setPageTokenBytes

public ListBucketsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

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

string page_token = 3;

Parameters:: value - The bytes for pageToken to set.
Returns:: This builder for chaining.

getPrefix
```
public String getPrefix()
```
```
 Filter results to buckets whose names begin with this prefix.
 
```
string prefix = 4;
Specified by:

getPrefix in interface ListBucketsRequestOrBuilder

Returns:

The prefix.

getPrefixBytes
```
public com.google.protobuf.ByteString getPrefixBytes()
```
```
 Filter results to buckets whose names begin with this prefix.
 
```
string prefix = 4;
Specified by:

getPrefixBytes in interface ListBucketsRequestOrBuilder

Returns:

The bytes for prefix.

setPrefix

public ListBucketsRequest.Builder setPrefix(String value)

 Filter results to buckets whose names begin with this prefix.

string prefix = 4;

Parameters:: value - The prefix to set.
Returns:: This builder for chaining.

clearPrefix

public ListBucketsRequest.Builder clearPrefix()

 Filter results to buckets whose names begin with this prefix.

string prefix = 4;

Returns:: This builder for chaining.

setPrefixBytes

public ListBucketsRequest.Builder setPrefixBytes(com.google.protobuf.ByteString value)

 Filter results to buckets whose names begin with this prefix.

string prefix = 4;

Parameters:: value - The bytes for prefix to set.
Returns:: This builder for chaining.