Google Cloud Resource Manager V3 Client - Class Folder (0.3.9)

Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class Folder.

A folder in an organization's resource hierarchy, used to organize that organization's resources.

Generated from protobuf message google.cloud.resourcemanager.v3.Folder

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".

↳ parent string

Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.

↳ display_name string

The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

↳ state int

Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.

↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp when the folder was created.

↳ update_time Google\Protobuf\Timestamp

Output only. Timestamp when the folder was last modified.

↳ delete_time Google\Protobuf\Timestamp

Output only. Timestamp when the folder was requested to be deleted.

↳ etag string

Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

getName

Output only. The resource name of the folder.

Its format is folders/{folder_id}, for example: "folders/1234".

Returns
TypeDescription
string

setName

Output only. The resource name of the folder.

Its format is folders/{folder_id}, for example: "folders/1234".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getParent

Required. The folder's parent's resource name.

Updates to the folder's parent must be performed using MoveFolder.

Returns
TypeDescription
string

setParent

Required. The folder's parent's resource name.

Updates to the folder's parent must be performed using MoveFolder.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

The folder's display name.

A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

Returns
TypeDescription
string

setDisplayName

The folder's display name.

A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The lifecycle state of the folder.

Updates to the state must be performed using DeleteFolder and UndeleteFolder.

Returns
TypeDescription
int

setState

Output only. The lifecycle state of the folder.

Updates to the state must be performed using DeleteFolder and UndeleteFolder.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCreateTime

Output only. Timestamp when the folder was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when the folder was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. Timestamp when the folder was last modified.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when the folder was last modified.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getDeleteTime

Output only. Timestamp when the folder was requested to be deleted.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. Timestamp when the folder was requested to be deleted.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEtag

Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Returns
TypeDescription
string

setEtag

Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Parameter
NameDescription
var string
Returns
TypeDescription
$this