Google Cloud Orchestration Airflow V1 Client - Class Environment (2.1.0)

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

An environment for running orchestration tasks.

Generated from protobuf message google.cloud.orchestration.airflow.service.v1.Environment

Namespace

Google \ Cloud \ Orchestration \ Airflow \ Service \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
`↳ config`	`Google\Cloud\Orchestration\Airflow\Service\V1\EnvironmentConfig` Configuration parameters for this environment.
`↳ uuid`	`string` Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.
`↳ state`	`int` The current state of the environment.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The time at which this environment was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The time at which this environment was last modified.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}-]{0,63} Both keys and values are additionally constrained to be <= 128 bytes in size.
`↳ satisfies_pzs`	`bool` Output only. Reserved for future use.
`↳ satisfies_pzi`	`bool` Output only. Reserved for future use.
`↳ storage_config`	`Google\Cloud\Orchestration\Airflow\Service\V1\StorageConfig` Optional. Storage configuration for this environment.

getName

The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

Returns
Type	Description
`string`

setName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getConfig

Configuration parameters for this environment.

Returns
Type	Description
`Google\Cloud\Orchestration\Airflow\Service\V1\EnvironmentConfig\|null`

hasConfig

clearConfig

setConfig

Configuration parameters for this environment.

Parameter
Name	Description
`var`	`Google\Cloud\Orchestration\Airflow\Service\V1\EnvironmentConfig`

Returns
Type	Description
`$this`

getUuid

Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.

Returns
Type	Description
`string`

setUuid

Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getState

The current state of the environment.

Returns
Type	Description
`int`

setState

The current state of the environment.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getCreateTime

Output only. The time at which this environment was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which this environment was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The time at which this environment was last modified.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time at which this environment was last modified.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getLabels

Optional. User-defined labels for this environment.

The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

Keys must conform to regexp: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
Both keys and values are additionally constrained to be <= 128 bytes in size.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Optional. User-defined labels for this environment.

The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

Keys must conform to regexp: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
Both keys and values are additionally constrained to be <= 128 bytes in size.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getSatisfiesPzs

Output only. Reserved for future use.

Returns
Type	Description
`bool`

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getSatisfiesPzi

Output only. Reserved for future use.

Returns
Type	Description
`bool`

setSatisfiesPzi

Output only. Reserved for future use.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getStorageConfig

Optional. Storage configuration for this environment.

Returns
Type	Description
`Google\Cloud\Orchestration\Airflow\Service\V1\StorageConfig\|null`

hasStorageConfig

clearStorageConfig

setStorageConfig

Optional. Storage configuration for this environment.

Parameter
Name	Description
`var`	`Google\Cloud\Orchestration\Airflow\Service\V1\StorageConfig`

Returns
Type	Description
`$this`