Google Cloud Dataplex V1 Client - Class Environment (0.12.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Environment.

Environment represents a user-visible compute infrastructure for analytics within a lake.

Generated from protobuf message google.cloud.dataplex.v1.Environment

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}

↳ display_name
string

Optional. User friendly display name.

↳ uid
string

Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.

↳ create_time
Google\Protobuf\Timestamp

Output only. Environment creation time.

↳ update_time
Google\Protobuf\Timestamp

Output only. The time when the environment was last updated.

↳ labels
array| Google\Protobuf\Internal\MapField

Optional. User defined labels for the environment.

↳ description
string

Optional. Description of the environment.

↳ state
int

Output only. Current state of the environment.

↳ infrastructure_spec
Google\Cloud\Dataplex\V1\Environment\InfrastructureSpec

Required. Infrastructure specification for the Environment.

↳ session_spec
Google\Cloud\Dataplex\V1\Environment\SessionSpec

Optional. Configuration for sessions created for this environment.

↳ session_status
Google\Cloud\Dataplex\V1\Environment\SessionStatus

Output only. Status of sessions created for this environment.

↳ endpoints
Google\Cloud\Dataplex\V1\Environment\Endpoints

Output only. URI Endpoints to access sessions associated with the Environment.

getName

Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}

Returns
Type
Description
string

setName

Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

Optional. User friendly display name.

Returns
Type
Description
string

setDisplayName

Optional. User friendly display name.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getUid

Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.

Returns
Type
Description
string

setUid

Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

Output only. Environment creation time.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Environment creation time.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The time when the environment was last updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the environment was last updated.

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

Optional. User defined labels for the environment.

Returns
Type
Description

setLabels

Optional. User defined labels for the environment.

Parameter
Name
Description
Returns
Type
Description
$this

getDescription

Optional. Description of the environment.

Returns
Type
Description
string

setDescription

Optional. Description of the environment.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getState

Output only. Current state of the environment.

Returns
Type
Description
int

setState

Output only. Current state of the environment.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getInfrastructureSpec

Required. Infrastructure specification for the Environment.

hasInfrastructureSpec

clearInfrastructureSpec

setInfrastructureSpec

Required. Infrastructure specification for the Environment.

Returns
Type
Description
$this

getSessionSpec

Optional. Configuration for sessions created for this environment.

Returns
Type
Description

hasSessionSpec

clearSessionSpec

setSessionSpec

Optional. Configuration for sessions created for this environment.

Parameter
Name
Description
Returns
Type
Description
$this

getSessionStatus

Output only. Status of sessions created for this environment.

hasSessionStatus

clearSessionStatus

setSessionStatus

Output only. Status of sessions created for this environment.

Returns
Type
Description
$this

getEndpoints

Output only. URI Endpoints to access sessions associated with the Environment.

Returns
Type
Description

hasEndpoints

clearEndpoints

setEndpoints

Output only. URI Endpoints to access sessions associated with the Environment.

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