Class Environments.EnvironmentsClient (1.0.0)

public class EnvironmentsClient : ClientBase<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
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

EnvironmentsClient(ChannelBase)

public EnvironmentsClient(ChannelBase channel)

Creates a new client for Environments

Parameter
Name Description
channel ChannelBase

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
Name Description
configuration ClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateEnvironment(CreateEnvironmentRequest, CallOptions)

public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, CallOptions options)

Create a new environment.

Parameters
Name Description
request CreateEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

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

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

Create a new environment.

Parameters
Name Description
request CreateEnvironmentRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateEnvironmentAsync(CreateEnvironmentRequest, CallOptions)

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

Create a new environment.

Parameters
Name Description
request CreateEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

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

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

Create a new environment.

Parameters
Name Description
request CreateEnvironmentRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
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
Type Description
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
Name Description
request DeleteEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

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

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

Delete an environment.

Parameters
Name Description
request DeleteEnvironmentRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallOptions)

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

Delete an environment.

Parameters
Name Description
request DeleteEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

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

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

Delete an environment.

Parameters
Name Description
request DeleteEnvironmentRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

GetEnvironment(GetEnvironmentRequest, CallOptions)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, CallOptions options)

Get an existing environment.

Parameters
Name Description
request GetEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Environment

The response received from the server.

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

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

Get an existing environment.

Parameters
Name Description
request GetEnvironmentRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Environment

The response received from the server.

GetEnvironmentAsync(GetEnvironmentRequest, CallOptions)

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

Get an existing environment.

Parameters
Name Description
request GetEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Environment>

The call object.

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

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

Get an existing environment.

Parameters
Name Description
request GetEnvironmentRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Environment>

The call object.

ListEnvironments(ListEnvironmentsRequest, CallOptions)

public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, CallOptions options)

List environments.

Parameters
Name Description
request ListEnvironmentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListEnvironmentsResponse

The response received from the server.

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

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

List environments.

Parameters
Name Description
request ListEnvironmentsRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListEnvironmentsResponse

The response received from the server.

ListEnvironmentsAsync(ListEnvironmentsRequest, CallOptions)

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

List environments.

Parameters
Name Description
request ListEnvironmentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListEnvironmentsResponse>

The call object.

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

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

List environments.

Parameters
Name Description
request ListEnvironmentsRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<ListEnvironmentsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBase.ClientBaseConfiguration
Returns
Type Description
Environments.EnvironmentsClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Orchestration.Airflow.Service.V1.Environments.EnvironmentsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateEnvironment(UpdateEnvironmentRequest, CallOptions)

public virtual Operation UpdateEnvironment(UpdateEnvironmentRequest request, CallOptions options)

Update an environment.

Parameters
Name Description
request UpdateEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

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

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

Update an environment.

Parameters
Name Description
request UpdateEnvironmentRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallOptions)

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

Update an environment.

Parameters
Name Description
request UpdateEnvironmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

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

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

Update an environment.

Parameters
Name Description
request UpdateEnvironmentRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.