public final class ListObjectsRequest extends GeneratedMessageV3 implements ListObjectsRequestOrBuilder
Request message for ListObjects.
Protobuf type google.storage.v2.ListObjectsRequest
Static Fields
DELIMITER_FIELD_NUMBER
public static final int DELIMITER_FIELD_NUMBER
Field Value
INCLUDE_TRAILING_DELIMITER_FIELD_NUMBER
public static final int INCLUDE_TRAILING_DELIMITER_FIELD_NUMBER
Field Value
LEXICOGRAPHIC_END_FIELD_NUMBER
public static final int LEXICOGRAPHIC_END_FIELD_NUMBER
Field Value
LEXICOGRAPHIC_START_FIELD_NUMBER
public static final int LEXICOGRAPHIC_START_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
PREFIX_FIELD_NUMBER
public static final int PREFIX_FIELD_NUMBER
Field Value
READ_MASK_FIELD_NUMBER
public static final int READ_MASK_FIELD_NUMBER
Field Value
VERSIONS_FIELD_NUMBER
public static final int VERSIONS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListObjectsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListObjectsRequest.Builder newBuilder()
Returns
newBuilder(ListObjectsRequest prototype)
public static ListObjectsRequest.Builder newBuilder(ListObjectsRequest prototype)
Parameter
Returns
public static ListObjectsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListObjectsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListObjectsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListObjectsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListObjectsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListObjectsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListObjectsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListObjectsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListObjectsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListObjectsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListObjectsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListObjectsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListObjectsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ListObjectsRequest getDefaultInstanceForType()
Returns
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;
| 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;
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;
| 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];
| 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];
| 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];
| 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];
| Type | Description |
| ByteString | The bytes for lexicographicStart.
|
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;
| 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;
| 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;
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) = { ... }
| 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) = { ... }
getParserForType()
public Parser<ListObjectsRequest> getParserForType()
Returns
Overrides
getPrefix()
public String getPrefix()
Filter results to objects whose names begin with this prefix.
string prefix = 6;
| Type | Description |
| String | The prefix.
|
getPrefixBytes()
public ByteString getPrefixBytes()
Filter results to objects whose names begin with this prefix.
string prefix = 6;
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;
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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getVersions()
public boolean getVersions()
If true, lists all versions of an object as distinct results.
For more information, see
Object
Versioning.
bool versions = 7;
| 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;
| Type | Description |
| boolean | Whether the readMask field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListObjectsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListObjectsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListObjectsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
