Class EnvironmentsGrpc.EnvironmentsBlockingStub (1.16.0)

public static final class EnvironmentsGrpc.EnvironmentsBlockingStub extends AbstractBlockingStub<EnvironmentsGrpc.EnvironmentsBlockingStub>

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

Managed Apache Airflow Environments.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > EnvironmentsGrpc.EnvironmentsBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

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

checkUpgrade(CheckUpgradeRequest request)

public 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
Operation

createEnvironment(CreateEnvironmentRequest request)

public Operation createEnvironment(CreateEnvironmentRequest request)

Create a new environment.

Parameter
Name Description
request CreateEnvironmentRequest
Returns
Type Description
Operation

deleteEnvironment(DeleteEnvironmentRequest request)

public Operation deleteEnvironment(DeleteEnvironmentRequest request)

Delete an environment.

Parameter
Name Description
request DeleteEnvironmentRequest
Returns
Type Description
Operation

getEnvironment(GetEnvironmentRequest request)

public Environment getEnvironment(GetEnvironmentRequest request)

Get an existing environment.

Parameter
Name Description
request GetEnvironmentRequest
Returns
Type Description
Environment

listEnvironments(ListEnvironmentsRequest request)

public ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest request)

List environments.

Parameter
Name Description
request ListEnvironmentsRequest
Returns
Type Description
ListEnvironmentsResponse

loadSnapshot(LoadSnapshotRequest request)

public 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
Operation

restartWebServer(RestartWebServerRequest request)

public Operation restartWebServer(RestartWebServerRequest request)

Restart Airflow web server.

Parameter
Name Description
request RestartWebServerRequest
Returns
Type Description
Operation

saveSnapshot(SaveSnapshotRequest request)

public 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
Operation

updateEnvironment(UpdateEnvironmentRequest request)

public Operation updateEnvironment(UpdateEnvironmentRequest request)

Update an environment.

Parameter
Name Description
request UpdateEnvironmentRequest
Returns
Type Description
Operation