Cloud Composer v1 API - Class Environments.EnvironmentsClient (2.2.0)

public class EnvironmentsClient : ClientBase<Environments.EnvironmentsClient>

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

Client for Environments

Inheritance

Object > ClientBase > ClientBase<Environments.EnvironmentsClient> > Environments.EnvironmentsClient

Namespace

Google.Cloud.Orchestration.Airflow.Service.V1

Assembly

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

Constructors

EnvironmentsClient()

protected EnvironmentsClient()

Protected parameterless constructor to allow creation of test doubles.

EnvironmentsClient(CallInvoker)

public EnvironmentsClient(CallInvoker callInvoker)

Creates a new client for Environments that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

EnvironmentsClient(ChannelBase)

public EnvironmentsClient(ChannelBase channel)

Creates a new client for Environments

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

EnvironmentsClient(ClientBase.ClientBaseConfiguration)

protected EnvironmentsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateEnvironment(CreateEnvironmentRequest, CallOptions)

public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, CallOptions options)

Create a new environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateEnvironment(CreateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Create a new environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateEnvironmentAsync(CreateEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallOptions options)

Create a new environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateEnvironmentAsync(CreateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateEnvironmentAsync(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Create a new environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

DeleteEnvironment(DeleteEnvironmentRequest, CallOptions)

public virtual Operation DeleteEnvironment(DeleteEnvironmentRequest request, CallOptions options)

Delete an environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteEnvironment(DeleteEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteEnvironment(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Delete an environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallOptions options)

Delete an environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Delete an environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

GetEnvironment(GetEnvironmentRequest, CallOptions)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, CallOptions options)

Get an existing environment.

Parameters
NameDescription
requestGetEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Environment

The response received from the server.

GetEnvironment(GetEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Get an existing environment.

Parameters
NameDescription
requestGetEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Environment

The response received from the server.

GetEnvironmentAsync(GetEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallOptions options)

Get an existing environment.

Parameters
NameDescription
requestGetEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Environment>

The call object.

GetEnvironmentAsync(GetEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Get an existing environment.

Parameters
NameDescription
requestGetEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Environment>

The call object.

ListEnvironments(ListEnvironmentsRequest, CallOptions)

public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, CallOptions options)

List environments.

Parameters
NameDescription
requestListEnvironmentsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListEnvironmentsResponse

The response received from the server.

ListEnvironments(ListEnvironmentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List environments.

Parameters
NameDescription
requestListEnvironmentsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListEnvironmentsResponse

The response received from the server.

ListEnvironmentsAsync(ListEnvironmentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEnvironmentsResponse> ListEnvironmentsAsync(ListEnvironmentsRequest request, CallOptions options)

List environments.

Parameters
NameDescription
requestListEnvironmentsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListEnvironmentsResponse>

The call object.

ListEnvironmentsAsync(ListEnvironmentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListEnvironmentsResponse> ListEnvironmentsAsync(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List environments.

Parameters
NameDescription
requestListEnvironmentsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListEnvironmentsResponse>

The call object.

LoadSnapshot(LoadSnapshotRequest, CallOptions)

public virtual Operation LoadSnapshot(LoadSnapshotRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

LoadSnapshot(LoadSnapshotRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation LoadSnapshot(LoadSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

LoadSnapshotAsync(LoadSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> LoadSnapshotAsync(LoadSnapshotRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

LoadSnapshotAsync(LoadSnapshotRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> LoadSnapshotAsync(LoadSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Environments.EnvironmentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
Environments.EnvironmentsClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Orchestration.Airflow.Service.V1.Environments.EnvironmentsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SaveSnapshot(SaveSnapshotRequest, CallOptions)

public virtual Operation SaveSnapshot(SaveSnapshotRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SaveSnapshot(SaveSnapshotRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation SaveSnapshot(SaveSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SaveSnapshotAsync(SaveSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SaveSnapshotAsync(SaveSnapshotRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SaveSnapshotAsync(SaveSnapshotRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> SaveSnapshotAsync(SaveSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateEnvironment(UpdateEnvironmentRequest, CallOptions)

public virtual Operation UpdateEnvironment(UpdateEnvironmentRequest request, CallOptions options)

Update an environment.

Parameters
NameDescription
requestUpdateEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateEnvironment(UpdateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateEnvironment(UpdateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Update an environment.

Parameters
NameDescription
requestUpdateEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, CallOptions options)

Update an environment.

Parameters
NameDescription
requestUpdateEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateEnvironmentAsync(UpdateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Update an environment.

Parameters
NameDescription
requestUpdateEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.