Package com.google.storage.v2
Class ListBucketsRequest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.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.GeneratedMessage.Builder<ListBucketsRequest.Builder>
implements ListBucketsRequestOrBuilder
Request message for [ListBuckets][google.storage.v2.Storage.ListBuckets].Protobuf type
google.storage.v2.ListBucketsRequest-
Method Summary
Modifier and TypeMethodDescriptionbuild()clear()Optional.Optional.Required.Optional.Mask specifying which fields to read from each result.Optional.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorintOptional.Optional.com.google.protobuf.ByteStringOptional.Required.com.google.protobuf.ByteStringRequired.Optional.com.google.protobuf.ByteStringOptional.com.google.protobuf.FieldMaskMask specifying which fields to read from each result.com.google.protobuf.FieldMask.BuilderMask specifying which fields to read from each result.com.google.protobuf.FieldMaskOrBuilderMask specifying which fields to read from each result.booleanOptional.booleanMask specifying which fields to read from each result.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeFrom(ListBucketsRequest other) mergeReadMask(com.google.protobuf.FieldMask value) Mask specifying which fields to read from each result.setPageSize(int value) Optional.setPageToken(String value) Optional.setPageTokenBytes(com.google.protobuf.ByteString value) Optional.Required.setParentBytes(com.google.protobuf.ByteString value) Required.Optional.setPrefixBytes(com.google.protobuf.ByteString value) Optional.setReadMask(com.google.protobuf.FieldMask value) Mask specifying which fields to read from each result.setReadMask(com.google.protobuf.FieldMask.Builder builderForValue) Mask specifying which fields to read from each result.setReturnPartialSuccess(boolean value) Optional.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<ListBucketsRequest.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<ListBucketsRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<ListBucketsRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ListBucketsRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<ListBucketsRequest.Builder>
-
mergeFrom
public ListBucketsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ListBucketsRequest.Builder>- Throws:
IOException
-
getParent
Required. The project whose buckets we are listing.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Specified by:
getParentin interfaceListBucketsRequestOrBuilder- 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:
getParentBytesin interfaceListBucketsRequestOrBuilder- Returns:
- The bytes for parent.
-
setParent
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
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
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()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];- Specified by:
getPageSizein interfaceListBucketsRequestOrBuilder- Returns:
- The pageSize.
-
setPageSize
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];- Parameters:
value- The pageSize to set.- Returns:
- This builder for chaining.
-
clearPageSize
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:
- This builder for chaining.
-
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];- Specified by:
getPageTokenin interfaceListBucketsRequestOrBuilder- Returns:
- The pageToken.
-
getPageTokenBytes
public com.google.protobuf.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];- Specified by:
getPageTokenBytesin interfaceListBucketsRequestOrBuilder- Returns:
- The bytes for pageToken.
-
setPageToken
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];- Parameters:
value- The pageToken to set.- Returns:
- This builder for chaining.
-
clearPageToken
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:
- This builder for chaining.
-
setPageTokenBytes
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];- Parameters:
value- The bytes for pageToken to set.- Returns:
- This builder for chaining.
-
getPrefix
Optional. Filter results to buckets whose names begin with this prefix.
string prefix = 4 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPrefixin interfaceListBucketsRequestOrBuilder- Returns:
- The prefix.
-
getPrefixBytes
public com.google.protobuf.ByteString getPrefixBytes()Optional. Filter results to buckets whose names begin with this prefix.
string prefix = 4 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPrefixBytesin interfaceListBucketsRequestOrBuilder- Returns:
- The bytes for prefix.
-
setPrefix
Optional. Filter results to buckets whose names begin with this prefix.
string prefix = 4 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The prefix to set.- Returns:
- This builder for chaining.
-
clearPrefix
Optional. Filter results to buckets whose names begin with this prefix.
string prefix = 4 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
setPrefixBytes
Optional. Filter results to buckets whose names begin with this prefix.
string prefix = 4 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The bytes for prefix to set.- Returns:
- This builder for chaining.
-
hasReadMask
public 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;- Specified by:
hasReadMaskin interfaceListBucketsRequestOrBuilder- Returns:
- Whether the readMask field is set.
-
getReadMask
public com.google.protobuf.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;- Specified by:
getReadMaskin interfaceListBucketsRequestOrBuilder- Returns:
- The readMask.
-
setReadMask
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; -
setReadMask
public ListBucketsRequest.Builder setReadMask(com.google.protobuf.FieldMask.Builder builderForValue) 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; -
mergeReadMask
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; -
clearReadMask
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; -
getReadMaskBuilder
public com.google.protobuf.FieldMask.Builder getReadMaskBuilder()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; -
getReadMaskOrBuilder
public com.google.protobuf.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;- Specified by:
getReadMaskOrBuilderin interfaceListBucketsRequestOrBuilder
-
getReturnPartialSuccess
public 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];- Specified by:
getReturnPartialSuccessin interfaceListBucketsRequestOrBuilder- Returns:
- The returnPartialSuccess.
-
setReturnPartialSuccess
Optional. Allows listing of buckets, even if there are buckets that are unreachable.
bool return_partial_success = 9 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The returnPartialSuccess to set.- Returns:
- This builder for chaining.
-
clearReturnPartialSuccess
Optional. Allows listing of buckets, even if there are buckets that are unreachable.
bool return_partial_success = 9 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-