Google Cloud Resource Manager V3 Client - Class Organization (0.5.0)

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

The root node in the resource hierarchy to which a particular entity's (a company, for example) resources belong.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".

↳ display_name string

Output only. A human-readable string that refers to the organization in the Google Cloud Console. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, "google.com") of the Google Workspace customer that owns the organization.

↳ directory_customer_id string

Immutable. The G Suite / Workspace customer id used in the Directory API.

↳ state int

Output only. The organization's current lifecycle state.

↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp when the Organization was created.

↳ update_time Google\Protobuf\Timestamp

Output only. Timestamp when the Organization was last modified.

↳ delete_time Google\Protobuf\Timestamp

Output only. Timestamp when the Organization was requested for deletion.

↳ etag string

Output only. A checksum computed by the server based on the current value of the Organization 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 organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".

Returns
TypeDescription
string

setName

Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

Output only. A human-readable string that refers to the organization in the Google Cloud Console. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, "google.com") of the Google Workspace customer that owns the organization.

Returns
TypeDescription
string

setDisplayName

Output only. A human-readable string that refers to the organization in the Google Cloud Console. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, "google.com") of the Google Workspace customer that owns the organization.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDirectoryCustomerId

Immutable. The G Suite / Workspace customer id used in the Directory API.

Returns
TypeDescription
string

hasDirectoryCustomerId

setDirectoryCustomerId

Immutable. The G Suite / Workspace customer id used in the Directory API.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The organization's current lifecycle state.

Returns
TypeDescription
int

setState

Output only. The organization's current lifecycle state.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCreateTime

Output only. Timestamp when the Organization was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when the Organization was created.

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

getUpdateTime

Output only. Timestamp when the Organization was last modified.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when the Organization was last modified.

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

getDeleteTime

Output only. Timestamp when the Organization was requested for deletion.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. Timestamp when the Organization was requested for deletion.

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 Organization 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 Organization 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

getOwner

Returns
TypeDescription
string