Google Cloud Storage Control V2 Client - Class DeleteFolderRequest (1.1.0)

Reference documentation and code samples for the Google Cloud Storage Control V2 Client class DeleteFolderRequest.

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

Generated from protobuf message google.storage.control.v2.DeleteFolderRequest

Namespace

Google \ Cloud \ Storage \ Control \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. Name of the folder. Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
`↳ if_metageneration_match`	`int\|string` Makes the operation only succeed conditional on whether the folder's current metageneration matches the given value.
`↳ if_metageneration_not_match`	`int\|string` Makes the operation only succeed conditional on whether the folder's current metageneration does not match the given value.
`↳ request_id`	`string` Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

getName

Required. Name of the folder.

Format: projects/{project}/buckets/{bucket}/folders/{folder}

Returns
Type	Description
`string`

setName

Required. Name of the folder.

Format: projects/{project}/buckets/{bucket}/folders/{folder}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getIfMetagenerationMatch

Makes the operation only succeed conditional on whether the folder's current metageneration matches the given value.

Returns
Type	Description
`int\|string`

hasIfMetagenerationMatch

clearIfMetagenerationMatch

setIfMetagenerationMatch

Makes the operation only succeed conditional on whether the folder's current metageneration matches the given value.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getIfMetagenerationNotMatch

Makes the operation only succeed conditional on whether the folder's current metageneration does not match the given value.

Returns
Type	Description
`int\|string`

hasIfMetagenerationNotMatch

clearIfMetagenerationNotMatch

setIfMetagenerationNotMatch