public static final class ListObjectsRequest.Builder extends GeneratedMessageV3.Builder<ListObjectsRequest.Builder> implements ListObjectsRequestOrBuilderRequest message for ListObjects.
Protobuf type google.storage.v2.ListObjectsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListObjectsRequest.BuilderImplements
ListObjectsRequestOrBuilderStatic 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 |
|
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 |
|
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 |
|
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. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListObjectsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListObjectsRequest.Builder |
|
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 |
|
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 |
|
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. |
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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListObjectsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListObjectsRequest.Builder |
|
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 |
|
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 |
StringThe 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 |
ByteStringThe 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 |
|
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 |
booleanThe 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 |
StringThe 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 |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe bytes for lexicographicStart 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 |
intThe 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 |
StringThe 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 |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListObjectsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListObjectsRequest.Builder |
|
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 |
booleanThe versions to set. |
| Returns | |
|---|---|
| Type | Description |
ListObjectsRequest.Builder |
This builder for chaining. |