Google Cloud Storage Control V2 Client - Class ListFoldersRequest (1.6.1)

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.

Generated from protobuf message google.storage.control.v2.ListFoldersRequest

Namespace

Google \ Cloud \ Storage \ Control \ V2

Methods

__construct

Constructor.

Parameters
Name Description
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.

Returns
Type Description
string

setParent

Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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

Returns
Type Description
string

setPageToken

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

Parameter
Name Description
var string
Returns
Type Description
$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 '/'.

Returns
Type Description
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 '/'.

Parameter
Name Description
var string
Returns
Type Description
$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 '/'.

Returns
Type Description
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 '/'.

Parameter
Name Description
var string
Returns
Type Description
$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).

Returns
Type Description
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).

Parameter
Name Description
var string
Returns
Type Description
$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).

Returns
Type Description
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).

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Returns
Type Description
string

setRequestId

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket. Please see StorageControlClient::bucketName() for help formatting this field.
Returns
Type Description
ListFoldersRequest