Class ListObjectsRequest (2.40.0)

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
Type Description
int

INCLUDE_FOLDERS_AS_PREFIXES_FIELD_NUMBER

public static final int INCLUDE_FOLDERS_AS_PREFIXES_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_TRAILING_DELIMITER_FIELD_NUMBER

public static final int INCLUDE_TRAILING_DELIMITER_FIELD_NUMBER
Field Value
Type Description
int

LEXICOGRAPHIC_END_FIELD_NUMBER

public static final int LEXICOGRAPHIC_END_FIELD_NUMBER
Field Value
Type Description
int

LEXICOGRAPHIC_START_FIELD_NUMBER

public static final int LEXICOGRAPHIC_START_FIELD_NUMBER
Field Value
Type Description
int

MATCH_GLOB_FIELD_NUMBER

public static final int MATCH_GLOB_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PREFIX_FIELD_NUMBER

public static final int PREFIX_FIELD_NUMBER
Field Value
Type Description
int

READ_MASK_FIELD_NUMBER

public static final int READ_MASK_FIELD_NUMBER
Field Value
Type Description
int

SOFT_DELETED_FIELD_NUMBER

public static final int SOFT_DELETED_FIELD_NUMBER
Field Value
Type Description
int

VERSIONS_FIELD_NUMBER

public static final int VERSIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListObjectsRequest getDefaultInstance()
Returns
Type Description
ListObjectsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListObjectsRequest.Builder newBuilder()
Returns
Type Description
ListObjectsRequest.Builder

newBuilder(ListObjectsRequest prototype)

public static ListObjectsRequest.Builder newBuilder(ListObjectsRequest prototype)
Parameter
Name Description
prototype ListObjectsRequest
Returns
Type Description
ListObjectsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListObjectsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListObjectsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListObjectsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListObjectsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListObjectsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListObjectsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListObjectsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListObjectsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListObjectsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListObjectsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListObjectsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListObjectsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListObjectsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListObjectsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListObjectsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListObjectsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListObjectsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListObjectsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListObjectsRequest> parser()
Returns
Type Description
Parser<ListObjectsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

getIncludeFoldersAsPrefixes()

public boolean getIncludeFoldersAsPrefixes()

Optional. If true, will also include folders and managed folders (besides objects) in the returned prefixes. Requires delimiter to be set to '/'.

bool include_folders_as_prefixes = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The includeFoldersAsPrefixes.

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.

getParserForType()

public Parser<ListObjectsRequest> getParserForType()
Returns
Type Description
Parser<ListObjectsRequest>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSoftDeleted()

public boolean getSoftDeleted()

Optional. If true, only list all soft-deleted versions of the object. Soft delete policy is required to set this option.

bool soft_deleted = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The softDeleted.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListObjectsRequest.Builder newBuilderForType()
Returns
Type Description
ListObjectsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListObjectsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListObjectsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListObjectsRequest.Builder toBuilder()
Returns
Type Description
ListObjectsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException