Class EnvironmentsGrpc.EnvironmentsFutureStub (1.27.0)

public static final class EnvironmentsGrpc.EnvironmentsFutureStub extends AbstractFutureStub<EnvironmentsGrpc.EnvironmentsFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service Environments.

Managed Apache Airflow Environments.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > EnvironmentsGrpc.EnvironmentsFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected EnvironmentsGrpc.EnvironmentsFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
EnvironmentsGrpc.EnvironmentsFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

checkUpgrade(CheckUpgradeRequest request)

public ListenableFuture<Operation> checkUpgrade(CheckUpgradeRequest request)

Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.

Parameter
Name Description
request CheckUpgradeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createEnvironment(CreateEnvironmentRequest request)

public ListenableFuture<Operation> createEnvironment(CreateEnvironmentRequest request)

Create a new environment.

Parameter
Name Description
request CreateEnvironmentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

databaseFailover(DatabaseFailoverRequest request)

public ListenableFuture<Operation> databaseFailover(DatabaseFailoverRequest request)

Triggers database failover (only for highly resilient environments).

Parameter
Name Description
request DatabaseFailoverRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteEnvironment(DeleteEnvironmentRequest request)

public ListenableFuture<Operation> deleteEnvironment(DeleteEnvironmentRequest request)

Delete an environment.

Parameter
Name Description
request DeleteEnvironmentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

executeAirflowCommand(ExecuteAirflowCommandRequest request)

public ListenableFuture<ExecuteAirflowCommandResponse> executeAirflowCommand(ExecuteAirflowCommandRequest request)

Executes Airflow CLI command.

Parameter
Name Description
request ExecuteAirflowCommandRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ExecuteAirflowCommandResponse>

fetchDatabaseProperties(FetchDatabasePropertiesRequest request)

public ListenableFuture<FetchDatabasePropertiesResponse> fetchDatabaseProperties(FetchDatabasePropertiesRequest request)

Fetches database properties.

Parameter
Name Description
request FetchDatabasePropertiesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<FetchDatabasePropertiesResponse>

getEnvironment(GetEnvironmentRequest request)

public ListenableFuture<Environment> getEnvironment(GetEnvironmentRequest request)

Get an existing environment.

Parameter
Name Description
request GetEnvironmentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Environment>

listEnvironments(ListEnvironmentsRequest request)

public ListenableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest request)

List environments.

Parameter
Name Description
request ListEnvironmentsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEnvironmentsResponse>

loadSnapshot(LoadSnapshotRequest request)

public ListenableFuture<Operation> loadSnapshot(LoadSnapshotRequest request)

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.

Parameter
Name Description
request LoadSnapshotRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

pollAirflowCommand(PollAirflowCommandRequest request)

public ListenableFuture<PollAirflowCommandResponse> pollAirflowCommand(PollAirflowCommandRequest request)

Polls Airflow CLI command execution and fetches logs.

Parameter
Name Description
request PollAirflowCommandRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<PollAirflowCommandResponse>

restartWebServer(RestartWebServerRequest request)

public ListenableFuture<Operation> restartWebServer(RestartWebServerRequest request)

Restart Airflow web server.

Parameter
Name Description
request RestartWebServerRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

saveSnapshot(SaveSnapshotRequest request)

public ListenableFuture<Operation> saveSnapshot(SaveSnapshotRequest request)

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.

Parameter
Name Description
request SaveSnapshotRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

stopAirflowCommand(StopAirflowCommandRequest request)

public ListenableFuture<StopAirflowCommandResponse> stopAirflowCommand(StopAirflowCommandRequest request)

Stops Airflow CLI command execution.

Parameter
Name Description
request StopAirflowCommandRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<StopAirflowCommandResponse>

updateEnvironment(UpdateEnvironmentRequest request)

public ListenableFuture<Operation> updateEnvironment(UpdateEnvironmentRequest request)

Update an environment.

Parameter
Name Description
request UpdateEnvironmentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>