Class EnvironmentsGrpc.EnvironmentsFutureStub (1.46.0)

Version 1.46.0

• 1.54.0 (latest)
• 1.53.0
• 1.52.0
• 1.51.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.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

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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>

createUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest request)

public ListenableFuture<UserWorkloadsConfigMap> createUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest request)

Creates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameter
Name	Description
request	CreateUserWorkloadsConfigMapRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<UserWorkloadsConfigMap>

createUserWorkloadsSecret(CreateUserWorkloadsSecretRequest request)

public ListenableFuture<UserWorkloadsSecret> createUserWorkloadsSecret(CreateUserWorkloadsSecretRequest request)

Creates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameter
Name	Description
request	CreateUserWorkloadsSecretRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<UserWorkloadsSecret>

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>

deleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest request)

public ListenableFuture<Empty> deleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest request)

Deletes a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameter
Name	Description
request	DeleteUserWorkloadsConfigMapRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest request)

public ListenableFuture<Empty> deleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest request)

Deletes a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameter
Name	Description
request	DeleteUserWorkloadsSecretRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Empty>

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>

getUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest request)

public ListenableFuture<UserWorkloadsConfigMap> getUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest request)

Gets an existing user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameter
Name	Description
request	GetUserWorkloadsConfigMapRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<UserWorkloadsConfigMap>

getUserWorkloadsSecret(GetUserWorkloadsSecretRequest request)

public ListenableFuture<UserWorkloadsSecret> getUserWorkloadsSecret(GetUserWorkloadsSecretRequest request)

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.

Parameter
Name	Description
request	GetUserWorkloadsSecretRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<UserWorkloadsSecret>

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>

listUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest request)

public ListenableFuture<ListUserWorkloadsConfigMapsResponse> listUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest request)

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

Parameter
Name	Description
request	ListUserWorkloadsConfigMapsRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<ListUserWorkloadsConfigMapsResponse>

listUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest request)

public ListenableFuture<ListUserWorkloadsSecretsResponse> listUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest request)

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

Parameter
Name	Description
request	ListUserWorkloadsSecretsRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<ListUserWorkloadsSecretsResponse>

listWorkloads(ListWorkloadsRequest request)

public ListenableFuture<ListWorkloadsResponse> listWorkloads(ListWorkloadsRequest request)

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.

Parameter
Name	Description
request	ListWorkloadsRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<ListWorkloadsResponse>

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>

updateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest request)

public ListenableFuture<UserWorkloadsConfigMap> updateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest request)

Updates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameter
Name	Description
request	UpdateUserWorkloadsConfigMapRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<UserWorkloadsConfigMap>

updateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest request)

public ListenableFuture<UserWorkloadsSecret> updateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest request)

Updates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameter
Name	Description
request	UpdateUserWorkloadsSecretRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<UserWorkloadsSecret>