Cloud Composer v1 API - Class Environments.EnvironmentsBase (2.5.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

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
TaskOperation

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

CreateUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest, ServerCallContext)

public virtual Task<UserWorkloadsConfigMap> CreateUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest request, ServerCallContext context)

Creates a user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
NameDescription
requestCreateUserWorkloadsConfigMapRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskUserWorkloadsConfigMap

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

CreateUserWorkloadsSecret(CreateUserWorkloadsSecretRequest, ServerCallContext)

public virtual Task<UserWorkloadsSecret> CreateUserWorkloadsSecret(CreateUserWorkloadsSecretRequest request, ServerCallContext context)

Creates a user workloads Secret.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
NameDescription
requestCreateUserWorkloadsSecretRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskUserWorkloadsSecret

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

DatabaseFailover(DatabaseFailoverRequest, ServerCallContext)

public virtual Task<Operation> DatabaseFailover(DatabaseFailoverRequest request, ServerCallContext context)

Triggers database failover (only for highly resilient environments).

Parameters
NameDescription
requestDatabaseFailoverRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
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
NameDescription
requestDeleteEnvironmentRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskOperation

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

DeleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest, ServerCallContext)

public virtual Task<Empty> DeleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest request, ServerCallContext context)

Deletes a user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
NameDescription
requestDeleteUserWorkloadsConfigMapRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskEmpty

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

DeleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest, ServerCallContext)

public virtual Task<Empty> DeleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest request, ServerCallContext context)

Deletes a user workloads Secret.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
NameDescription
requestDeleteUserWorkloadsSecretRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskEmpty

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

ExecuteAirflowCommand(ExecuteAirflowCommandRequest, ServerCallContext)

public virtual Task<ExecuteAirflowCommandResponse> ExecuteAirflowCommand(ExecuteAirflowCommandRequest request, ServerCallContext context)

Executes Airflow CLI command.

Parameters
NameDescription
requestExecuteAirflowCommandRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskExecuteAirflowCommandResponse

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

FetchDatabaseProperties(FetchDatabasePropertiesRequest, ServerCallContext)

public virtual Task<FetchDatabasePropertiesResponse> FetchDatabaseProperties(FetchDatabasePropertiesRequest request, ServerCallContext context)

Fetches database properties.

Parameters
NameDescription
requestFetchDatabasePropertiesRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskFetchDatabasePropertiesResponse

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
TaskEnvironment

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

GetUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest, ServerCallContext)

public virtual Task<UserWorkloadsConfigMap> GetUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest request, ServerCallContext context)

Gets an existing user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
NameDescription
requestGetUserWorkloadsConfigMapRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskUserWorkloadsConfigMap

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

GetUserWorkloadsSecret(GetUserWorkloadsSecretRequest, ServerCallContext)

public virtual Task<UserWorkloadsSecret> GetUserWorkloadsSecret(GetUserWorkloadsSecretRequest request, ServerCallContext context)

Gets an existing user workloads Secret. Values of the "data" field in the response are cleared.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
NameDescription
requestGetUserWorkloadsSecretRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskUserWorkloadsSecret

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
TaskListEnvironmentsResponse

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

ListUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest, ServerCallContext)

public virtual Task<ListUserWorkloadsConfigMapsResponse> ListUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest request, ServerCallContext context)

Lists user workloads ConfigMaps.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
NameDescription
requestListUserWorkloadsConfigMapsRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskListUserWorkloadsConfigMapsResponse

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

ListUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest, ServerCallContext)

public virtual Task<ListUserWorkloadsSecretsResponse> ListUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest request, ServerCallContext context)

Lists user workloads Secrets.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
NameDescription
requestListUserWorkloadsSecretsRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskListUserWorkloadsSecretsResponse

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

ListWorkloads(ListWorkloadsRequest, ServerCallContext)

public virtual Task<ListWorkloadsResponse> ListWorkloads(ListWorkloadsRequest request, ServerCallContext context)

Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
NameDescription
requestListWorkloadsRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskListWorkloadsResponse

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
TaskOperation

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

PollAirflowCommand(PollAirflowCommandRequest, ServerCallContext)

public virtual Task<PollAirflowCommandResponse> PollAirflowCommand(PollAirflowCommandRequest request, ServerCallContext context)

Polls Airflow CLI command execution and fetches logs.

Parameters
NameDescription
requestPollAirflowCommandRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskPollAirflowCommandResponse

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
TaskOperation

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

StopAirflowCommand(StopAirflowCommandRequest, ServerCallContext)

public virtual Task<StopAirflowCommandResponse> StopAirflowCommand(StopAirflowCommandRequest request, ServerCallContext context)

Stops Airflow CLI command execution.

Parameters
NameDescription
requestStopAirflowCommandRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskStopAirflowCommandResponse

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
TaskOperation

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

UpdateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest, ServerCallContext)

public virtual Task<UserWorkloadsConfigMap> UpdateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest request, ServerCallContext context)

Updates a user workloads ConfigMap.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
NameDescription
requestUpdateUserWorkloadsConfigMapRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskUserWorkloadsConfigMap

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

UpdateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest, ServerCallContext)

public virtual Task<UserWorkloadsSecret> UpdateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest request, ServerCallContext context)

Updates a user workloads Secret.

This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters
NameDescription
requestUpdateUserWorkloadsSecretRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
TaskUserWorkloadsSecret

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