Google Cloud Dataplex V1 Client - Class Environment (0.5.1)

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
NameDescription
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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

Optional. User friendly display name.

Returns
TypeDescription
string

setDisplayName

Optional. User friendly display name.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. Environment creation time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Environment creation time.

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

getUpdateTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

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

getLabels

Optional. User defined labels for the environment.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional. User defined labels for the environment.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getDescription

Optional. Description of the environment.

Returns
TypeDescription
string

setDescription

Optional. Description of the environment.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. Current state of the environment.

Returns
TypeDescription
int

setState

Output only. Current state of the environment.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getInfrastructureSpec

Required. Infrastructure specification for the Environment.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Environment\InfrastructureSpec|null

hasInfrastructureSpec

clearInfrastructureSpec

setInfrastructureSpec

Required. Infrastructure specification for the Environment.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Environment\InfrastructureSpec
Returns
TypeDescription
$this

getSessionSpec

Optional. Configuration for sessions created for this environment.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Environment\SessionSpec|null

hasSessionSpec

clearSessionSpec

setSessionSpec

Optional. Configuration for sessions created for this environment.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Environment\SessionSpec
Returns
TypeDescription
$this

getSessionStatus

Output only. Status of sessions created for this environment.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Environment\SessionStatus|null

hasSessionStatus

clearSessionStatus

setSessionStatus

Output only. Status of sessions created for this environment.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Environment\SessionStatus
Returns
TypeDescription
$this

getEndpoints

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

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Environment\Endpoints|null

hasEndpoints

clearEndpoints

setEndpoints

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

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Environment\Endpoints
Returns
TypeDescription
$this