Interface ListObjectsRequestOrBuilder (2.19.0)

Version 2.19.0

• 2.44.1 (latest)
• 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 interface ListObjectsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDelimiter()

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

getIncludeTrailingDelimiter()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract String getPrefix()

Filter results to objects whose names begin with this prefix.

string prefix = 6;

Returns

Type	Description
String	The prefix.

getPrefixBytes()

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