Storage Control V2 API - Class Google::Cloud::Storage::Control::V2::CreateFolderRequest (v0.1.0)

Reference documentation and code samples for the Storage Control V2 API class Google::Cloud::Storage::Control::V2::CreateFolderRequest.

Request message for CreateFolder. 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

#folder

def folder() -> ::Google::Cloud::Storage::Control::V2::Folder
Returns
  • (::Google::Cloud::Storage::Control::V2::Folder) — Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.

#folder=

def folder=(value) -> ::Google::Cloud::Storage::Control::V2::Folder
Parameter
  • value (::Google::Cloud::Storage::Control::V2::Folder) — Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.
Returns
  • (::Google::Cloud::Storage::Control::V2::Folder) — Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.

#folder_id

def folder_id() -> ::String
Returns
  • (::String) — Required. The full name of a folder, including all its parent folders. Folders use single '/' characters as a delimiter. The folder_id must end with a slash. For example, the folder_id of "books/biographies/" would create a new "biographies/" folder under the "books/" folder.

#folder_id=

def folder_id=(value) -> ::String
Parameter
  • value (::String) — Required. The full name of a folder, including all its parent folders. Folders use single '/' characters as a delimiter. The folder_id must end with a slash. For example, the folder_id of "books/biographies/" would create a new "biographies/" folder under the "books/" folder.
Returns
  • (::String) — Required. The full name of a folder, including all its parent folders. Folders use single '/' characters as a delimiter. The folder_id must end with a slash. For example, the folder_id of "books/biographies/" would create a new "biographies/" folder under the "books/" folder.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.
Returns
  • (::String) — Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.

#recursive

def recursive() -> ::Boolean
Returns
  • (::Boolean) — Optional. If true, parent folder doesn't have to be present and all missing ancestor folders will be created atomically.

#recursive=

def recursive=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If true, parent folder doesn't have to be present and all missing ancestor folders will be created atomically.
Returns
  • (::Boolean) — Optional. If true, parent folder doesn't have to be present and all missing ancestor folders will be created atomically.

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