Google Cloud Storage Control V2 Client - Class Folder (1.3.0)

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

A folder resource. This resource can only exist in a hierarchical namespace enabled bucket.

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

Namespace

Google \ Cloud \ Storage \ Control \ V2

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Identifier. The name of this folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}

↳ metageneration
int|string

Output only. The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.

↳ create_time
Google\Protobuf\Timestamp

Output only. The creation time of the folder.

↳ update_time
Google\Protobuf\Timestamp

Output only. The modification time of the folder.

↳ pending_rename_info
PendingRenameInfo

Output only. Only present if the folder is part of an ongoing RenameFolder operation. Contains information which can be used to query the operation status. The presence of this field also indicates all write operations are blocked for this folder, including folder, managed folder, and object operations.

getName

Identifier. The name of this folder.

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

Returns
Type
Description
string

setName

Identifier. The name of this folder.

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getMetageneration

Output only. The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.

Returns
Type
Description
int|string

setMetageneration

Output only. The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getCreateTime

Output only. The creation time of the folder.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time of the folder.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The modification time of the folder.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The modification time of the folder.

Parameter
Name
Description
Returns
Type
Description
$this

getPendingRenameInfo

Output only. Only present if the folder is part of an ongoing RenameFolder operation. Contains information which can be used to query the operation status. The presence of this field also indicates all write operations are blocked for this folder, including folder, managed folder, and object operations.

Returns
Type
Description

hasPendingRenameInfo

clearPendingRenameInfo

setPendingRenameInfo

Output only. Only present if the folder is part of an ongoing RenameFolder operation. Contains information which can be used to query the operation status. The presence of this field also indicates all write operations are blocked for this folder, including folder, managed folder, and object operations.

Parameter
Name
Description
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: