Class EnvironmentsConnection (2.31.0)

The EnvironmentsConnection object for EnvironmentsClient.

This interface defines virtual methods for each of the user-facing overload sets in EnvironmentsClient. This allows users to inject custom behavior (e.g., with a Google Mock object) when writing tests that use objects of type EnvironmentsClient.

To create a concrete instance, see MakeEnvironmentsConnection().

For mocking, see composer_v1_mocks::MockEnvironmentsConnection.

Functions

virtual options()

Returns
Type	Description
`Options`

virtual CreateEnvironment(google::cloud::orchestration::airflow::service::v1::CreateEnvironmentRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::CreateEnvironmentRequest const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::Environment > >`

virtual CreateEnvironment(NoAwaitTag, google::cloud::orchestration::airflow::service::v1::CreateEnvironmentRequest const &)

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::orchestration::airflow::service::v1::CreateEnvironmentRequest const &`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

virtual CreateEnvironment(google::longrunning::Operation const &)

Parameter
Name	Description
`operation`	`google::longrunning::Operation const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::Environment > >`

virtual GetEnvironment(google::cloud::orchestration::airflow::service::v1::GetEnvironmentRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::GetEnvironmentRequest const &`

Returns
Type	Description
`StatusOr< google::cloud::orchestration::airflow::service::v1::Environment >`

virtual ListEnvironments(google::cloud::orchestration::airflow::service::v1::ListEnvironmentsRequest)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::ListEnvironmentsRequest`

Returns
Type	Description
`StreamRange< google::cloud::orchestration::airflow::service::v1::Environment >`

virtual UpdateEnvironment(google::cloud::orchestration::airflow::service::v1::UpdateEnvironmentRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::UpdateEnvironmentRequest const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::Environment > >`

virtual UpdateEnvironment(NoAwaitTag, google::cloud::orchestration::airflow::service::v1::UpdateEnvironmentRequest const &)

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::orchestration::airflow::service::v1::UpdateEnvironmentRequest const &`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

virtual UpdateEnvironment(google::longrunning::Operation const &)

Parameter
Name	Description
`operation`	`google::longrunning::Operation const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::Environment > >`

virtual DeleteEnvironment(google::cloud::orchestration::airflow::service::v1::DeleteEnvironmentRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::DeleteEnvironmentRequest const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::OperationMetadata > >`

virtual DeleteEnvironment(NoAwaitTag, google::cloud::orchestration::airflow::service::v1::DeleteEnvironmentRequest const &)

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::orchestration::airflow::service::v1::DeleteEnvironmentRequest const &`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

virtual DeleteEnvironment(google::longrunning::Operation const &)

Parameter
Name	Description
`operation`	`google::longrunning::Operation const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::OperationMetadata > >`

virtual ExecuteAirflowCommand(google::cloud::orchestration::airflow::service::v1::ExecuteAirflowCommandRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::ExecuteAirflowCommandRequest const &`

Returns
Type	Description
`StatusOr< google::cloud::orchestration::airflow::service::v1::ExecuteAirflowCommandResponse >`

virtual StopAirflowCommand(google::cloud::orchestration::airflow::service::v1::StopAirflowCommandRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::StopAirflowCommandRequest const &`

Returns
Type	Description
`StatusOr< google::cloud::orchestration::airflow::service::v1::StopAirflowCommandResponse >`

virtual PollAirflowCommand(google::cloud::orchestration::airflow::service::v1::PollAirflowCommandRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::PollAirflowCommandRequest const &`

Returns
Type	Description
`StatusOr< google::cloud::orchestration::airflow::service::v1::PollAirflowCommandResponse >`

virtual ListWorkloads(google::cloud::orchestration::airflow::service::v1::ListWorkloadsRequest)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::ListWorkloadsRequest`

Returns
Type	Description
`StreamRange< google::cloud::orchestration::airflow::service::v1::ListWorkloadsResponse::ComposerWorkload >`

virtual CheckUpgrade(google::cloud::orchestration::airflow::service::v1::CheckUpgradeRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::CheckUpgradeRequest const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::CheckUpgradeResponse > >`

virtual CheckUpgrade(NoAwaitTag, google::cloud::orchestration::airflow::service::v1::CheckUpgradeRequest const &)

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::orchestration::airflow::service::v1::CheckUpgradeRequest const &`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

virtual CheckUpgrade(google::longrunning::Operation const &)

Parameter
Name	Description
`operation`	`google::longrunning::Operation const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::CheckUpgradeResponse > >`

virtual CreateUserWorkloadsSecret(google::cloud::orchestration::airflow::service::v1::CreateUserWorkloadsSecretRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::CreateUserWorkloadsSecretRequest const &`

Returns
Type	Description
`StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret >`

virtual GetUserWorkloadsSecret(google::cloud::orchestration::airflow::service::v1::GetUserWorkloadsSecretRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::GetUserWorkloadsSecretRequest const &`

Returns
Type	Description
`StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret >`

virtual ListUserWorkloadsSecrets(google::cloud::orchestration::airflow::service::v1::ListUserWorkloadsSecretsRequest)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::ListUserWorkloadsSecretsRequest`

Returns
Type	Description
`StreamRange< google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret >`

virtual UpdateUserWorkloadsSecret(google::cloud::orchestration::airflow::service::v1::UpdateUserWorkloadsSecretRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::UpdateUserWorkloadsSecretRequest const &`

Returns
Type	Description
`StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret >`

virtual DeleteUserWorkloadsSecret(google::cloud::orchestration::airflow::service::v1::DeleteUserWorkloadsSecretRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::DeleteUserWorkloadsSecretRequest const &`

Returns
Type	Description
`Status`

virtual CreateUserWorkloadsConfigMap(google::cloud::orchestration::airflow::service::v1::CreateUserWorkloadsConfigMapRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::CreateUserWorkloadsConfigMapRequest const &`

Returns
Type	Description
`StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap >`

virtual GetUserWorkloadsConfigMap(google::cloud::orchestration::airflow::service::v1::GetUserWorkloadsConfigMapRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::GetUserWorkloadsConfigMapRequest const &`

Returns
Type	Description
`StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap >`

virtual ListUserWorkloadsConfigMaps(google::cloud::orchestration::airflow::service::v1::ListUserWorkloadsConfigMapsRequest)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::ListUserWorkloadsConfigMapsRequest`

Returns
Type	Description
`StreamRange< google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap >`

virtual UpdateUserWorkloadsConfigMap(google::cloud::orchestration::airflow::service::v1::UpdateUserWorkloadsConfigMapRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::UpdateUserWorkloadsConfigMapRequest const &`

Returns
Type	Description
`StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap >`

virtual DeleteUserWorkloadsConfigMap(google::cloud::orchestration::airflow::service::v1::DeleteUserWorkloadsConfigMapRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::DeleteUserWorkloadsConfigMapRequest const &`

Returns
Type	Description
`Status`

virtual SaveSnapshot(google::cloud::orchestration::airflow::service::v1::SaveSnapshotRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::SaveSnapshotRequest const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::SaveSnapshotResponse > >`

virtual SaveSnapshot(NoAwaitTag, google::cloud::orchestration::airflow::service::v1::SaveSnapshotRequest const &)

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::orchestration::airflow::service::v1::SaveSnapshotRequest const &`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

virtual SaveSnapshot(google::longrunning::Operation const &)

Parameter
Name	Description
`operation`	`google::longrunning::Operation const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::SaveSnapshotResponse > >`

virtual LoadSnapshot(google::cloud::orchestration::airflow::service::v1::LoadSnapshotRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::LoadSnapshotRequest const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::LoadSnapshotResponse > >`

virtual LoadSnapshot(NoAwaitTag, google::cloud::orchestration::airflow::service::v1::LoadSnapshotRequest const &)

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::orchestration::airflow::service::v1::LoadSnapshotRequest const &`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

virtual LoadSnapshot(google::longrunning::Operation const &)

Parameter
Name	Description
`operation`	`google::longrunning::Operation const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::LoadSnapshotResponse > >`

virtual DatabaseFailover(google::cloud::orchestration::airflow::service::v1::DatabaseFailoverRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::DatabaseFailoverRequest const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::DatabaseFailoverResponse > >`

virtual DatabaseFailover(NoAwaitTag, google::cloud::orchestration::airflow::service::v1::DatabaseFailoverRequest const &)

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::orchestration::airflow::service::v1::DatabaseFailoverRequest const &`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

virtual DatabaseFailover(google::longrunning::Operation const &)

Parameter
Name	Description
`operation`	`google::longrunning::Operation const &`

Returns
Type	Description
`future< StatusOr< google::cloud::orchestration::airflow::service::v1::DatabaseFailoverResponse > >`

virtual FetchDatabaseProperties(google::cloud::orchestration::airflow::service::v1::FetchDatabasePropertiesRequest const &)

Parameter
Name	Description
`request`	`google::cloud::orchestration::airflow::service::v1::FetchDatabasePropertiesRequest const &`

Returns
Type	Description
`StatusOr< google::cloud::orchestration::airflow::service::v1::FetchDatabasePropertiesResponse >`

virtual ListOperations(google::longrunning::ListOperationsRequest)

Parameter
Name	Description
`request`	`google::longrunning::ListOperationsRequest`

Returns
Type	Description
`StreamRange< google::longrunning::Operation >`

virtual GetOperation(google::longrunning::GetOperationRequest const &)

Parameter
Name	Description
`request`	`google::longrunning::GetOperationRequest const &`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

virtual DeleteOperation(google::longrunning::DeleteOperationRequest const &)

Parameter
Name	Description
`request`	`google::longrunning::DeleteOperationRequest const &`

Returns
Type	Description
`Status`