Google Cloud Storage Control V2 Client - Class DeleteManagedFolderRequest (0.2.1)

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

DeleteManagedFolder RPC request message.

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

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 managed folder. Format: `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}`
`↳ if_metageneration_match`	`int\|string` The operation succeeds conditional on the managed folder's current metageneration matching the value here specified.
`↳ if_metageneration_not_match`	`int\|string` The operation succeeds conditional on the managed folder's current metageneration NOT matching the value here specified.
`↳ allow_non_empty`	`bool` Allows deletion of a managed folder even if it is not empty. A managed folder is empty if it manages no child managed folders or objects. Caller must have permission for storage.managedFolders.setIamPolicy.
`↳ 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 managed folder.

Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}

Returns
Type	Description
`string`

setName

Required. Name of the managed folder.

Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getIfMetagenerationMatch

The operation succeeds conditional on the managed folder's current metageneration matching the value here specified.

Returns
Type	Description
`int\|string`

hasIfMetagenerationMatch

clearIfMetagenerationMatch

setIfMetagenerationMatch

The operation succeeds conditional on the managed folder's current metageneration matching the value here specified.

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

Returns
Type	Description
`$this`

getIfMetagenerationNotMatch

The operation succeeds conditional on the managed folder's current metageneration NOT matching the value here specified.

Returns
Type	Description
`int\|string`

hasIfMetagenerationNotMatch

clearIfMetagenerationNotMatch

setIfMetagenerationNotMatch

The operation succeeds conditional on the managed folder's current metageneration NOT matching the value here specified.

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

Returns
Type	Description
`$this`

getAllowNonEmpty

Allows deletion of a managed folder even if it is not empty.

A managed folder is empty if it manages no child managed folders or objects. Caller must have permission for storage.managedFolders.setIamPolicy.

Returns
Type	Description
`bool`

setAllowNonEmpty

Allows deletion of a managed folder even if it is not empty.

A managed folder is empty if it manages no child managed folders or objects. Caller must have permission for storage.managedFolders.setIamPolicy.

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

Parameter
Name	Description
`name`	`string` Required. Name of the managed folder. Format: `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}` Please see Google\Cloud\Storage\Control\V2\StorageControlClient::managedFolderName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Storage\Control\V2\DeleteManagedFolderRequest`