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

Version 2.3.0

• 2.8.0 (latest)
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0

[BindServiceMethod(typeof(Environments), "BindService")]
public abstract class Environments.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

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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
Name	Description
request	CreateEnvironmentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	DeleteEnvironmentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	GetEnvironmentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEnvironment	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
Name	Description
request	ListEnvironmentsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListEnvironmentsResponse	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
Name	Description
request	LoadSnapshotRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	SaveSnapshotRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	UpdateEnvironmentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).