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

Namespace

Google.Cloud.Orchestration.Airflow.Service.V1

Assembly

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

Remarks

Managed Apache Airflow Environments.

Constructors

EnvironmentsClientImpl(Environments.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
NameDescription
grpcClientEnvironments.EnvironmentsClient

The underlying gRPC client.

settingsEnvironmentsSettings

The base EnvironmentsSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CreateEnvironmentOperationsClient

public override OperationsClient CreateEnvironmentOperationsClient { get; }

The long-running operations client for CreateEnvironment.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteEnvironmentOperationsClient

public override OperationsClient DeleteEnvironmentOperationsClient { get; }

The long-running operations client for DeleteEnvironment.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override Environments.EnvironmentsClient GrpcClient { get; }

The underlying gRPC Environments client

Property Value
TypeDescription
Environments.EnvironmentsClient
Overrides

LoadSnapshotOperationsClient

public override OperationsClient LoadSnapshotOperationsClient { get; }

The long-running operations client for LoadSnapshot.

Property Value
TypeDescription
OperationsClient
Overrides

SaveSnapshotOperationsClient

public override OperationsClient SaveSnapshotOperationsClient { get; }

The long-running operations client for SaveSnapshot.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateEnvironmentOperationsClient

public override OperationsClient UpdateEnvironmentOperationsClient { get; }

The long-running operations client for UpdateEnvironment.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

CreateEnvironment(CreateEnvironmentRequest, CallSettings)

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

Create a new environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Environment, OperationMetadata>

The RPC response.

Overrides

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

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

Create a new environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Environment, OperationMetadata>>

A Task containing the RPC response.

Overrides

DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

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

Delete an environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Overrides

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

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

Delete an environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Overrides

GetEnvironment(GetEnvironmentRequest, CallSettings)

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

Get an existing environment.

Parameters
NameDescription
requestGetEnvironmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Environment

The RPC response.

Overrides

GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

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

Get an existing environment.

Parameters
NameDescription
requestGetEnvironmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Environment>

A Task containing the RPC response.

Overrides

ListEnvironments(ListEnvironmentsRequest, CallSettings)

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

List environments.

Parameters
NameDescription
requestListEnvironmentsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListEnvironmentsResponse, Environment>

A pageable sequence of Environment resources.

Overrides

ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

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

List environments.

Parameters
NameDescription
requestListEnvironmentsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListEnvironmentsResponse, Environment>

A pageable asynchronous sequence of Environment resources.

Overrides

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
NameDescription
requestLoadSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<LoadSnapshotResponse, OperationMetadata>

The RPC response.

Overrides

LoadSnapshotAsync(LoadSnapshotRequest, CallSettings)

public override async 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
NameDescription
requestLoadSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<LoadSnapshotResponse, OperationMetadata>>

A Task containing the RPC response.

Overrides

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
NameDescription
requestSaveSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<SaveSnapshotResponse, OperationMetadata>

The RPC response.

Overrides

SaveSnapshotAsync(SaveSnapshotRequest, CallSettings)

public override async 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
NameDescription
requestSaveSnapshotRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<SaveSnapshotResponse, OperationMetadata>>

A Task containing the RPC response.

Overrides

UpdateEnvironment(UpdateEnvironmentRequest, CallSettings)

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

Update an environment.

Parameters
NameDescription
requestUpdateEnvironmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Environment, OperationMetadata>

The RPC response.

Overrides

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallSettings)

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

Update an environment.

Parameters
NameDescription
requestUpdateEnvironmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Environment, OperationMetadata>>

A Task containing the RPC response.

Overrides