Cloud Composer v1 API - Class EnvironmentsClientImpl (2.4.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.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)

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)

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)

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)

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)