Reference documentation and code samples for the Google Cloud Storage Control V2 Client class ListFoldersRequest.
Request message for ListFolders. This operation is only applicable to a hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in allowlist preview.
Generated from protobuf message google.storage.control.v2.ListFoldersRequest
Namespace
Google \ Cloud \ Storage \ Control \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.
↳ page_size
int
Optional. Maximum number of folders to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
↳ page_token
string
Optional. A previously-returned page token representing part of the larger set of results to view.
↳ prefix
string
Optional. Filter results to folders whose names begin with this prefix. If set, the value must either be an empty string or end with a '/'.
↳ delimiter
string
Optional. If set, returns results in a directory-like mode. The results will only include folders that either exactly match the above prefix, or are one level below the prefix. The only supported value is '/'.
↳ lexicographic_start
string
Optional. Filter results to folders whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
↳ lexicographic_end
string
Optional. Filter results to folders whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
↳ request_id
string
Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
getParent
Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.
string
setParent
Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.
var
string
$this
getPageSize
Optional. Maximum number of folders to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
int
setPageSize
Optional. Maximum number of folders to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
var
int
$this
getPageToken
Optional. A previously-returned page token representing part of the larger set of results to view.
string
setPageToken
Optional. A previously-returned page token representing part of the larger set of results to view.
var
string
$this
getPrefix
Optional. Filter results to folders whose names begin with this prefix.
If set, the value must either be an empty string or end with a '/'.
string
setPrefix
Optional. Filter results to folders whose names begin with this prefix.
If set, the value must either be an empty string or end with a '/'.
var
string
$this
getDelimiter
Optional. If set, returns results in a directory-like mode. The results will only include folders that either exactly match the above prefix, or are one level below the prefix. The only supported value is '/'.
string
setDelimiter
Optional. If set, returns results in a directory-like mode. The results will only include folders that either exactly match the above prefix, or are one level below the prefix. The only supported value is '/'.
var
string
$this
getLexicographicStart
Optional. Filter results to folders whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
string
setLexicographicStart
Optional. Filter results to folders whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
var
string
$this
getLexicographicEnd
Optional. Filter results to folders whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
string
setLexicographicEnd
Optional. Filter results to folders whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
var
string
$this
getRequestId
Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
string
setRequestId
Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
var
string
$this
static::build
parent
string
Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket. Please see Google\Cloud\Storage\Control\V2\StorageControlClient::bucketName() for help formatting this field.
