ListObjectsRequest.Builder (Storage Parent 2.24.0 API)

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

All Implemented Interfaces:

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

Enclosing class:

ListObjectsRequest
```
public static final class ListObjectsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListObjectsRequest.Builder>
implements ListObjectsRequestOrBuilder
```
```
 Request message for ListObjects.
 
```
Protobuf type google.storage.v2.ListObjectsRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListObjectsRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListObjectsRequest`	`build()`
`ListObjectsRequest`	`buildPartial()`
`ListObjectsRequest.Builder`	`clear()`
`ListObjectsRequest.Builder`	`clearDelimiter()` If set, returns results in a directory-like mode.
`ListObjectsRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ListObjectsRequest.Builder`	`clearIncludeTrailingDelimiter()` If true, objects that end in exactly one instance of `delimiter` will have their metadata included in `items` in addition to `prefixes`.
`ListObjectsRequest.Builder`	`clearLexicographicEnd()` Optional.
`ListObjectsRequest.Builder`	`clearLexicographicStart()` Optional.
`ListObjectsRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ListObjectsRequest.Builder`	`clearPageSize()` Maximum number of `items` plus `prefixes` to return in a single page of responses.
`ListObjectsRequest.Builder`	`clearPageToken()` A previously-returned page token representing part of the larger set of results to view.
`ListObjectsRequest.Builder`	`clearParent()` Required.
`ListObjectsRequest.Builder`	`clearPrefix()` Filter results to objects whose names begin with this prefix.
`ListObjectsRequest.Builder`	`clearReadMask()` Mask specifying which fields to read from each result.
`ListObjectsRequest.Builder`	`clearVersions()` If `true`, lists all versions of an object as distinct results.
`ListObjectsRequest.Builder`	`clone()`
`ListObjectsRequest`	`getDefaultInstanceForType()`
`String`	`getDelimiter()` If set, returns results in a directory-like mode.
`com.google.protobuf.ByteString`	`getDelimiterBytes()` If set, returns results in a directory-like mode.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`boolean`	`getIncludeTrailingDelimiter()` If true, objects that end in exactly one instance of `delimiter` will have their metadata included in `items` in addition to `prefixes`.
`String`	`getLexicographicEnd()` Optional.
`com.google.protobuf.ByteString`	`getLexicographicEndBytes()` Optional.
`String`	`getLexicographicStart()` Optional.
`com.google.protobuf.ByteString`	`getLexicographicStartBytes()` Optional.
`int`	`getPageSize()` Maximum number of `items` plus `prefixes` to return in a single page of responses.
`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 objects whose names begin with this prefix.
`com.google.protobuf.ByteString`	`getPrefixBytes()` Filter results to objects 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`	`getVersions()` If `true`, lists all versions of an object as distinct results.
`boolean`	`hasReadMask()` Mask specifying which fields to read from each result.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListObjectsRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListObjectsRequest.Builder`	`mergeFrom(ListObjectsRequest other)`
`ListObjectsRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListObjectsRequest.Builder`	`mergeReadMask(com.google.protobuf.FieldMask value)` Mask specifying which fields to read from each result.
`ListObjectsRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ListObjectsRequest.Builder`	`setDelimiter(String value)` If set, returns results in a directory-like mode.
`ListObjectsRequest.Builder`	`setDelimiterBytes(com.google.protobuf.ByteString value)` If set, returns results in a directory-like mode.
`ListObjectsRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`ListObjectsRequest.Builder`	`setIncludeTrailingDelimiter(boolean value)` If true, objects that end in exactly one instance of `delimiter` will have their metadata included in `items` in addition to `prefixes`.
`ListObjectsRequest.Builder`	`setLexicographicEnd(String value)` Optional.
`ListObjectsRequest.Builder`	`setLexicographicEndBytes(com.google.protobuf.ByteString value)` Optional.
`ListObjectsRequest.Builder`	`setLexicographicStart(String value)` Optional.
`ListObjectsRequest.Builder`	`setLexicographicStartBytes(com.google.protobuf.ByteString value)` Optional.
`ListObjectsRequest.Builder`	`setPageSize(int value)` Maximum number of `items` plus `prefixes` to return in a single page of responses.
`ListObjectsRequest.Builder`	`setPageToken(String value)` A previously-returned page token representing part of the larger set of results to view.
`ListObjectsRequest.Builder`	`setPageTokenBytes(com.google.protobuf.ByteString value)` A previously-returned page token representing part of the larger set of results to view.
`ListObjectsRequest.Builder`	`setParent(String value)` Required.
`ListObjectsRequest.Builder`	`setParentBytes(com.google.protobuf.ByteString value)` Required.
`ListObjectsRequest.Builder`	`setPrefix(String value)` Filter results to objects whose names begin with this prefix.
`ListObjectsRequest.Builder`	`setPrefixBytes(com.google.protobuf.ByteString value)` Filter results to objects whose names begin with this prefix.
`ListObjectsRequest.Builder`	`setReadMask(com.google.protobuf.FieldMask.Builder builderForValue)` Mask specifying which fields to read from each result.
`ListObjectsRequest.Builder`	`setReadMask(com.google.protobuf.FieldMask value)` Mask specifying which fields to read from each result.
`ListObjectsRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`ListObjectsRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ListObjectsRequest.Builder`	`setVersions(boolean value)` If `true`, lists all versions of an object as distinct results.

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<ListObjectsRequest.Builder>

clear
```
public ListObjectsRequest.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<ListObjectsRequest.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<ListObjectsRequest.Builder>

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

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

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

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

Specified by:

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

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

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

Specified by:

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

clone
```
public ListObjectsRequest.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<ListObjectsRequest.Builder>

setField

public ListObjectsRequest.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<ListObjectsRequest.Builder>

clearField
```
public ListObjectsRequest.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<ListObjectsRequest.Builder>

clearOneof
```
public ListObjectsRequest.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<ListObjectsRequest.Builder>

setRepeatedField

public ListObjectsRequest.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<ListObjectsRequest.Builder>

addRepeatedField

public ListObjectsRequest.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<ListObjectsRequest.Builder>

mergeFrom
```
public ListObjectsRequest.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<ListObjectsRequest.Builder>

mergeFrom

public ListObjectsRequest.Builder mergeFrom(ListObjectsRequest other)

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

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom
```
public ListObjectsRequest.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<ListObjectsRequest.Builder>

Throws:

IOException

getParent
```
public String getParent()
```
```
 Required. Name of the bucket in which to look for objects.
 
```
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Specified by:

getParent in interface ListObjectsRequestOrBuilder

Returns:

The parent.

getParentBytes
```
public com.google.protobuf.ByteString getParentBytes()
```
```
 Required. Name of the bucket in which to look for objects.
 
```
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Specified by:

getParentBytes in interface ListObjectsRequestOrBuilder

Returns:

The bytes for parent.

setParent
```
public ListObjectsRequest.Builder setParent(String value)
```
```
 Required. Name of the bucket in which to look for objects.
 
```
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 ListObjectsRequest.Builder clearParent()
```
```
 Required. Name of the bucket in which to look for objects.
 
```
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns:

This builder for chaining.

setParentBytes
```
public ListObjectsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
```
```
 Required. Name of the bucket in which to look for objects.
 
```
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 `items` plus `prefixes` to return
 in a single page of responses. As duplicate `prefixes` are
 omitted, fewer total results may be returned than requested. The service
 will use this parameter or 1,000 items, whichever is smaller.

int32 page_size = 2;

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

setPageSize

public ListObjectsRequest.Builder setPageSize(int value)

 Maximum number of `items` plus `prefixes` to return
 in a single page of responses. As duplicate `prefixes` are
 omitted, fewer total results may be returned than requested. The service
 will use this parameter or 1,000 items, whichever is smaller.

int32 page_size = 2;

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

clearPageSize

public ListObjectsRequest.Builder clearPageSize()

 Maximum number of `items` plus `prefixes` to return
 in a single page of responses. As duplicate `prefixes` are
 omitted, fewer total results may be returned than requested. The service
 will use this parameter or 1,000 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 ListObjectsRequestOrBuilder
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 ListObjectsRequestOrBuilder
Returns:: The bytes for pageToken.

setPageToken

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

getDelimiter

public String getDelimiter()

 If set, returns results in a directory-like mode. `items` will contain
 only objects whose names, aside from the `prefix`, do not
 contain `delimiter`. Objects whose names, aside from the
 `prefix`, contain `delimiter` will have their name,
 truncated after the `delimiter`, returned in
 `prefixes`. Duplicate `prefixes` are omitted.

string delimiter = 4;

Specified by:: getDelimiter in interface ListObjectsRequestOrBuilder
Returns:: The delimiter.

getDelimiterBytes

public com.google.protobuf.ByteString getDelimiterBytes()

 If set, returns results in a directory-like mode. `items` will contain
 only objects whose names, aside from the `prefix`, do not
 contain `delimiter`. Objects whose names, aside from the
 `prefix`, contain `delimiter` will have their name,
 truncated after the `delimiter`, returned in
 `prefixes`. Duplicate `prefixes` are omitted.

string delimiter = 4;

Specified by:: getDelimiterBytes in interface ListObjectsRequestOrBuilder
Returns:: The bytes for delimiter.

setDelimiter

public ListObjectsRequest.Builder setDelimiter(String value)

 If set, returns results in a directory-like mode. `items` will contain
 only objects whose names, aside from the `prefix`, do not
 contain `delimiter`. Objects whose names, aside from the
 `prefix`, contain `delimiter` will have their name,
 truncated after the `delimiter`, returned in
 `prefixes`. Duplicate `prefixes` are omitted.

string delimiter = 4;

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

clearDelimiter

public ListObjectsRequest.Builder clearDelimiter()

 If set, returns results in a directory-like mode. `items` will contain
 only objects whose names, aside from the `prefix`, do not
 contain `delimiter`. Objects whose names, aside from the
 `prefix`, contain `delimiter` will have their name,
 truncated after the `delimiter`, returned in
 `prefixes`. Duplicate `prefixes` are omitted.

string delimiter = 4;

Returns:: This builder for chaining.

setDelimiterBytes

public ListObjectsRequest.Builder setDelimiterBytes(com.google.protobuf.ByteString value)

 If set, returns results in a directory-like mode. `items` will contain
 only objects whose names, aside from the `prefix`, do not
 contain `delimiter`. Objects whose names, aside from the
 `prefix`, contain `delimiter` will have their name,
 truncated after the `delimiter`, returned in
 `prefixes`. Duplicate `prefixes` are omitted.

string delimiter = 4;

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

getIncludeTrailingDelimiter

public boolean getIncludeTrailingDelimiter()

 If true, objects that end in exactly one instance of `delimiter`
 will have their metadata included in `items` in addition to
 `prefixes`.

bool include_trailing_delimiter = 5;

Specified by:: getIncludeTrailingDelimiter in interface ListObjectsRequestOrBuilder
Returns:: The includeTrailingDelimiter.

setIncludeTrailingDelimiter

public ListObjectsRequest.Builder setIncludeTrailingDelimiter(boolean value)

 If true, objects that end in exactly one instance of `delimiter`
 will have their metadata included in `items` in addition to
 `prefixes`.

bool include_trailing_delimiter = 5;

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

clearIncludeTrailingDelimiter

public ListObjectsRequest.Builder clearIncludeTrailingDelimiter()

 If true, objects that end in exactly one instance of `delimiter`
 will have their metadata included in `items` in addition to
 `prefixes`.

bool include_trailing_delimiter = 5;

Returns:: This builder for chaining.

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

getPrefix in interface ListObjectsRequestOrBuilder

Returns:

The prefix.

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

getPrefixBytes in interface ListObjectsRequestOrBuilder

Returns:

The bytes for prefix.

setPrefix

public ListObjectsRequest.Builder setPrefix(String value)

 Filter results to objects whose names begin with this prefix.

string prefix = 6;

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

clearPrefix

public ListObjectsRequest.Builder clearPrefix()

 Filter results to objects whose names begin with this prefix.

string prefix = 6;

Returns:: This builder for chaining.

setPrefixBytes

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

 Filter results to objects whose names begin with this prefix.

string prefix = 6;

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

getVersions

public boolean getVersions()

 If `true`, lists all versions of an object as distinct results.
 For more information, see
 [Object
 Versioning](https://cloud.google.com/storage/docs/object-versioning).

bool versions = 7;

Specified by:: getVersions in interface ListObjectsRequestOrBuilder
Returns:: The versions.

setVersions

public ListObjectsRequest.Builder setVersions(boolean value)

 If `true`, lists all versions of an object as distinct results.
 For more information, see
 [Object
 Versioning](https://cloud.google.com/storage/docs/object-versioning).

bool versions = 7;

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

clearVersions

public ListObjectsRequest.Builder clearVersions()

 If `true`, lists all versions of an object as distinct results.
 For more information, see
 [Object
 Versioning](https://cloud.google.com/storage/docs/object-versioning).

bool versions = 7;

Returns:: This builder for chaining.