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.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ Orchestration \ Airflow \ Service \ V1 \ ClientMethods
__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 |
↳ 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 |
↳ 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. |
checkUpgrade
Check if an upgrade operation on the environment will succeed.
In case of problems detailed info can be found in the returned Operation.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::checkUpgradeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\CheckUpgradeRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\CheckUpgradeRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\CheckUpgradeResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Rpc\Status;
/**
* @param string $environment The resource name of the environment to check upgrade for, in the
* form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
*/
function check_upgrade_sample(string $environment): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = (new CheckUpgradeRequest())
->setEnvironment($environment);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $environmentsClient->checkUpgrade($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var CheckUpgradeResponse $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());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$environment = '[ENVIRONMENT]';
check_upgrade_sample($environment);
}
createEnvironment
Create a new environment.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\CreateEnvironmentRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\Environment;
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();
// Prepare the request message.
$request = new CreateEnvironmentRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $environmentsClient->createEnvironment($request);
$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());
}
}
createUserWorkloadsConfigMap
Creates a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::createUserWorkloadsConfigMapAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\CreateUserWorkloadsConfigMapRequest
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\UserWorkloadsConfigMap |
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\CreateUserWorkloadsConfigMapRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\UserWorkloadsConfigMap;
/**
* @param string $formattedParent The environment name to create a ConfigMap for, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* Please see {@see EnvironmentsClient::environmentName()} for help formatting this field.
*/
function create_user_workloads_config_map_sample(string $formattedParent): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$userWorkloadsConfigMap = new UserWorkloadsConfigMap();
$request = (new CreateUserWorkloadsConfigMapRequest())
->setParent($formattedParent)
->setUserWorkloadsConfigMap($userWorkloadsConfigMap);
// Call the API and handle any network failures.
try {
/** @var UserWorkloadsConfigMap $response */
$response = $environmentsClient->createUserWorkloadsConfigMap($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedParent = EnvironmentsClient::environmentName('[PROJECT]', '[LOCATION]', '[ENVIRONMENT]');
create_user_workloads_config_map_sample($formattedParent);
}
createUserWorkloadsSecret
Creates a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::createUserWorkloadsSecretAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\CreateUserWorkloadsSecretRequest
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\UserWorkloadsSecret |
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\CreateUserWorkloadsSecretRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\UserWorkloadsSecret;
/**
* @param string $formattedParent The environment name to create a Secret for, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* Please see {@see EnvironmentsClient::environmentName()} for help formatting this field.
*/
function create_user_workloads_secret_sample(string $formattedParent): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$userWorkloadsSecret = new UserWorkloadsSecret();
$request = (new CreateUserWorkloadsSecretRequest())
->setParent($formattedParent)
->setUserWorkloadsSecret($userWorkloadsSecret);
// Call the API and handle any network failures.
try {
/** @var UserWorkloadsSecret $response */
$response = $environmentsClient->createUserWorkloadsSecret($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedParent = EnvironmentsClient::environmentName('[PROJECT]', '[LOCATION]', '[ENVIRONMENT]');
create_user_workloads_secret_sample($formattedParent);
}
databaseFailover
Triggers database failover (only for highly resilient environments).
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\DatabaseFailoverRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\DatabaseFailoverResponse;
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 database_failover_sample(): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = new DatabaseFailoverRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $environmentsClient->databaseFailover($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var DatabaseFailoverResponse $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.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\DeleteEnvironmentRequest;
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();
// Prepare the request message.
$request = new DeleteEnvironmentRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $environmentsClient->deleteEnvironment($request);
$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());
}
}
deleteUserWorkloadsConfigMap
Deletes a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::deleteUserWorkloadsConfigMapAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\DeleteUserWorkloadsConfigMapRequest
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\DeleteUserWorkloadsConfigMapRequest;
/**
* @param string $formattedName The ConfigMap to delete, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"
* Please see {@see EnvironmentsClient::userWorkloadsConfigMapName()} for help formatting this field.
*/
function delete_user_workloads_config_map_sample(string $formattedName): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = (new DeleteUserWorkloadsConfigMapRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$environmentsClient->deleteUserWorkloadsConfigMap($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedName = EnvironmentsClient::userWorkloadsConfigMapName(
'[PROJECT]',
'[LOCATION]',
'[ENVIRONMENT]',
'[USER_WORKLOADS_CONFIG_MAP]'
);
delete_user_workloads_config_map_sample($formattedName);
}
deleteUserWorkloadsSecret
Deletes a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::deleteUserWorkloadsSecretAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\DeleteUserWorkloadsSecretRequest
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\DeleteUserWorkloadsSecretRequest;
/**
* @param string $formattedName The Secret to delete, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"
* Please see {@see EnvironmentsClient::userWorkloadsSecretName()} for help formatting this field.
*/
function delete_user_workloads_secret_sample(string $formattedName): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = (new DeleteUserWorkloadsSecretRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$environmentsClient->deleteUserWorkloadsSecret($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedName = EnvironmentsClient::userWorkloadsSecretName(
'[PROJECT]',
'[LOCATION]',
'[ENVIRONMENT]',
'[USER_WORKLOADS_SECRET]'
);
delete_user_workloads_secret_sample($formattedName);
}
executeAirflowCommand
Executes Airflow CLI command.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\ExecuteAirflowCommandRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\ExecuteAirflowCommandResponse;
/**
* 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 execute_airflow_command_sample(): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = new ExecuteAirflowCommandRequest();
// Call the API and handle any network failures.
try {
/** @var ExecuteAirflowCommandResponse $response */
$response = $environmentsClient->executeAirflowCommand($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
fetchDatabaseProperties
Fetches database properties.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\FetchDatabasePropertiesRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\FetchDatabasePropertiesResponse;
/**
* @param string $formattedEnvironment The resource name of the environment, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* Please see {@see EnvironmentsClient::environmentName()} for help formatting this field.
*/
function fetch_database_properties_sample(string $formattedEnvironment): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = (new FetchDatabasePropertiesRequest())
->setEnvironment($formattedEnvironment);
// Call the API and handle any network failures.
try {
/** @var FetchDatabasePropertiesResponse $response */
$response = $environmentsClient->fetchDatabaseProperties($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedEnvironment = EnvironmentsClient::environmentName(
'[PROJECT]',
'[LOCATION]',
'[ENVIRONMENT]'
);
fetch_database_properties_sample($formattedEnvironment);
}
getEnvironment
Get an existing environment.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\Environment;
use Google\Cloud\Orchestration\Airflow\Service\V1\GetEnvironmentRequest;
/**
* 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();
// Prepare the request message.
$request = new GetEnvironmentRequest();
// Call the API and handle any network failures.
try {
/** @var Environment $response */
$response = $environmentsClient->getEnvironment($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getUserWorkloadsConfigMap
Gets an existing user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::getUserWorkloadsConfigMapAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\GetUserWorkloadsConfigMapRequest
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\UserWorkloadsConfigMap |
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\GetUserWorkloadsConfigMapRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\UserWorkloadsConfigMap;
/**
* @param string $formattedName The resource name of the ConfigMap to get, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"
* Please see {@see EnvironmentsClient::userWorkloadsConfigMapName()} for help formatting this field.
*/
function get_user_workloads_config_map_sample(string $formattedName): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = (new GetUserWorkloadsConfigMapRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var UserWorkloadsConfigMap $response */
$response = $environmentsClient->getUserWorkloadsConfigMap($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedName = EnvironmentsClient::userWorkloadsConfigMapName(
'[PROJECT]',
'[LOCATION]',
'[ENVIRONMENT]',
'[USER_WORKLOADS_CONFIG_MAP]'
);
get_user_workloads_config_map_sample($formattedName);
}
getUserWorkloadsSecret
Gets an existing user workloads Secret.
Values of the "data" field in the response are cleared.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::getUserWorkloadsSecretAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\GetUserWorkloadsSecretRequest
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\UserWorkloadsSecret |
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\GetUserWorkloadsSecretRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\UserWorkloadsSecret;
/**
* @param string $formattedName The resource name of the Secret to get, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"
* Please see {@see EnvironmentsClient::userWorkloadsSecretName()} for help formatting this field.
*/
function get_user_workloads_secret_sample(string $formattedName): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = (new GetUserWorkloadsSecretRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var UserWorkloadsSecret $response */
$response = $environmentsClient->getUserWorkloadsSecret($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedName = EnvironmentsClient::userWorkloadsSecretName(
'[PROJECT]',
'[LOCATION]',
'[ENVIRONMENT]',
'[USER_WORKLOADS_SECRET]'
);
get_user_workloads_secret_sample($formattedName);
}
listEnvironments
List environments.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\Environment;
use Google\Cloud\Orchestration\Airflow\Service\V1\ListEnvironmentsRequest;
/**
* 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();
// Prepare the request message.
$request = new ListEnvironmentsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $environmentsClient->listEnvironments($request);
/** @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());
}
}
listUserWorkloadsConfigMaps
Lists user workloads ConfigMaps.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::listUserWorkloadsConfigMapsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\ListUserWorkloadsConfigMapsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\ListUserWorkloadsConfigMapsRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\UserWorkloadsConfigMap;
/**
* @param string $formattedParent List ConfigMaps in the given environment, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* Please see {@see EnvironmentsClient::environmentName()} for help formatting this field.
*/
function list_user_workloads_config_maps_sample(string $formattedParent): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = (new ListUserWorkloadsConfigMapsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $environmentsClient->listUserWorkloadsConfigMaps($request);
/** @var UserWorkloadsConfigMap $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());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedParent = EnvironmentsClient::environmentName('[PROJECT]', '[LOCATION]', '[ENVIRONMENT]');
list_user_workloads_config_maps_sample($formattedParent);
}
listUserWorkloadsSecrets
Lists user workloads Secrets.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::listUserWorkloadsSecretsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\ListUserWorkloadsSecretsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\ListUserWorkloadsSecretsRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\UserWorkloadsSecret;
/**
* @param string $formattedParent List Secrets in the given environment, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* Please see {@see EnvironmentsClient::environmentName()} for help formatting this field.
*/
function list_user_workloads_secrets_sample(string $formattedParent): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = (new ListUserWorkloadsSecretsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $environmentsClient->listUserWorkloadsSecrets($request);
/** @var UserWorkloadsSecret $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());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedParent = EnvironmentsClient::environmentName('[PROJECT]', '[LOCATION]', '[ENVIRONMENT]');
list_user_workloads_secrets_sample($formattedParent);
}
listWorkloads
Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::listWorkloadsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\ListWorkloadsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\ListWorkloadsRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\ListWorkloadsResponse\ComposerWorkload;
/**
* @param string $formattedParent The environment name to get workloads for, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* Please see {@see EnvironmentsClient::environmentName()} for help formatting this field.
*/
function list_workloads_sample(string $formattedParent): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = (new ListWorkloadsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $environmentsClient->listWorkloads($request);
/** @var ComposerWorkload $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());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedParent = EnvironmentsClient::environmentName('[PROJECT]', '[LOCATION]', '[ENVIRONMENT]');
list_workloads_sample($formattedParent);
}
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\EnvironmentsClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\LoadSnapshotRequest;
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();
// Prepare the request message.
$request = new LoadSnapshotRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $environmentsClient->loadSnapshot($request);
$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());
}
}
pollAirflowCommand
Polls Airflow CLI command execution and fetches logs.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\PollAirflowCommandRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\PollAirflowCommandResponse;
/**
* 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 poll_airflow_command_sample(): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = new PollAirflowCommandRequest();
// Call the API and handle any network failures.
try {
/** @var PollAirflowCommandResponse $response */
$response = $environmentsClient->pollAirflowCommand($request);
printf('Response data: %s' . PHP_EOL, $response->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.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\SaveSnapshotRequest;
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();
// Prepare the request message.
$request = new SaveSnapshotRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $environmentsClient->saveSnapshot($request);
$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());
}
}
stopAirflowCommand
Stops Airflow CLI command execution.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\StopAirflowCommandRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\StopAirflowCommandResponse;
/**
* 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 stop_airflow_command_sample(): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = new StopAirflowCommandRequest();
// Call the API and handle any network failures.
try {
/** @var StopAirflowCommandResponse $response */
$response = $environmentsClient->stopAirflowCommand($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateEnvironment
Update an environment.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\Environment;
use Google\Cloud\Orchestration\Airflow\Service\V1\UpdateEnvironmentRequest;
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();
// Prepare the request message.
$request = new UpdateEnvironmentRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $environmentsClient->updateEnvironment($request);
$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());
}
}
updateUserWorkloadsConfigMap
Updates a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::updateUserWorkloadsConfigMapAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\UpdateUserWorkloadsConfigMapRequest
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\UserWorkloadsConfigMap |
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\UpdateUserWorkloadsConfigMapRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\UserWorkloadsConfigMap;
/**
* 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_user_workloads_config_map_sample(): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = new UpdateUserWorkloadsConfigMapRequest();
// Call the API and handle any network failures.
try {
/** @var UserWorkloadsConfigMap $response */
$response = $environmentsClient->updateUserWorkloadsConfigMap($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateUserWorkloadsSecret
Updates a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
The async variant is Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient::updateUserWorkloadsSecretAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\UpdateUserWorkloadsSecretRequest
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\UserWorkloadsSecret |
use Google\ApiCore\ApiException;
use Google\Cloud\Orchestration\Airflow\Service\V1\Client\EnvironmentsClient;
use Google\Cloud\Orchestration\Airflow\Service\V1\UpdateUserWorkloadsSecretRequest;
use Google\Cloud\Orchestration\Airflow\Service\V1\UserWorkloadsSecret;
/**
* 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_user_workloads_secret_sample(): void
{
// Create a client.
$environmentsClient = new EnvironmentsClient();
// Prepare the request message.
$request = new UpdateUserWorkloadsSecretRequest();
// Call the API and handle any network failures.
try {
/** @var UserWorkloadsSecret $response */
$response = $environmentsClient->updateUserWorkloadsSecret($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
checkUpgradeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\CheckUpgradeRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createEnvironmentAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\CreateEnvironmentRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createUserWorkloadsConfigMapAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\CreateUserWorkloadsConfigMapRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createUserWorkloadsSecretAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\CreateUserWorkloadsSecretRequest
|
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 |
deleteUserWorkloadsConfigMapAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\DeleteUserWorkloadsConfigMapRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteUserWorkloadsSecretAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\DeleteUserWorkloadsSecretRequest
|
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 |
getUserWorkloadsConfigMapAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\GetUserWorkloadsConfigMapRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getUserWorkloadsSecretAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\GetUserWorkloadsSecretRequest
|
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 |
listUserWorkloadsConfigMapsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\ListUserWorkloadsConfigMapsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listUserWorkloadsSecretsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\ListUserWorkloadsSecretsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listWorkloadsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\ListWorkloadsRequest
|
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 |
updateUserWorkloadsConfigMapAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\UpdateUserWorkloadsConfigMapRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateUserWorkloadsSecretAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Orchestration\Airflow\Service\V1\UpdateUserWorkloadsSecretRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\LongRunning\Client\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::userWorkloadsConfigMapName
Formats a string containing the fully-qualified path to represent a user_workloads_config_map resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
environment |
string
|
userWorkloadsConfigMap |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted user_workloads_config_map resource. |
static::userWorkloadsSecretName
Formats a string containing the fully-qualified path to represent a user_workloads_secret resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
environment |
string
|
userWorkloadsSecret |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted user_workloads_secret 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}
- userWorkloadsConfigMap: projects/{project}/locations/{location}/environments/{environment}/userWorkloadsConfigMaps/{user_workloads_config_map}
- userWorkloadsSecret: projects/{project}/locations/{location}/environments/{environment}/userWorkloadsSecrets/{user_workloads_secret}
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. |