Reference documentation and code samples for the Google Cloud Orchestration Airflow V1 Client class EnvironmentsClient.
Service Description: Managed Apache Airflow Environments.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$environmentsClient = new EnvironmentsClient();
try {
$operationResponse = $environmentsClient->createEnvironment();
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $environmentsClient->createEnvironment();
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $environmentsClient->resumeOperation($operationName, 'createEnvironment');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$environmentsClient->close();
}
Methods
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
__construct
Constructor.
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.
optionalArgs
array
Optional.
↳ parent
string
The parent must be of the form "projects/{projectId}/locations/{locationId}".
↳ environment
Environment
The environment to create.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Environment;
use Google\Cloud\Orchestration\Airflow\Service\V1\EnvironmentsClient;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function create_environment_sample(): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $environmentsClient->createEnvironment();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Environment $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
deleteEnvironment
Delete an environment.
optionalArgs
array
Optional.
↳ name
string
The environment to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\EnvironmentsClient;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function delete_environment_sample(): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $environmentsClient->deleteEnvironment();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getEnvironment
Get an existing environment.
optionalArgs
array
Optional.
↳ name
string
The resource name of the environment to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
↳ 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.
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Environment;
use Google\Cloud\Orchestration\Airflow\Service\V1\EnvironmentsClient;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function get_environment_sample(): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Call the API and handle any network failures.
try {
/** @var Environment $response */
$response = $environmentsClient->getEnvironment();
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listEnvironments
List environments.
optionalArgs
array
Optional.
↳ parent
string
List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}"
↳ pageSize
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Environment;
use Google\Cloud\Orchestration\Airflow\Service\V1\EnvironmentsClient;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function list_environments_sample(): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $environmentsClient->listEnvironments();
/** @var Environment $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
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.
optionalArgs
array
Optional.
↳ environment
string
The resource name of the target environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
↳ snapshotPath
string
A Cloud Storage path to a snapshot to load, e.g.: "gs://my-bucket/snapshots/project_location_environment_timestamp".
↳ skipPypiPackagesInstallation
bool
Whether or not to skip installing Pypi packages when loading the environment's state.
↳ skipEnvironmentVariablesSetting
bool
Whether or not to skip setting environment variables when loading the environment's state.
↳ skipAirflowOverridesSetting
bool
Whether or not to skip setting Airflow overrides when loading the environment's state.
↳ skipGcsDataCopying
bool
Whether or not to skip copying Cloud Storage data when loading the environment's state.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\LoadSnapshotResponse;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function load_snapshot_sample(): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $environmentsClient->loadSnapshot();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var LoadSnapshotResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
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.
optionalArgs
array
Optional.
↳ environment
string
The resource name of the source environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
↳ snapshotLocation
string
Location in a Cloud Storage where the snapshot is going to be stored, e.g.: "gs://my-bucket/snapshots".
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\SaveSnapshotResponse;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function save_snapshot_sample(): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $environmentsClient->saveSnapshot();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var SaveSnapshotResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateEnvironment
Update an environment.
optionalArgs
array
Optional.
↳ name
string
The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
↳ environment
Environment
A patch environment. Fields specified by the updateMask
will be copied from the patch environment into the environment under update.
↳ updateMask
FieldMask
Required. A comma-separated list of paths, relative to Environment
, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the updateMask
parameter would include the following two paths
values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows: { "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected. Only one update type may be included in a single request's updateMask
. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows: { "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } } Note that in the above example, any existing labels that are not included in the updateMask
will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the updateMask
. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the updateMask
would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following: { "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } } Note:Only the following fields can be updated: * config.softwareConfig.pypiPackages
* Replace all custom custom PyPI packages. If a replacement package map is not included in environment
, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package. * config.softwareConfig.pypiPackages.
packagename * Update the custom PyPI package packagename
, preserving other packages. To delete the package, include it in updateMask
, and omit the mapping for it in environment.config.softwareConfig.pypiPackages
. It is an error to provide both a mask of this form and the config.softwareConfig.pypiPackages
mask. * labels
* Replace all environment labels. If a replacement labels map is not included in environment
, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels. * labels.
labelName * Set the label named labelName
, while preserving other labels. To delete the label, include it in updateMask
and omit its mapping in environment.labels
. It is an error to provide both a mask of this form and the labels
mask. * config.nodeCount
* Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the config.nodeCount
field. Supported for Cloud Composer environments in versions composer-1. .
-airflow- .
. . * config.webServerNetworkAccessControl
* Replace the environment's current WebServerNetworkAccessControl
. * config.softwareConfig.airflowConfigOverrides
* Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in environment
, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides. * config.softwareConfig.airflowConfigOverrides.
section-name * Override the Apache Airflow config property *name
in the section named section
, preserving other properties. To delete the property override, include it in updateMask
and omit its mapping in environment.config.softwareConfig.airflowConfigOverrides
. It is an error to provide both a mask of this form and the config.softwareConfig.airflowConfigOverrides
mask. * config.softwareConfig.envVariables
* Replace all environment variables. If a replacement environment variable map is not included in environment
, all custom environment variables are cleared. * config.softwareConfig.schedulerCount
* Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the config.softwareConfig.schedulerCount
field. Supported for Cloud Composer environments in versions composer-1. .
-airflow-2. .
. * config.databaseConfig.machineType
* Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1. .
-airflow- .
. . * config.webServerConfig.machineType
* Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1.
. -airflow-
. .
.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Environment;
use Google\Cloud\Orchestration\Airflow\Service\V1\EnvironmentsClient;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_environment_sample(): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $environmentsClient->updateEnvironment();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Environment $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
Constants
SERVICE_NAME
Value: 'google.cloud.orchestration.airflow.service.v1.Environments'
The name of the service.
SERVICE_ADDRESS
Value: 'composer.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.
