Class EnvironmentsGrpc.EnvironmentsBlockingStub (1.51.0)

Version 1.51.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.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

Inherited Members

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

io.grpc.stub.AbstractBlockingStub.<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.withOnReadyThreshold(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.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

createUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest request)

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

createUserWorkloadsSecret(CreateUserWorkloadsSecretRequest request)

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

databaseFailover(DatabaseFailoverRequest request)

public Operation databaseFailover(DatabaseFailoverRequest request)

Triggers database failover (only for highly resilient environments).

Parameter
Name	Description
request	DatabaseFailoverRequest

Returns
Type	Description
Operation

deleteEnvironment(DeleteEnvironmentRequest request)

public Operation deleteEnvironment(DeleteEnvironmentRequest request)

Delete an environment.

Parameter
Name	Description
request	DeleteEnvironmentRequest

Returns
Type	Description
Operation

deleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest request)

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

deleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest request)

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

executeAirflowCommand(ExecuteAirflowCommandRequest request)

public ExecuteAirflowCommandResponse executeAirflowCommand(ExecuteAirflowCommandRequest request)

Executes Airflow CLI command.

Parameter
Name	Description
request	ExecuteAirflowCommandRequest

Returns
Type	Description
ExecuteAirflowCommandResponse

fetchDatabaseProperties(FetchDatabasePropertiesRequest request)

public FetchDatabasePropertiesResponse fetchDatabaseProperties(FetchDatabasePropertiesRequest request)

Fetches database properties.

Parameter
Name	Description
request	FetchDatabasePropertiesRequest

Returns
Type	Description
FetchDatabasePropertiesResponse

getEnvironment(GetEnvironmentRequest request)

public Environment getEnvironment(GetEnvironmentRequest request)

Get an existing environment.

Parameter
Name	Description
request	GetEnvironmentRequest

Returns
Type	Description
Environment

getUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest request)

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

getUserWorkloadsSecret(GetUserWorkloadsSecretRequest request)

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

listEnvironments(ListEnvironmentsRequest request)

public ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest request)

List environments.

Parameter
Name	Description
request	ListEnvironmentsRequest

Returns
Type	Description
ListEnvironmentsResponse

listUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest request)

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

listUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest request)

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

listWorkloads(ListWorkloadsRequest request)

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

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

pollAirflowCommand(PollAirflowCommandRequest request)

public PollAirflowCommandResponse pollAirflowCommand(PollAirflowCommandRequest request)

Polls Airflow CLI command execution and fetches logs.

Parameter
Name	Description
request	PollAirflowCommandRequest

Returns
Type	Description
PollAirflowCommandResponse

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

stopAirflowCommand(StopAirflowCommandRequest request)

public StopAirflowCommandResponse stopAirflowCommand(StopAirflowCommandRequest request)

Stops Airflow CLI command execution.

Parameter
Name	Description
request	StopAirflowCommandRequest

Returns
Type	Description
StopAirflowCommandResponse

updateEnvironment(UpdateEnvironmentRequest request)

public Operation updateEnvironment(UpdateEnvironmentRequest request)

Update an environment.

Parameter
Name	Description
request	UpdateEnvironmentRequest

Returns
Type	Description
Operation

updateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest request)

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

updateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest request)

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