Google Cloud Orchestration Airflow V1 Client - Class EnvironmentsClient (1.3.0)

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

Service Description: Managed Apache Airflow Environments.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Orchestration \ Airflow \ Service \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createEnvironment

Create a new environment.

The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\BaseClient\self::createEnvironmentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\CreateEnvironmentRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

databaseFailover

Triggers database failover (only for highly resilient environments).

The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\BaseClient\self::databaseFailoverAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\DatabaseFailoverRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteEnvironment

Delete an environment.

The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\BaseClient\self::deleteEnvironmentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\DeleteEnvironmentRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

executeAirflowCommand

Executes Airflow CLI command.

The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\BaseClient\self::executeAirflowCommandAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\ExecuteAirflowCommandRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Orchestration\Airflow\Service\V1\ExecuteAirflowCommandResponse`

fetchDatabaseProperties

Fetches database properties.

The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\BaseClient\self::fetchDatabasePropertiesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\FetchDatabasePropertiesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Orchestration\Airflow\Service\V1\FetchDatabasePropertiesResponse`

getEnvironment

Get an existing environment.

The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\BaseClient\self::getEnvironmentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\GetEnvironmentRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Orchestration\Airflow\Service\V1\Environment`

listEnvironments

List environments.

The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\BaseClient\self::listEnvironmentsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\ListEnvironmentsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

loadSnapshot

Loads a snapshot of a Cloud Composer environment.

As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment.

The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\BaseClient\self::loadSnapshotAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\LoadSnapshotRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

pollAirflowCommand

Polls Airflow CLI command execution and fetches logs.

The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\BaseClient\self::pollAirflowCommandAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\PollAirflowCommandRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Orchestration\Airflow\Service\V1\PollAirflowCommandResponse`

saveSnapshot

Creates a snapshots of a Cloud Composer environment.

As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest.

The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\BaseClient\self::saveSnapshotAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\SaveSnapshotRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

stopAirflowCommand

Stops Airflow CLI command execution.

The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\BaseClient\self::stopAirflowCommandAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\StopAirflowCommandRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Orchestration\Airflow\Service\V1\StopAirflowCommandResponse`

updateEnvironment

Update an environment.

The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\BaseClient\self::updateEnvironmentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\UpdateEnvironmentRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

createEnvironmentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\CreateEnvironmentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

databaseFailoverAsync

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\DatabaseFailoverRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteEnvironmentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\DeleteEnvironmentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

executeAirflowCommandAsync

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\ExecuteAirflowCommandRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

fetchDatabasePropertiesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\FetchDatabasePropertiesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getEnvironmentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\GetEnvironmentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listEnvironmentsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\ListEnvironmentsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

loadSnapshotAsync

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\LoadSnapshotRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

pollAirflowCommandAsync

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\PollAirflowCommandRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

saveSnapshotAsync

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\SaveSnapshotRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

stopAirflowCommandAsync

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\StopAirflowCommandRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateEnvironmentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Orchestration\Airflow\Service\V1\UpdateEnvironmentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::environmentName

Formats a string containing the fully-qualified path to represent a environment resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`environment`	`string`

Returns
Type	Description
`string`	The formatted environment resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

environment: projects/{project}/locations/{location}/environments/{environment}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.