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
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}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
| 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}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Optional. User friendly display name.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Optional. User friendly display name.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| 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.
Generated from protobuf field string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Environment creation time.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Environment creation time.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The time when the environment was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the environment was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Optional. User defined labels for the environment.
Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Optional. User defined labels for the environment.
Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. Description of the environment.
Generated from protobuf field string description = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. Description of the environment.
Generated from protobuf field string description = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. Current state of the environment.
Generated from protobuf field .google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. Current state of the environment.
Generated from protobuf field .google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInfrastructureSpec
Required. Infrastructure specification for the Environment.
Generated from protobuf field .google.cloud.dataplex.v1.Environment.InfrastructureSpec infrastructure_spec = 100 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Environment\InfrastructureSpec|null | |
hasInfrastructureSpec
clearInfrastructureSpec
setInfrastructureSpec
Required. Infrastructure specification for the Environment.
Generated from protobuf field .google.cloud.dataplex.v1.Environment.InfrastructureSpec infrastructure_spec = 100 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Environment\InfrastructureSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSessionSpec
Optional. Configuration for sessions created for this environment.
Generated from protobuf field .google.cloud.dataplex.v1.Environment.SessionSpec session_spec = 101 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Environment\SessionSpec|null | |
hasSessionSpec
clearSessionSpec
setSessionSpec
Optional. Configuration for sessions created for this environment.
Generated from protobuf field .google.cloud.dataplex.v1.Environment.SessionSpec session_spec = 101 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Environment\SessionSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSessionStatus
Output only. Status of sessions created for this environment.
Generated from protobuf field .google.cloud.dataplex.v1.Environment.SessionStatus session_status = 102 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Environment\SessionStatus|null | |
hasSessionStatus
clearSessionStatus
setSessionStatus
Output only. Status of sessions created for this environment.
Generated from protobuf field .google.cloud.dataplex.v1.Environment.SessionStatus session_status = 102 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Environment\SessionStatus
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndpoints
Output only. URI Endpoints to access sessions associated with the Environment.
Generated from protobuf field .google.cloud.dataplex.v1.Environment.Endpoints endpoints = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Environment\Endpoints|null | |
hasEndpoints
clearEndpoints
setEndpoints
Output only. URI Endpoints to access sessions associated with the Environment.
Generated from protobuf field .google.cloud.dataplex.v1.Environment.Endpoints endpoints = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Environment\Endpoints
|
| Returns | |
|---|---|
| Type | Description |
$this | |