Class EnvironmentsGrpc.EnvironmentsStub (1.43.0)

Version 1.43.0

• 1.55.0 (latest)
• 1.54.0
• 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.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

Inherited Members

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

io.grpc.stub.AbstractAsyncStub.<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.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)

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>

createUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest request, StreamObserver<UserWorkloadsConfigMap> responseObserver)

public void createUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest request, StreamObserver<UserWorkloadsConfigMap> responseObserver)

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

createUserWorkloadsSecret(CreateUserWorkloadsSecretRequest request, StreamObserver<UserWorkloadsSecret> responseObserver)

public void createUserWorkloadsSecret(CreateUserWorkloadsSecretRequest request, StreamObserver<UserWorkloadsSecret> responseObserver)

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

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>

deleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest request, StreamObserver<Empty> responseObserver)

public void deleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest request, StreamObserver<Empty> responseObserver)

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

deleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest request, StreamObserver<Empty> responseObserver)

public void deleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest request, StreamObserver<Empty> responseObserver)

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

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>

getUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest request, StreamObserver<UserWorkloadsConfigMap> responseObserver)

public void getUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest request, StreamObserver<UserWorkloadsConfigMap> responseObserver)

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

getUserWorkloadsSecret(GetUserWorkloadsSecretRequest request, StreamObserver<UserWorkloadsSecret> responseObserver)

public void getUserWorkloadsSecret(GetUserWorkloadsSecretRequest request, StreamObserver<UserWorkloadsSecret> responseObserver)

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

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>

listUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest request, StreamObserver<ListUserWorkloadsConfigMapsResponse> responseObserver)

public void listUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest request, StreamObserver<ListUserWorkloadsConfigMapsResponse> responseObserver)

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

Parameters
Name	Description
request	ListUserWorkloadsConfigMapsRequest
responseObserver	io.grpc.stub.StreamObserver<ListUserWorkloadsConfigMapsResponse>

listUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest request, StreamObserver<ListUserWorkloadsSecretsResponse> responseObserver)

public void listUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest request, StreamObserver<ListUserWorkloadsSecretsResponse> responseObserver)

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

Parameters
Name	Description
request	ListUserWorkloadsSecretsRequest
responseObserver	io.grpc.stub.StreamObserver<ListUserWorkloadsSecretsResponse>

listWorkloads(ListWorkloadsRequest request, StreamObserver<ListWorkloadsResponse> responseObserver)

public void listWorkloads(ListWorkloadsRequest request, StreamObserver<ListWorkloadsResponse> responseObserver)

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

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>

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>

updateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest request, StreamObserver<UserWorkloadsConfigMap> responseObserver)

public void updateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest request, StreamObserver<UserWorkloadsConfigMap> responseObserver)

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

updateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest request, StreamObserver<UserWorkloadsSecret> responseObserver)

public void updateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest request, StreamObserver<UserWorkloadsSecret> responseObserver)

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