Cloud Composer v1 API - Class EnvironmentsClientImpl (2.6.0)

public sealed class EnvironmentsClientImpl : EnvironmentsClient

Reference documentation and code samples for the Cloud Composer v1 API class EnvironmentsClientImpl.

Environments client wrapper implementation, for convenient use.

Inheritance

object > EnvironmentsClient > EnvironmentsClientImpl

Inherited Members

EnvironmentsClient.DefaultEndpoint

EnvironmentsClient.DefaultScopes

EnvironmentsClient.ServiceMetadata

EnvironmentsClient.CreateAsync(CancellationToken)

EnvironmentsClient.Create()

EnvironmentsClient.ShutdownDefaultChannelsAsync()

EnvironmentsClient.CreateEnvironmentAsync(CreateEnvironmentRequest, CancellationToken)

EnvironmentsClient.PollOnceCreateEnvironment(string, CallSettings)

EnvironmentsClient.PollOnceCreateEnvironmentAsync(string, CallSettings)

EnvironmentsClient.CreateEnvironment(string, Environment, CallSettings)

EnvironmentsClient.CreateEnvironmentAsync(string, Environment, CallSettings)

EnvironmentsClient.CreateEnvironmentAsync(string, Environment, CancellationToken)

EnvironmentsClient.GetEnvironmentAsync(GetEnvironmentRequest, CancellationToken)

EnvironmentsClient.GetEnvironment(string, CallSettings)

EnvironmentsClient.GetEnvironmentAsync(string, CallSettings)

EnvironmentsClient.GetEnvironmentAsync(string, CancellationToken)

EnvironmentsClient.ListEnvironments(string, string, int?, CallSettings)

EnvironmentsClient.ListEnvironmentsAsync(string, string, int?, CallSettings)

EnvironmentsClient.UpdateEnvironmentAsync(UpdateEnvironmentRequest, CancellationToken)

EnvironmentsClient.PollOnceUpdateEnvironment(string, CallSettings)

EnvironmentsClient.PollOnceUpdateEnvironmentAsync(string, CallSettings)

EnvironmentsClient.UpdateEnvironment(string, Environment, FieldMask, CallSettings)

EnvironmentsClient.UpdateEnvironmentAsync(string, Environment, FieldMask, CallSettings)

EnvironmentsClient.UpdateEnvironmentAsync(string, Environment, FieldMask, CancellationToken)

EnvironmentsClient.DeleteEnvironmentAsync(DeleteEnvironmentRequest, CancellationToken)

EnvironmentsClient.PollOnceDeleteEnvironment(string, CallSettings)

EnvironmentsClient.PollOnceDeleteEnvironmentAsync(string, CallSettings)

EnvironmentsClient.DeleteEnvironment(string, CallSettings)

EnvironmentsClient.DeleteEnvironmentAsync(string, CallSettings)

EnvironmentsClient.DeleteEnvironmentAsync(string, CancellationToken)

EnvironmentsClient.ExecuteAirflowCommandAsync(ExecuteAirflowCommandRequest, CancellationToken)

EnvironmentsClient.StopAirflowCommandAsync(StopAirflowCommandRequest, CancellationToken)

EnvironmentsClient.PollAirflowCommandAsync(PollAirflowCommandRequest, CancellationToken)

EnvironmentsClient.ListWorkloads(string, string, int?, CallSettings)

EnvironmentsClient.ListWorkloadsAsync(string, string, int?, CallSettings)

EnvironmentsClient.ListWorkloads(EnvironmentName, string, int?, CallSettings)

EnvironmentsClient.ListWorkloadsAsync(EnvironmentName, string, int?, CallSettings)

EnvironmentsClient.CreateUserWorkloadsSecretAsync(CreateUserWorkloadsSecretRequest, CancellationToken)

EnvironmentsClient.CreateUserWorkloadsSecret(string, UserWorkloadsSecret, CallSettings)

EnvironmentsClient.CreateUserWorkloadsSecretAsync(string, UserWorkloadsSecret, CallSettings)

EnvironmentsClient.CreateUserWorkloadsSecretAsync(string, UserWorkloadsSecret, CancellationToken)

EnvironmentsClient.CreateUserWorkloadsSecret(EnvironmentName, UserWorkloadsSecret, CallSettings)

EnvironmentsClient.CreateUserWorkloadsSecretAsync(EnvironmentName, UserWorkloadsSecret, CallSettings)

EnvironmentsClient.CreateUserWorkloadsSecretAsync(EnvironmentName, UserWorkloadsSecret, CancellationToken)

EnvironmentsClient.GetUserWorkloadsSecretAsync(GetUserWorkloadsSecretRequest, CancellationToken)

EnvironmentsClient.GetUserWorkloadsSecret(string, CallSettings)

EnvironmentsClient.GetUserWorkloadsSecretAsync(string, CallSettings)

EnvironmentsClient.GetUserWorkloadsSecretAsync(string, CancellationToken)

EnvironmentsClient.GetUserWorkloadsSecret(UserWorkloadsSecretName, CallSettings)

EnvironmentsClient.GetUserWorkloadsSecretAsync(UserWorkloadsSecretName, CallSettings)

EnvironmentsClient.GetUserWorkloadsSecretAsync(UserWorkloadsSecretName, CancellationToken)

EnvironmentsClient.ListUserWorkloadsSecrets(string, string, int?, CallSettings)

EnvironmentsClient.ListUserWorkloadsSecretsAsync(string, string, int?, CallSettings)

EnvironmentsClient.ListUserWorkloadsSecrets(EnvironmentName, string, int?, CallSettings)

EnvironmentsClient.ListUserWorkloadsSecretsAsync(EnvironmentName, string, int?, CallSettings)

EnvironmentsClient.UpdateUserWorkloadsSecretAsync(UpdateUserWorkloadsSecretRequest, CancellationToken)

EnvironmentsClient.UpdateUserWorkloadsSecret(UserWorkloadsSecret, CallSettings)

EnvironmentsClient.UpdateUserWorkloadsSecretAsync(UserWorkloadsSecret, CallSettings)

EnvironmentsClient.UpdateUserWorkloadsSecretAsync(UserWorkloadsSecret, CancellationToken)

EnvironmentsClient.DeleteUserWorkloadsSecretAsync(DeleteUserWorkloadsSecretRequest, CancellationToken)

EnvironmentsClient.DeleteUserWorkloadsSecret(string, CallSettings)

EnvironmentsClient.DeleteUserWorkloadsSecretAsync(string, CallSettings)

EnvironmentsClient.DeleteUserWorkloadsSecretAsync(string, CancellationToken)

EnvironmentsClient.DeleteUserWorkloadsSecret(UserWorkloadsSecretName, CallSettings)

EnvironmentsClient.DeleteUserWorkloadsSecretAsync(UserWorkloadsSecretName, CallSettings)

EnvironmentsClient.DeleteUserWorkloadsSecretAsync(UserWorkloadsSecretName, CancellationToken)

EnvironmentsClient.CreateUserWorkloadsConfigMapAsync(CreateUserWorkloadsConfigMapRequest, CancellationToken)

EnvironmentsClient.CreateUserWorkloadsConfigMap(string, UserWorkloadsConfigMap, CallSettings)

EnvironmentsClient.CreateUserWorkloadsConfigMapAsync(string, UserWorkloadsConfigMap, CallSettings)

EnvironmentsClient.CreateUserWorkloadsConfigMapAsync(string, UserWorkloadsConfigMap, CancellationToken)

EnvironmentsClient.CreateUserWorkloadsConfigMap(EnvironmentName, UserWorkloadsConfigMap, CallSettings)

EnvironmentsClient.CreateUserWorkloadsConfigMapAsync(EnvironmentName, UserWorkloadsConfigMap, CallSettings)

EnvironmentsClient.CreateUserWorkloadsConfigMapAsync(EnvironmentName, UserWorkloadsConfigMap, CancellationToken)

EnvironmentsClient.GetUserWorkloadsConfigMapAsync(GetUserWorkloadsConfigMapRequest, CancellationToken)

EnvironmentsClient.GetUserWorkloadsConfigMap(string, CallSettings)

EnvironmentsClient.GetUserWorkloadsConfigMapAsync(string, CallSettings)

EnvironmentsClient.GetUserWorkloadsConfigMapAsync(string, CancellationToken)

EnvironmentsClient.GetUserWorkloadsConfigMap(UserWorkloadsConfigMapName, CallSettings)

EnvironmentsClient.GetUserWorkloadsConfigMapAsync(UserWorkloadsConfigMapName, CallSettings)

EnvironmentsClient.GetUserWorkloadsConfigMapAsync(UserWorkloadsConfigMapName, CancellationToken)

EnvironmentsClient.ListUserWorkloadsConfigMaps(string, string, int?, CallSettings)

EnvironmentsClient.ListUserWorkloadsConfigMapsAsync(string, string, int?, CallSettings)

EnvironmentsClient.ListUserWorkloadsConfigMaps(EnvironmentName, string, int?, CallSettings)

EnvironmentsClient.ListUserWorkloadsConfigMapsAsync(EnvironmentName, string, int?, CallSettings)

EnvironmentsClient.UpdateUserWorkloadsConfigMapAsync(UpdateUserWorkloadsConfigMapRequest, CancellationToken)

EnvironmentsClient.UpdateUserWorkloadsConfigMap(UserWorkloadsConfigMap, CallSettings)

EnvironmentsClient.UpdateUserWorkloadsConfigMapAsync(UserWorkloadsConfigMap, CallSettings)

EnvironmentsClient.UpdateUserWorkloadsConfigMapAsync(UserWorkloadsConfigMap, CancellationToken)

EnvironmentsClient.DeleteUserWorkloadsConfigMapAsync(DeleteUserWorkloadsConfigMapRequest, CancellationToken)

EnvironmentsClient.DeleteUserWorkloadsConfigMap(string, CallSettings)

EnvironmentsClient.DeleteUserWorkloadsConfigMapAsync(string, CallSettings)

EnvironmentsClient.DeleteUserWorkloadsConfigMapAsync(string, CancellationToken)

EnvironmentsClient.DeleteUserWorkloadsConfigMap(UserWorkloadsConfigMapName, CallSettings)

EnvironmentsClient.DeleteUserWorkloadsConfigMapAsync(UserWorkloadsConfigMapName, CallSettings)

EnvironmentsClient.DeleteUserWorkloadsConfigMapAsync(UserWorkloadsConfigMapName, CancellationToken)

EnvironmentsClient.SaveSnapshotAsync(SaveSnapshotRequest, CancellationToken)

EnvironmentsClient.PollOnceSaveSnapshot(string, CallSettings)

EnvironmentsClient.PollOnceSaveSnapshotAsync(string, CallSettings)

EnvironmentsClient.LoadSnapshotAsync(LoadSnapshotRequest, CancellationToken)

EnvironmentsClient.PollOnceLoadSnapshot(string, CallSettings)

EnvironmentsClient.PollOnceLoadSnapshotAsync(string, CallSettings)

EnvironmentsClient.DatabaseFailoverAsync(DatabaseFailoverRequest, CancellationToken)

EnvironmentsClient.PollOnceDatabaseFailover(string, CallSettings)

EnvironmentsClient.PollOnceDatabaseFailoverAsync(string, CallSettings)

EnvironmentsClient.FetchDatabasePropertiesAsync(FetchDatabasePropertiesRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Orchestration.Airflow.Service.V1

Assembly

Google.Cloud.Orchestration.Airflow.Service.V1.dll

Remarks

Managed Apache Airflow Environments.

Constructors

EnvironmentsClientImpl(EnvironmentsClient, EnvironmentsSettings, ILogger)

public EnvironmentsClientImpl(Environments.EnvironmentsClient grpcClient, EnvironmentsSettings settings, ILogger logger)

Constructs a client wrapper for the Environments service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`EnvironmentsEnvironmentsClient` The underlying gRPC client.
`settings`	`EnvironmentsSettings` The base EnvironmentsSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

CreateEnvironmentOperationsClient

public override OperationsClient CreateEnvironmentOperationsClient { get; }

The long-running operations client for CreateEnvironment.

Property Value
Type	Description
`OperationsClient`

Overrides

EnvironmentsClient.CreateEnvironmentOperationsClient

DatabaseFailoverOperationsClient

public override OperationsClient DatabaseFailoverOperationsClient { get; }

The long-running operations client for DatabaseFailover.

Property Value
Type	Description
`OperationsClient`

Overrides

EnvironmentsClient.DatabaseFailoverOperationsClient

DeleteEnvironmentOperationsClient

public override OperationsClient DeleteEnvironmentOperationsClient { get; }

The long-running operations client for DeleteEnvironment.

Property Value
Type	Description
`OperationsClient`

Overrides

EnvironmentsClient.DeleteEnvironmentOperationsClient

GrpcClient

public override Environments.EnvironmentsClient GrpcClient { get; }

The underlying gRPC Environments client

Property Value
Type	Description
`EnvironmentsEnvironmentsClient`

Overrides

EnvironmentsClient.GrpcClient

LoadSnapshotOperationsClient

public override OperationsClient LoadSnapshotOperationsClient { get; }

The long-running operations client for LoadSnapshot.

Property Value
Type	Description
`OperationsClient`

Overrides

EnvironmentsClient.LoadSnapshotOperationsClient

SaveSnapshotOperationsClient

public override OperationsClient SaveSnapshotOperationsClient { get; }

The long-running operations client for SaveSnapshot.

Property Value
Type	Description
`OperationsClient`

Overrides

EnvironmentsClient.SaveSnapshotOperationsClient

UpdateEnvironmentOperationsClient

public override OperationsClient UpdateEnvironmentOperationsClient { get; }

The long-running operations client for UpdateEnvironment.

Property Value
Type	Description
`OperationsClient`

Overrides

EnvironmentsClient.UpdateEnvironmentOperationsClient

Methods

CreateEnvironment(CreateEnvironmentRequest, CallSettings)

public override Operation<Environment, OperationMetadata> CreateEnvironment(CreateEnvironmentRequest request, CallSettings callSettings = null)

Create a new environment.

Parameters
Name	Description
`request`	`CreateEnvironmentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationEnvironmentOperationMetadata`	The RPC response.

Overrides

EnvironmentsClient.CreateEnvironment(CreateEnvironmentRequest, CallSettings)

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

public override Task<Operation<Environment, OperationMetadata>> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallSettings callSettings = null)

Create a new environment.

Parameters
Name	Description
`request`	`CreateEnvironmentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationEnvironmentOperationMetadata`	A Task containing the RPC response.

Overrides

EnvironmentsClient.CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

CreateUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest, CallSettings)

public override UserWorkloadsConfigMap CreateUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)

Creates a user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`CreateUserWorkloadsConfigMapRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`UserWorkloadsConfigMap`	The RPC response.

Overrides

EnvironmentsClient.CreateUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest, CallSettings)

CreateUserWorkloadsConfigMapAsync(CreateUserWorkloadsConfigMapRequest, CallSettings)

public override Task<UserWorkloadsConfigMap> CreateUserWorkloadsConfigMapAsync(CreateUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)

Creates a user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`CreateUserWorkloadsConfigMapRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskUserWorkloadsConfigMap`	A Task containing the RPC response.

Overrides

EnvironmentsClient.CreateUserWorkloadsConfigMapAsync(CreateUserWorkloadsConfigMapRequest, CallSettings)

CreateUserWorkloadsSecret(CreateUserWorkloadsSecretRequest, CallSettings)

public override UserWorkloadsSecret CreateUserWorkloadsSecret(CreateUserWorkloadsSecretRequest request, CallSettings callSettings = null)

Creates a user workloads Secret.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`CreateUserWorkloadsSecretRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`UserWorkloadsSecret`	The RPC response.

Overrides

EnvironmentsClient.CreateUserWorkloadsSecret(CreateUserWorkloadsSecretRequest, CallSettings)

CreateUserWorkloadsSecretAsync(CreateUserWorkloadsSecretRequest, CallSettings)

public override Task<UserWorkloadsSecret> CreateUserWorkloadsSecretAsync(CreateUserWorkloadsSecretRequest request, CallSettings callSettings = null)

Creates a user workloads Secret.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`CreateUserWorkloadsSecretRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskUserWorkloadsSecret`	A Task containing the RPC response.

Overrides

EnvironmentsClient.CreateUserWorkloadsSecretAsync(CreateUserWorkloadsSecretRequest, CallSettings)

DatabaseFailover(DatabaseFailoverRequest, CallSettings)

public override Operation<DatabaseFailoverResponse, OperationMetadata> DatabaseFailover(DatabaseFailoverRequest request, CallSettings callSettings = null)

Triggers database failover (only for highly resilient environments).

Parameters
Name	Description
`request`	`DatabaseFailoverRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationDatabaseFailoverResponseOperationMetadata`	The RPC response.

Overrides

EnvironmentsClient.DatabaseFailover(DatabaseFailoverRequest, CallSettings)

DatabaseFailoverAsync(DatabaseFailoverRequest, CallSettings)

public override Task<Operation<DatabaseFailoverResponse, OperationMetadata>> DatabaseFailoverAsync(DatabaseFailoverRequest request, CallSettings callSettings = null)

Triggers database failover (only for highly resilient environments).

Parameters
Name	Description
`request`	`DatabaseFailoverRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationDatabaseFailoverResponseOperationMetadata`	A Task containing the RPC response.

Overrides

EnvironmentsClient.DatabaseFailoverAsync(DatabaseFailoverRequest, CallSettings)

DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteEnvironment(DeleteEnvironmentRequest request, CallSettings callSettings = null)

Delete an environment.

Parameters
Name	Description
`request`	`DeleteEnvironmentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationEmptyOperationMetadata`	The RPC response.

Overrides

EnvironmentsClient.DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallSettings callSettings = null)

Delete an environment.

Parameters
Name	Description
`request`	`DeleteEnvironmentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationEmptyOperationMetadata`	A Task containing the RPC response.

Overrides

EnvironmentsClient.DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

DeleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest, CallSettings)

public override void DeleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)

Deletes a user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`DeleteUserWorkloadsConfigMapRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

EnvironmentsClient.DeleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest, CallSettings)

DeleteUserWorkloadsConfigMapAsync(DeleteUserWorkloadsConfigMapRequest, CallSettings)

public override Task DeleteUserWorkloadsConfigMapAsync(DeleteUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)

Deletes a user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`DeleteUserWorkloadsConfigMapRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Overrides

EnvironmentsClient.DeleteUserWorkloadsConfigMapAsync(DeleteUserWorkloadsConfigMapRequest, CallSettings)

DeleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest, CallSettings)

public override void DeleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest request, CallSettings callSettings = null)

Deletes a user workloads Secret.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`DeleteUserWorkloadsSecretRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

EnvironmentsClient.DeleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest, CallSettings)

DeleteUserWorkloadsSecretAsync(DeleteUserWorkloadsSecretRequest, CallSettings)

public override Task DeleteUserWorkloadsSecretAsync(DeleteUserWorkloadsSecretRequest request, CallSettings callSettings = null)

Deletes a user workloads Secret.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`DeleteUserWorkloadsSecretRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Overrides

EnvironmentsClient.DeleteUserWorkloadsSecretAsync(DeleteUserWorkloadsSecretRequest, CallSettings)

ExecuteAirflowCommand(ExecuteAirflowCommandRequest, CallSettings)

public override ExecuteAirflowCommandResponse ExecuteAirflowCommand(ExecuteAirflowCommandRequest request, CallSettings callSettings = null)

Executes Airflow CLI command.

Parameters
Name	Description
`request`	`ExecuteAirflowCommandRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ExecuteAirflowCommandResponse`	The RPC response.

Overrides

EnvironmentsClient.ExecuteAirflowCommand(ExecuteAirflowCommandRequest, CallSettings)

ExecuteAirflowCommandAsync(ExecuteAirflowCommandRequest, CallSettings)

public override Task<ExecuteAirflowCommandResponse> ExecuteAirflowCommandAsync(ExecuteAirflowCommandRequest request, CallSettings callSettings = null)

Executes Airflow CLI command.

Parameters
Name	Description
`request`	`ExecuteAirflowCommandRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskExecuteAirflowCommandResponse`	A Task containing the RPC response.

Overrides

EnvironmentsClient.ExecuteAirflowCommandAsync(ExecuteAirflowCommandRequest, CallSettings)

FetchDatabaseProperties(FetchDatabasePropertiesRequest, CallSettings)

public override FetchDatabasePropertiesResponse FetchDatabaseProperties(FetchDatabasePropertiesRequest request, CallSettings callSettings = null)

Fetches database properties.

Parameters
Name	Description
`request`	`FetchDatabasePropertiesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`FetchDatabasePropertiesResponse`	The RPC response.

Overrides

EnvironmentsClient.FetchDatabaseProperties(FetchDatabasePropertiesRequest, CallSettings)

FetchDatabasePropertiesAsync(FetchDatabasePropertiesRequest, CallSettings)

public override Task<FetchDatabasePropertiesResponse> FetchDatabasePropertiesAsync(FetchDatabasePropertiesRequest request, CallSettings callSettings = null)

Fetches database properties.

Parameters
Name	Description
`request`	`FetchDatabasePropertiesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskFetchDatabasePropertiesResponse`	A Task containing the RPC response.

Overrides

EnvironmentsClient.FetchDatabasePropertiesAsync(FetchDatabasePropertiesRequest, CallSettings)

GetEnvironment(GetEnvironmentRequest, CallSettings)

public override Environment GetEnvironment(GetEnvironmentRequest request, CallSettings callSettings = null)

Get an existing environment.

Parameters
Name	Description
`request`	`GetEnvironmentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Environment`	The RPC response.

Overrides

EnvironmentsClient.GetEnvironment(GetEnvironmentRequest, CallSettings)

GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

public override Task<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallSettings callSettings = null)

Get an existing environment.

Parameters
Name	Description
`request`	`GetEnvironmentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskEnvironment`	A Task containing the RPC response.

Overrides

EnvironmentsClient.GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

GetUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest, CallSettings)

public override UserWorkloadsConfigMap GetUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)

Gets an existing user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`GetUserWorkloadsConfigMapRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`UserWorkloadsConfigMap`	The RPC response.

Overrides

EnvironmentsClient.GetUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest, CallSettings)

GetUserWorkloadsConfigMapAsync(GetUserWorkloadsConfigMapRequest, CallSettings)

public override Task<UserWorkloadsConfigMap> GetUserWorkloadsConfigMapAsync(GetUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)

Gets an existing user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`GetUserWorkloadsConfigMapRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskUserWorkloadsConfigMap`	A Task containing the RPC response.

Overrides

EnvironmentsClient.GetUserWorkloadsConfigMapAsync(GetUserWorkloadsConfigMapRequest, CallSettings)

GetUserWorkloadsSecret(GetUserWorkloadsSecretRequest, CallSettings)

public override UserWorkloadsSecret GetUserWorkloadsSecret(GetUserWorkloadsSecretRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
`request`	`GetUserWorkloadsSecretRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`UserWorkloadsSecret`	The RPC response.

Overrides

EnvironmentsClient.GetUserWorkloadsSecret(GetUserWorkloadsSecretRequest, CallSettings)

GetUserWorkloadsSecretAsync(GetUserWorkloadsSecretRequest, CallSettings)

public override Task<UserWorkloadsSecret> GetUserWorkloadsSecretAsync(GetUserWorkloadsSecretRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
`request`	`GetUserWorkloadsSecretRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskUserWorkloadsSecret`	A Task containing the RPC response.

Overrides

EnvironmentsClient.GetUserWorkloadsSecretAsync(GetUserWorkloadsSecretRequest, CallSettings)

ListEnvironments(ListEnvironmentsRequest, CallSettings)

public override PagedEnumerable<ListEnvironmentsResponse, Environment> ListEnvironments(ListEnvironmentsRequest request, CallSettings callSettings = null)

List environments.

Parameters
Name	Description
`request`	`ListEnvironmentsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListEnvironmentsResponseEnvironment`	A pageable sequence of Environment resources.

Overrides

EnvironmentsClient.ListEnvironments(ListEnvironmentsRequest, CallSettings)

ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

public override PagedAsyncEnumerable<ListEnvironmentsResponse, Environment> ListEnvironmentsAsync(ListEnvironmentsRequest request, CallSettings callSettings = null)

List environments.

Parameters
Name	Description
`request`	`ListEnvironmentsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListEnvironmentsResponseEnvironment`	A pageable asynchronous sequence of Environment resources.

Overrides

EnvironmentsClient.ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

ListUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest, CallSettings)

public override PagedEnumerable<ListUserWorkloadsConfigMapsResponse, UserWorkloadsConfigMap> ListUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest request, CallSettings callSettings = null)

Lists user workloads ConfigMaps.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`ListUserWorkloadsConfigMapsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListUserWorkloadsConfigMapsResponseUserWorkloadsConfigMap`	A pageable sequence of UserWorkloadsConfigMap resources.

Overrides

EnvironmentsClient.ListUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest, CallSettings)

ListUserWorkloadsConfigMapsAsync(ListUserWorkloadsConfigMapsRequest, CallSettings)

public override PagedAsyncEnumerable<ListUserWorkloadsConfigMapsResponse, UserWorkloadsConfigMap> ListUserWorkloadsConfigMapsAsync(ListUserWorkloadsConfigMapsRequest request, CallSettings callSettings = null)

Lists user workloads ConfigMaps.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`ListUserWorkloadsConfigMapsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListUserWorkloadsConfigMapsResponseUserWorkloadsConfigMap`	A pageable asynchronous sequence of UserWorkloadsConfigMap resources.

Overrides

EnvironmentsClient.ListUserWorkloadsConfigMapsAsync(ListUserWorkloadsConfigMapsRequest, CallSettings)

ListUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest, CallSettings)

public override PagedEnumerable<ListUserWorkloadsSecretsResponse, UserWorkloadsSecret> ListUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest request, CallSettings callSettings = null)

Lists user workloads Secrets.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`ListUserWorkloadsSecretsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListUserWorkloadsSecretsResponseUserWorkloadsSecret`	A pageable sequence of UserWorkloadsSecret resources.

Overrides

EnvironmentsClient.ListUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest, CallSettings)

ListUserWorkloadsSecretsAsync(ListUserWorkloadsSecretsRequest, CallSettings)

public override PagedAsyncEnumerable<ListUserWorkloadsSecretsResponse, UserWorkloadsSecret> ListUserWorkloadsSecretsAsync(ListUserWorkloadsSecretsRequest request, CallSettings callSettings = null)

Lists user workloads Secrets.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`ListUserWorkloadsSecretsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListUserWorkloadsSecretsResponseUserWorkloadsSecret`	A pageable asynchronous sequence of UserWorkloadsSecret resources.

Overrides

EnvironmentsClient.ListUserWorkloadsSecretsAsync(ListUserWorkloadsSecretsRequest, CallSettings)

ListWorkloads(ListWorkloadsRequest, CallSettings)

public override PagedEnumerable<ListWorkloadsResponse, ListWorkloadsResponse.Types.ComposerWorkload> ListWorkloads(ListWorkloadsRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
`request`	`ListWorkloadsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListWorkloadsResponseListWorkloadsResponseTypesComposerWorkload`	A pageable sequence of ListWorkloadsResponse.Types.ComposerWorkload resources.

Overrides

EnvironmentsClient.ListWorkloads(ListWorkloadsRequest, CallSettings)

ListWorkloadsAsync(ListWorkloadsRequest, CallSettings)

public override PagedAsyncEnumerable<ListWorkloadsResponse, ListWorkloadsResponse.Types.ComposerWorkload> ListWorkloadsAsync(ListWorkloadsRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
`request`	`ListWorkloadsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListWorkloadsResponseListWorkloadsResponseTypesComposerWorkload`	A pageable asynchronous sequence of ListWorkloadsResponse.Types.ComposerWorkload resources.

Overrides

EnvironmentsClient.ListWorkloadsAsync(ListWorkloadsRequest, CallSettings)

LoadSnapshot(LoadSnapshotRequest, CallSettings)

public override Operation<LoadSnapshotResponse, OperationMetadata> LoadSnapshot(LoadSnapshotRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
`request`	`LoadSnapshotRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationLoadSnapshotResponseOperationMetadata`	The RPC response.

Overrides

EnvironmentsClient.LoadSnapshot(LoadSnapshotRequest, CallSettings)

LoadSnapshotAsync(LoadSnapshotRequest, CallSettings)

public override Task<Operation<LoadSnapshotResponse, OperationMetadata>> LoadSnapshotAsync(LoadSnapshotRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
`request`	`LoadSnapshotRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationLoadSnapshotResponseOperationMetadata`	A Task containing the RPC response.

Overrides

EnvironmentsClient.LoadSnapshotAsync(LoadSnapshotRequest, CallSettings)

PollAirflowCommand(PollAirflowCommandRequest, CallSettings)

public override PollAirflowCommandResponse PollAirflowCommand(PollAirflowCommandRequest request, CallSettings callSettings = null)

Polls Airflow CLI command execution and fetches logs.

Parameters
Name	Description
`request`	`PollAirflowCommandRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PollAirflowCommandResponse`	The RPC response.

Overrides

EnvironmentsClient.PollAirflowCommand(PollAirflowCommandRequest, CallSettings)

PollAirflowCommandAsync(PollAirflowCommandRequest, CallSettings)

public override Task<PollAirflowCommandResponse> PollAirflowCommandAsync(PollAirflowCommandRequest request, CallSettings callSettings = null)

Polls Airflow CLI command execution and fetches logs.

Parameters
Name	Description
`request`	`PollAirflowCommandRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskPollAirflowCommandResponse`	A Task containing the RPC response.

Overrides

EnvironmentsClient.PollAirflowCommandAsync(PollAirflowCommandRequest, CallSettings)

SaveSnapshot(SaveSnapshotRequest, CallSettings)

public override Operation<SaveSnapshotResponse, OperationMetadata> SaveSnapshot(SaveSnapshotRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
`request`	`SaveSnapshotRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationSaveSnapshotResponseOperationMetadata`	The RPC response.

Overrides

EnvironmentsClient.SaveSnapshot(SaveSnapshotRequest, CallSettings)

SaveSnapshotAsync(SaveSnapshotRequest, CallSettings)

public override Task<Operation<SaveSnapshotResponse, OperationMetadata>> SaveSnapshotAsync(SaveSnapshotRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
`request`	`SaveSnapshotRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationSaveSnapshotResponseOperationMetadata`	A Task containing the RPC response.

Overrides

EnvironmentsClient.SaveSnapshotAsync(SaveSnapshotRequest, CallSettings)

StopAirflowCommand(StopAirflowCommandRequest, CallSettings)

public override StopAirflowCommandResponse StopAirflowCommand(StopAirflowCommandRequest request, CallSettings callSettings = null)

Stops Airflow CLI command execution.

Parameters
Name	Description
`request`	`StopAirflowCommandRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`StopAirflowCommandResponse`	The RPC response.

Overrides

EnvironmentsClient.StopAirflowCommand(StopAirflowCommandRequest, CallSettings)

StopAirflowCommandAsync(StopAirflowCommandRequest, CallSettings)

public override Task<StopAirflowCommandResponse> StopAirflowCommandAsync(StopAirflowCommandRequest request, CallSettings callSettings = null)

Stops Airflow CLI command execution.

Parameters
Name	Description
`request`	`StopAirflowCommandRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskStopAirflowCommandResponse`	A Task containing the RPC response.

Overrides

EnvironmentsClient.StopAirflowCommandAsync(StopAirflowCommandRequest, CallSettings)

UpdateEnvironment(UpdateEnvironmentRequest, CallSettings)

public override Operation<Environment, OperationMetadata> UpdateEnvironment(UpdateEnvironmentRequest request, CallSettings callSettings = null)

Update an environment.

Parameters
Name	Description
`request`	`UpdateEnvironmentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationEnvironmentOperationMetadata`	The RPC response.

Overrides

EnvironmentsClient.UpdateEnvironment(UpdateEnvironmentRequest, CallSettings)

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallSettings)

public override Task<Operation<Environment, OperationMetadata>> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, CallSettings callSettings = null)

Update an environment.

Parameters
Name	Description
`request`	`UpdateEnvironmentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationEnvironmentOperationMetadata`	A Task containing the RPC response.

Overrides

EnvironmentsClient.UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallSettings)

UpdateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest, CallSettings)

public override UserWorkloadsConfigMap UpdateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)

Updates a user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`UpdateUserWorkloadsConfigMapRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`UserWorkloadsConfigMap`	The RPC response.

Overrides

EnvironmentsClient.UpdateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest, CallSettings)

UpdateUserWorkloadsConfigMapAsync(UpdateUserWorkloadsConfigMapRequest, CallSettings)

public override Task<UserWorkloadsConfigMap> UpdateUserWorkloadsConfigMapAsync(UpdateUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)

Updates a user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`UpdateUserWorkloadsConfigMapRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskUserWorkloadsConfigMap`	A Task containing the RPC response.

Overrides

EnvironmentsClient.UpdateUserWorkloadsConfigMapAsync(UpdateUserWorkloadsConfigMapRequest, CallSettings)

UpdateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest, CallSettings)

public override UserWorkloadsSecret UpdateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest request, CallSettings callSettings = null)

Updates a user workloads Secret.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`UpdateUserWorkloadsSecretRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`UserWorkloadsSecret`	The RPC response.

Overrides

EnvironmentsClient.UpdateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest, CallSettings)

UpdateUserWorkloadsSecretAsync(UpdateUserWorkloadsSecretRequest, CallSettings)

public override Task<UserWorkloadsSecret> UpdateUserWorkloadsSecretAsync(UpdateUserWorkloadsSecretRequest request, CallSettings callSettings = null)

Updates a user workloads Secret.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
Name	Description
`request`	`UpdateUserWorkloadsSecretRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskUserWorkloadsSecret`	A Task containing the RPC response.

Overrides

EnvironmentsClient.UpdateUserWorkloadsSecretAsync(UpdateUserWorkloadsSecretRequest, CallSettings)