Class EnvironmentsGrpc.EnvironmentsStub (1.30.0)

public static final class EnvironmentsGrpc.EnvironmentsStub extends AbstractAsyncStub<EnvironmentsGrpc.EnvironmentsStub>

A stub to allow clients to do asynchronous rpc calls to service Environments.

Managed Apache Airflow Environments.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > EnvironmentsGrpc.EnvironmentsStub

Methods

build(Channel channel, CallOptions callOptions)

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

checkUpgrade(CheckUpgradeRequest request, StreamObserver<Operation> responseObserver)

public void checkUpgrade(CheckUpgradeRequest request, StreamObserver<Operation> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<Operation>

createEnvironment(CreateEnvironmentRequest request, StreamObserver<Operation> responseObserver)

public void createEnvironment(CreateEnvironmentRequest request, StreamObserver<Operation> responseObserver)

Create a new environment.

Parameters
Name Description
request CreateEnvironmentRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

databaseFailover(DatabaseFailoverRequest request, StreamObserver<Operation> responseObserver)

public void databaseFailover(DatabaseFailoverRequest request, StreamObserver<Operation> responseObserver)

Triggers database failover (only for highly resilient environments).

Parameters
Name Description
request DatabaseFailoverRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteEnvironment(DeleteEnvironmentRequest request, StreamObserver<Operation> responseObserver)

public void deleteEnvironment(DeleteEnvironmentRequest request, StreamObserver<Operation> responseObserver)

Delete an environment.

Parameters
Name Description
request DeleteEnvironmentRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

executeAirflowCommand(ExecuteAirflowCommandRequest request, StreamObserver<ExecuteAirflowCommandResponse> responseObserver)

public void executeAirflowCommand(ExecuteAirflowCommandRequest request, StreamObserver<ExecuteAirflowCommandResponse> responseObserver)

Executes Airflow CLI command.

Parameters
Name Description
request ExecuteAirflowCommandRequest
responseObserver io.grpc.stub.StreamObserver<ExecuteAirflowCommandResponse>

fetchDatabaseProperties(FetchDatabasePropertiesRequest request, StreamObserver<FetchDatabasePropertiesResponse> responseObserver)

public void fetchDatabaseProperties(FetchDatabasePropertiesRequest request, StreamObserver<FetchDatabasePropertiesResponse> responseObserver)

Fetches database properties.

Parameters
Name Description
request FetchDatabasePropertiesRequest
responseObserver io.grpc.stub.StreamObserver<FetchDatabasePropertiesResponse>

getEnvironment(GetEnvironmentRequest request, StreamObserver<Environment> responseObserver)

public void getEnvironment(GetEnvironmentRequest request, StreamObserver<Environment> responseObserver)

Get an existing environment.

Parameters
Name Description
request GetEnvironmentRequest
responseObserver io.grpc.stub.StreamObserver<Environment>

listEnvironments(ListEnvironmentsRequest request, StreamObserver<ListEnvironmentsResponse> responseObserver)

public void listEnvironments(ListEnvironmentsRequest request, StreamObserver<ListEnvironmentsResponse> responseObserver)

List environments.

Parameters
Name Description
request ListEnvironmentsRequest
responseObserver io.grpc.stub.StreamObserver<ListEnvironmentsResponse>

loadSnapshot(LoadSnapshotRequest request, StreamObserver<Operation> responseObserver)

public void loadSnapshot(LoadSnapshotRequest request, StreamObserver<Operation> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<Operation>

pollAirflowCommand(PollAirflowCommandRequest request, StreamObserver<PollAirflowCommandResponse> responseObserver)

public void pollAirflowCommand(PollAirflowCommandRequest request, StreamObserver<PollAirflowCommandResponse> responseObserver)

Polls Airflow CLI command execution and fetches logs.

Parameters
Name Description
request PollAirflowCommandRequest
responseObserver io.grpc.stub.StreamObserver<PollAirflowCommandResponse>

restartWebServer(RestartWebServerRequest request, StreamObserver<Operation> responseObserver)

public void restartWebServer(RestartWebServerRequest request, StreamObserver<Operation> responseObserver)

Restart Airflow web server.

Parameters
Name Description
request RestartWebServerRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

saveSnapshot(SaveSnapshotRequest request, StreamObserver<Operation> responseObserver)

public void saveSnapshot(SaveSnapshotRequest request, StreamObserver<Operation> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<Operation>

stopAirflowCommand(StopAirflowCommandRequest request, StreamObserver<StopAirflowCommandResponse> responseObserver)

public void stopAirflowCommand(StopAirflowCommandRequest request, StreamObserver<StopAirflowCommandResponse> responseObserver)

Stops Airflow CLI command execution.

Parameters
Name Description
request StopAirflowCommandRequest
responseObserver io.grpc.stub.StreamObserver<StopAirflowCommandResponse>

updateEnvironment(UpdateEnvironmentRequest request, StreamObserver<Operation> responseObserver)

public void updateEnvironment(UpdateEnvironmentRequest request, StreamObserver<Operation> responseObserver)

Update an environment.

Parameters
Name Description
request UpdateEnvironmentRequest
responseObserver io.grpc.stub.StreamObserver<Operation>