Class: Google::Cloud::Storage::Control::V2::ListFoldersRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/storage/control/v2/storage_control.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#delimiter ⇒ ::String

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



179
180
181
182
 
# File 'proto_docs/google/storage/control/v2/storage_control.rb', line 179

class ListFoldersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#lexicographic_end ⇒ ::String

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



179
180
181
182
 
# File 'proto_docs/google/storage/control/v2/storage_control.rb', line 179

class ListFoldersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#lexicographic_start ⇒ ::String

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



179
180
181
182
 
# File 'proto_docs/google/storage/control/v2/storage_control.rb', line 179

class ListFoldersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

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



179
180
181
182
 
# File 'proto_docs/google/storage/control/v2/storage_control.rb', line 179

class ListFoldersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

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



179
180
181
182
 
# File 'proto_docs/google/storage/control/v2/storage_control.rb', line 179

class ListFoldersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

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



179
180
181
182
 
# File 'proto_docs/google/storage/control/v2/storage_control.rb', line 179

class ListFoldersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#prefix ⇒ ::String

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



179
180
181
182
 
# File 'proto_docs/google/storage/control/v2/storage_control.rb', line 179

class ListFoldersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#request_id ⇒ ::String

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



179
180
181
182
 
# File 'proto_docs/google/storage/control/v2/storage_control.rb', line 179

class ListFoldersRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end