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.
| Parameters | |
|---|---|
| Name | Description |
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_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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Storage\Control\V2\Folder|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Storage\Control\V2\Folder
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRecursive
Optional. If true, parent folder doesn't have to be present and all missing ancestor folders will be created atomically.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRecursive
Optional. If true, parent folder doesn't have to be present and all missing ancestor folders will be created atomically.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestId
Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRequestId
Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
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 |
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. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Storage\Control\V2\CreateFolderRequest |
|