Interface ListObjectsRequestOrBuilder (2.62.0)

Optional. If set, returns results in a directory-like mode. items contains only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter has their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.

string delimiter = 4 [(.google.api.field_behavior) = OPTIONAL];

Optional. If set, returns results in a directory-like mode. items contains only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter has their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.

string delimiter = 4 [(.google.api.field_behavior) = OPTIONAL];

Optional. An expression used to filter the returned objects by the context field. For the full syntax, see Filter objects by contexts syntax. If a delimiter is set, the returned prefixes are exempt from this filter.

string filter = 15 [(.google.api.field_behavior) = OPTIONAL];

Optional. An expression used to filter the returned objects by the context field. For the full syntax, see Filter objects by contexts syntax. If a delimiter is set, the returned prefixes are exempt from this filter.

string filter = 15 [(.google.api.field_behavior) = OPTIONAL];

Optional. If true, includes 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];

Optional. If true, objects that end in exactly one instance of delimiter has their metadata included in items in addition to prefixes.

bool include_trailing_delimiter = 5 [(.google.api.field_behavior) = OPTIONAL];

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

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

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

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

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

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

Optional. Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results might be returned than requested. The service uses this parameter or 1,000 items, whichever is smaller.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Optional. A previously-returned page token representing part of the larger set of results to view.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Optional. A previously-returned page token representing part of the larger set of results to view.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Required. Name of the bucket in which to look for objects.

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

Required. Name of the bucket in which to look for objects.

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

Optional. Filter results to objects whose names begin with this prefix.

string prefix = 6 [(.google.api.field_behavior) = OPTIONAL];

Optional. Filter results to objects whose names begin with this prefix.

string prefix = 6 [(.google.api.field_behavior) = OPTIONAL];

Mask specifying which fields to read from each result. If no mask is specified, defaults to all fields except items.acl and items.owner. * might be used to mean all fields.

optional .google.protobuf.FieldMask read_mask = 8;

Mask specifying which fields to read from each result. If no mask is specified, defaults to all fields except items.acl and items.owner. * might be used to mean all fields.

optional .google.protobuf.FieldMask read_mask = 8;

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

Optional. If true, lists all versions of an object as distinct results.

bool versions = 7 [(.google.api.field_behavior) = OPTIONAL];

Mask specifying which fields to read from each result. If no mask is specified, defaults to all fields except items.acl and items.owner. * might be used to mean all fields.

optional .google.protobuf.FieldMask read_mask = 8;