Google Cloud Resource Manager V3 Client - Class Project (1.1.1)

Version latest

• 1.1.1 (latest)
• 1.1.0
• 1.0.4
• 0.8.5
• 0.7.2
• 0.6.1
• 0.5.0
• 0.4.1
• 0.3.9

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

A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.

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

Namespace

Google \ Cloud \ ResourceManager \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Output only. The unique resource name of the project. It is an int64 generated number prefixed by "projects/". Example: projects/415104041262
↳ parent	string Optional. A reference to a parent Resource. eg., organizations/123 or folders/876.
↳ project_id	string Immutable. The unique, user-assigned id of the project. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123
↳ state	int Output only. The project lifecycle state.
↳ display_name	string Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project
↳ create_time	Google\Protobuf\Timestamp Output only. Creation time.
↳ update_time	Google\Protobuf\Timestamp Output only. The most recent time this resource was modified.
↳ delete_time	Google\Protobuf\Timestamp Output only. The time at which this resource was requested for deletion.
↳ etag	string Output only. A checksum computed by the server based on the current value of the Project resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
↳ labels	array|Google\Protobuf\Internal\MapField Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "myBusinessDimension" : "businessValue"

getName

Output only. The unique resource name of the project. It is an int64 generated number prefixed by "projects/".

Example: projects/415104041262

Returns
Type	Description
string

setName

Output only. The unique resource name of the project. It is an int64 generated number prefixed by "projects/".

Example: projects/415104041262

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getParent

Optional. A reference to a parent Resource. eg., organizations/123 or folders/876.

Returns
Type	Description
string

setParent

Optional. A reference to a parent Resource. eg., organizations/123 or folders/876.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getProjectId

Immutable. The unique, user-assigned id of the project.

It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123

Returns
Type	Description
string

setProjectId

Immutable. The unique, user-assigned id of the project.

It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getState

Output only. The project lifecycle state.

Returns
Type	Description
int	Enum of type State.

setState

Output only. The project lifecycle state.

Parameter
Name	Description
var	int Enum of type State.

Returns
Type	Description
$this

getDisplayName

Optional. A user-assigned display name of the project.

When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project

Returns
Type	Description
string

setDisplayName

Optional. A user-assigned display name of the project.

When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

Output only. Creation time.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation time.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. The most recent time this resource was modified.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The most recent time this resource was modified.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getDeleteTime

Output only. The time at which this resource was requested for deletion.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. The time at which this resource was requested for deletion.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getEtag

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

Returns
Type	Description
string

setEtag

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLabels

Optional. The labels associated with this project.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "myBusinessDimension" : "businessValue"

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

Optional. The labels associated with this project.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "myBusinessDimension" : "businessValue"

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this