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

Version latest

• 2.9.0 (latest)
• 2.8.0
• 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

CheckUpgrade(CheckUpgradeRequest, ServerCallContext)

public virtual Task<Operation> CheckUpgrade(CheckUpgradeRequest request, ServerCallContext context)

Check if an upgrade operation on the environment will succeed.

In case of problems detailed info can be found in the returned Operation.

Parameters
Name	Description
request	CheckUpgradeRequest 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).

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).

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

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

Returns
Type	Description
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
Name	Description
request	DatabaseFailoverRequest 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).

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

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

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

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

Returns
Type	Description
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
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).

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

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

Returns
Type	Description
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
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).

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

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

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

Returns
Type	Description
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
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).

PollAirflowCommand(PollAirflowCommandRequest, ServerCallContext)

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

Polls Airflow CLI command execution and fetches logs.

Parameters
Name	Description
request	PollAirflowCommandRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
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).

StopAirflowCommand(StopAirflowCommandRequest, ServerCallContext)

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

Stops Airflow CLI command execution.

Parameters
Name	Description
request	StopAirflowCommandRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
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).

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

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

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