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

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

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 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
Type
Description
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
Name
Description
var
string
Returns
Type
Description
$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
Type
Description
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
Name
Description
var
string
Returns
Type
Description
$this

getDirectoryCustomerId

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

Returns
Type
Description
string

hasDirectoryCustomerId

setDirectoryCustomerId

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getState

Output only. The organization's current lifecycle state.

Returns
Type
Description
int

setState

Output only. The organization's current lifecycle state.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getCreateTime

Output only. Timestamp when the Organization was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when the Organization was created.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. Timestamp when the Organization was last modified.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when the Organization was last modified.

Parameter
Name
Description
Returns
Type
Description
$this

getDeleteTime

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

Returns
Type
Description

hasDeleteTime

clearDeleteTime

setDeleteTime

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

Parameter
Name
Description
Returns
Type
Description
$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
Type
Description
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
Name
Description
var
string
Returns
Type
Description
$this

getOwner

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: