ListObjectsRequest

com.google.storage.v2.storage.ListObjectsRequest

See theListObjectsRequest companion object

final case class ListObjectsRequest(parent: String, pageSize: Int, pageToken: String, delimiter: String, includeTrailingDelimiter: Boolean, prefix: String, versions: Boolean, readMask: Option[FieldMask], lexicographicStart: String, lexicographicEnd: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ListObjectsRequest]

Request message for ListObjects.

Value parameters

delimiter: 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.
includeTrailingDelimiter: If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
lexicographicEnd: 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).
lexicographicStart: 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).
pageSize: 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.
pageToken: A previously-returned page token representing part of the larger set of results to view.
parent: Required. Name of the bucket in which to look for objects.
prefix: Filter results to objects whose names begin with this prefix.
readMask: 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".
versions: If true, lists all versions of an object as distinct results. For more information, see [Object Versioning](https://cloud.google.com/storage/docs/object-versioning).

Attributes

Companion: object
Source: ListObjectsRequest.scala
Graph
Supertypes: trait Updatable[ListObjectsRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all