Reference documentation and code samples for the Storage Control V2 API class Google::Cloud::Storage::Control::V2::ListFoldersRequest.
Request message for ListFolders. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#delimiter
def delimiter() -> ::String
Returns
- (::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 '/'.
#delimiter=
def delimiter=(value) -> ::String
Parameter
- value (::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 '/'.
Returns
- (::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_end
def lexicographic_end() -> ::String
Returns
- (::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).
#lexicographic_end=
def lexicographic_end=(value) -> ::String
Parameter
- value (::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).
Returns
- (::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).
#lexicographic_start
def lexicographic_start() -> ::String
Returns
- (::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_start=
def lexicographic_start=(value) -> ::String
Parameter
- value (::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).
Returns
- (::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).
#page_size
def page_size() -> ::Integer
Returns
- (::Integer) — 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_size=
def page_size=(value) -> ::Integer
Parameter
- value (::Integer) — 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
- (::Integer) — 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
def page_token() -> ::String
Returns
- (::String) — Optional. A previously-returned page token representing part of the larger set of results to view.
#page_token=
def page_token=(value) -> ::String
Parameter
- value (::String) — Optional. A previously-returned page token representing part of the larger set of results to view.
Returns
- (::String) — Optional. A previously-returned page token representing part of the larger set of results to view.
#parent
def parent() -> ::String
Returns
- (::String) — Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.
#parent=
def parent=(value) -> ::String
Parameter
- value (::String) — Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.
Returns
- (::String) — Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.
#prefix
def prefix() -> ::String
Returns
- (::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 '/'.
#prefix=
def prefix=(value) -> ::String
Parameter
- value (::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 '/'.
Returns
- (::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 '/'.
#request_id
def request_id() -> ::String
Returns
- (::String) — Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
#request_id=
def request_id=(value) -> ::String
Parameter
- value (::String) — Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
Returns
- (::String) — Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.