Cloud Storage v2 API - Class ListFoldersRequest (1.1.0) 

public sealed class ListFoldersRequest : IMessage<ListFoldersRequest>, IEquatable<ListFoldersRequest>, IDeepCloneable<ListFoldersRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Cloud Storage v2 API class ListFoldersRequest.

Request message for ListFolders. This operation is only applicable to a hierarchical namespace enabled bucket.

Inheritance

object > ListFoldersRequest

Namespace

Google.Cloud.Storage.Control.V2

Assembly

Google.Cloud.Storage.Control.V2.dll

Constructors

ListFoldersRequest()

public ListFoldersRequest()

ListFoldersRequest(ListFoldersRequest)

public ListFoldersRequest(ListFoldersRequest other)
Parameter
Name Description
other ListFoldersRequest

Properties

Delimiter

public string Delimiter { get; set; }

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 '/'.

Property Value
Type Description
string

LexicographicEnd

public string LexicographicEnd { get; set; }

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).

Property Value
Type Description
string

LexicographicStart

public string LexicographicStart { get; set; }

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).

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

Optional. Maximum number of folders to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

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

Property Value
Type Description
string

Parent

public string Parent { get; set; }

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

Property Value
Type Description
string

ParentAsBucketName

public BucketName ParentAsBucketName { get; set; }

BucketName-typed view over the Parent resource name property.

Property Value
Type Description
BucketName

Prefix

public string Prefix { get; set; }

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 '/'.

Property Value
Type Description
string

RequestId

public string RequestId { get; set; }

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

Property Value
Type Description
string