Google Cloud Storage Control V2 Client - Class RenameFolderRequest (1.0.1)

Version latest

• 1.0.1 (latest)
• 1.0.0
• 0.2.1
• 0.1.1

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

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

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

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 source folder being renamed. Format: projects/{project}/buckets/{bucket}/folders/{folder}
↳ destination_folder_id	string Required. The destination folder ID, e.g. foo/bar/.
↳ if_metageneration_match	int|string Makes the operation only succeed conditional on whether the source folder's current metageneration matches the given value.
↳ if_metageneration_not_match	int|string Makes the operation only succeed conditional on whether the source 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. This request is only idempotent if a request_id is provided.

getName

Required. Name of the source folder being renamed.

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

Returns
Type	Description
string

setName

Required. Name of the source folder being renamed.

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDestinationFolderId

Required. The destination folder ID, e.g. foo/bar/.

Returns
Type	Description
string

setDestinationFolderId

Required. The destination folder ID, e.g. foo/bar/.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getIfMetagenerationMatch

Makes the operation only succeed conditional on whether the source 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 source 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 source folder's current metageneration does not match the given value.

Returns
Type	Description
int|string

hasIfMetagenerationNotMatch

clearIfMetagenerationNotMatch

setIfMetagenerationNotMatch

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

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getRequestId

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

Returns
Type	Description
string

setRequestId

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameters
Name	Description
name	string Required. Name of the source folder being renamed. Format: projects/{project}/buckets/{bucket}/folders/{folder} Please see StorageControlClient::folderName() for help formatting this field.
destinationFolderId	string Required. The destination folder ID, e.g. foo/bar/.

Returns
Type	Description
RenameFolderRequest