Cloud Composer v1 API - Class Environments.EnvironmentsBase (2.1.0)

[BindServiceMethod(typeof(Environments), "BindService")]
public abstract class EnvironmentsBase

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

Base class for server-side implementations of Environments

Inheritance

Object > Environments.EnvironmentsBase

Namespace

Google.Cloud.Orchestration.Airflow.Service.V1

Assembly

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

Methods

CreateEnvironment(CreateEnvironmentRequest, ServerCallContext)

public virtual Task<Operation> CreateEnvironment(CreateEnvironmentRequest request, ServerCallContext context)

Create a new environment.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

DeleteEnvironment(DeleteEnvironmentRequest, ServerCallContext)

public virtual Task<Operation> DeleteEnvironment(DeleteEnvironmentRequest request, ServerCallContext context)

Delete an environment.

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

GetEnvironment(GetEnvironmentRequest, ServerCallContext)

public virtual Task<Environment> GetEnvironment(GetEnvironmentRequest request, ServerCallContext context)

Get an existing environment.

Parameters
NameDescription
requestGetEnvironmentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Environment>

The response to send back to the client (wrapped by a task).

ListEnvironments(ListEnvironmentsRequest, ServerCallContext)

public virtual Task<ListEnvironmentsResponse> ListEnvironments(ListEnvironmentsRequest request, ServerCallContext context)

List environments.

Parameters
NameDescription
requestListEnvironmentsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ListEnvironmentsResponse>

The response to send back to the client (wrapped by a task).

LoadSnapshot(LoadSnapshotRequest, ServerCallContext)

public virtual Task<Operation> LoadSnapshot(LoadSnapshotRequest request, ServerCallContext context)

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 received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

SaveSnapshot(SaveSnapshotRequest, ServerCallContext)

public virtual Task<Operation> SaveSnapshot(SaveSnapshotRequest request, ServerCallContext context)

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 received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

UpdateEnvironment(UpdateEnvironmentRequest, ServerCallContext)

public virtual Task<Operation> UpdateEnvironment(UpdateEnvironmentRequest request, ServerCallContext context)

Update an environment.

Parameters
NameDescription
requestUpdateEnvironmentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).