Reference documentation and code samples for the Google Cloud Storage Control V2 Client class CreateFolderRequest.
Request message for CreateFolder. This operation is only applicable to a hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in allowlist preview.
Generated from protobuf message google.storage.control.v2.CreateFolderRequest
Namespace
Google \ Cloud \ Storage \ Control \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.
↳ folder
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
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.
↳ recursive
bool
Optional. If true, parent folder doesn't have to be present and all missing ancestor folders will be created atomically.
↳ 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 the folder will reside. The bucket must be a hierarchical namespace enabled bucket.
string
setParent
Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.
var
string
$this
getFolder
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.
hasFolder
clearFolder
setFolder
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.
$this
getFolderId
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.
string
setFolderId
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.
var
string
$this
getRecursive
Optional. If true, parent folder doesn't have to be present and all missing ancestor folders will be created atomically.
bool
setRecursive
Optional. If true, parent folder doesn't have to be present and all missing ancestor folders will be created atomically.
var
bool
$this
getRequestId
Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
string
setRequestId
Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
var
string
$this
static::build
parent
string
Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket. Please see Google\Cloud\Storage\Control\V2\StorageControlClient::bucketName() for help formatting this field.
folder
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.
folderId
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.