Class ListObjectsRequest.Builder (2.29.0)

Version 2.29.0

• 2.45.0 (latest)
• 2.44.1
• 2.43.2
• 2.42.0
• 2.41.0
• 2.40.1
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.1
• 2.34.0
• 2.33.0
• 2.32.1
• 2.30.1
• 2.29.1
• 2.28.0
• 2.27.1
• 2.24.0
• 2.23.0
• 2.22.6
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.3
• 2.10.0
• 2.9.3
• 2.8.1
• 2.7.1
• 2.6.1
• 2.5.1
• 2.4.5
• 2.3.0
• 2.2.3
• 2.1.10

public static final class ListObjectsRequest.Builder extends GeneratedMessageV3.Builder<ListObjectsRequest.Builder> implements ListObjectsRequestOrBuilder

Request message for ListObjects.

Protobuf type google.storage.v2.ListObjectsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListObjectsRequest.Builder

Implements

ListObjectsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListObjectsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ListObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListObjectsRequest build()

Returns
Type	Description
ListObjectsRequest

buildPartial()

public ListObjectsRequest buildPartial()

Returns
Type	Description
ListObjectsRequest

clear()

public ListObjectsRequest.Builder clear()

Returns
Type	Description
ListObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ListObjectsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ListObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

clearLexicographicEnd()

public ListObjectsRequest.Builder clearLexicographicEnd()

Optional. Filter results to objects whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the objects listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

string lexicographic_end = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

clearLexicographicStart()

public ListObjectsRequest.Builder clearLexicographicStart()

Optional. Filter results to objects whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the objects listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

string lexicographic_start = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

clearMatchGlob()

public ListObjectsRequest.Builder clearMatchGlob()

Optional. Filter results to objects and prefixes that match this glob pattern. See List Objects Using Glob for the full syntax.

string match_glob = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListObjectsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ListObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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
Type	Description
ListObjectsRequest.Builder	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
Type	Description
ListObjectsRequest.Builder	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
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

clearPrefix()

public ListObjectsRequest.Builder clearPrefix()

Filter results to objects whose names begin with this prefix.

string prefix = 6;

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

clearReadMask()

public ListObjectsRequest.Builder clearReadMask()

Mask specifying which fields to read from each result. If no mask is specified, will default to all fields except items.acl and items.owner.

• may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 8;

Returns
Type	Description
ListObjectsRequest.Builder

clearVersions()

public ListObjectsRequest.Builder clearVersions()

If true, lists all versions of an object as distinct results. For more information, see Object Versioning.

bool versions = 7;

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

clone()

public ListObjectsRequest.Builder clone()

Returns
Type	Description
ListObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListObjectsRequest getDefaultInstanceForType()

Returns
Type	Description
ListObjectsRequest

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;

Returns
Type	Description
String	The delimiter.

getDelimiterBytes()

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

Returns
Type	Description
ByteString	The bytes for delimiter.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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;

Returns
Type	Description
boolean	The includeTrailingDelimiter.

getLexicographicEnd()

public String getLexicographicEnd()

Optional. Filter results to objects whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the objects listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

string lexicographic_end = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The lexicographicEnd.

getLexicographicEndBytes()

public ByteString getLexicographicEndBytes()

Optional. Filter results to objects whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the objects listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

string lexicographic_end = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for lexicographicEnd.

getLexicographicStart()

public String getLexicographicStart()

Optional. Filter results to objects whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the objects listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

string lexicographic_start = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The lexicographicStart.

getLexicographicStartBytes()

public ByteString getLexicographicStartBytes()

Optional. Filter results to objects whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the objects listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

string lexicographic_start = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for lexicographicStart.

getMatchGlob()

public String getMatchGlob()

Optional. Filter results to objects and prefixes that match this glob pattern. See List Objects Using Glob for the full syntax.

string match_glob = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The matchGlob.

getMatchGlobBytes()

public ByteString getMatchGlobBytes()

Optional. Filter results to objects and prefixes that match this glob pattern. See List Objects Using Glob for the full syntax.

string match_glob = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for matchGlob.

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;

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. Name of the bucket in which to look for objects.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The parent.

getParentBytes()

public 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) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.

getPrefix()

public String getPrefix()

Filter results to objects whose names begin with this prefix.

string prefix = 6;

Returns
Type	Description
String	The prefix.

getPrefixBytes()

public ByteString getPrefixBytes()

Filter results to objects whose names begin with this prefix.

string prefix = 6;

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.acl and items.owner.

• may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 8;

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.acl and items.owner.

• may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 8;

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.acl and items.owner.

• may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 8;

Returns
Type	Description
FieldMaskOrBuilder

getVersions()

public boolean getVersions()

If true, lists all versions of an object as distinct results. For more information, see Object Versioning.

bool versions = 7;

Returns
Type	Description
boolean	The versions.

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.acl and items.owner.

• may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 8;

Returns
Type	Description
boolean	Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListObjectsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListObjectsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ListObjectsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ListObjectsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(ListObjectsRequest other)

public ListObjectsRequest.Builder mergeFrom(ListObjectsRequest other)

Parameter
Name	Description
other	ListObjectsRequest

Returns
Type	Description
ListObjectsRequest.Builder

mergeReadMask(FieldMask value)

public ListObjectsRequest.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.acl and items.owner.

• may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 8;

Parameter
Name	Description
value	FieldMask

Returns
Type	Description
ListObjectsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListObjectsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ListObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setDelimiter(String value)

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;

Parameter
Name	Description
value	String The delimiter to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setDelimiterBytes(ByteString value)

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

Parameter
Name	Description
value	ByteString The bytes for delimiter to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ListObjectsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ListObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIncludeTrailingDelimiter(boolean value)

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;

Parameter
Name	Description
value	boolean The includeTrailingDelimiter to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setLexicographicEnd(String value)

public ListObjectsRequest.Builder setLexicographicEnd(String value)

Optional. Filter results to objects whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the objects listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

string lexicographic_end = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The lexicographicEnd to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setLexicographicEndBytes(ByteString value)

public ListObjectsRequest.Builder setLexicographicEndBytes(ByteString value)

Optional. Filter results to objects whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the objects listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

string lexicographic_end = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for lexicographicEnd to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setLexicographicStart(String value)

public ListObjectsRequest.Builder setLexicographicStart(String value)

Optional. Filter results to objects whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the objects listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

string lexicographic_start = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The lexicographicStart to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setLexicographicStartBytes(ByteString value)

public ListObjectsRequest.Builder setLexicographicStartBytes(ByteString value)

Optional. Filter results to objects whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the objects listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

string lexicographic_start = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for lexicographicStart to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setMatchGlob(String value)

public ListObjectsRequest.Builder setMatchGlob(String value)

Optional. Filter results to objects and prefixes that match this glob pattern. See List Objects Using Glob for the full syntax.

string match_glob = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The matchGlob to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setMatchGlobBytes(ByteString value)

public ListObjectsRequest.Builder setMatchGlobBytes(ByteString value)

Optional. Filter results to objects and prefixes that match this glob pattern. See List Objects Using Glob for the full syntax.

string match_glob = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for matchGlob to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setPageSize(int value)

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;

Parameter
Name	Description
value	int The pageSize to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setPageToken(String value)

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;

Parameter
Name	Description
value	String The pageToken to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListObjectsRequest.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	ByteString The bytes for pageToken to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setParent(String value)

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) = { ... }

Parameter
Name	Description
value	String The parent to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public ListObjectsRequest.Builder setParentBytes(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) = { ... }

Parameter
Name	Description
value	ByteString The bytes for parent to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setPrefix(String value)

public ListObjectsRequest.Builder setPrefix(String value)

Filter results to objects whose names begin with this prefix.

string prefix = 6;

Parameter
Name	Description
value	String The prefix to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setPrefixBytes(ByteString value)

public ListObjectsRequest.Builder setPrefixBytes(ByteString value)

Filter results to objects whose names begin with this prefix.

string prefix = 6;

Parameter
Name	Description
value	ByteString The bytes for prefix to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.

setReadMask(FieldMask value)

public ListObjectsRequest.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.acl and items.owner.

• may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 8;

Parameter
Name	Description
value	FieldMask

Returns
Type	Description
ListObjectsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListObjectsRequest.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.acl and items.owner.

• may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 8;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
ListObjectsRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListObjectsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
ListObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListObjectsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ListObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setVersions(boolean value)

public ListObjectsRequest.Builder setVersions(boolean value)

If true, lists all versions of an object as distinct results. For more information, see Object Versioning.

bool versions = 7;

Parameter
Name	Description
value	boolean The versions to set.

Returns
Type	Description
ListObjectsRequest.Builder	This builder for chaining.