Package com.google.cloud.orchestration.airflow.service.v1beta1

Class EnvironmentsGrpc.EnvironmentsBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<EnvironmentsGrpc.EnvironmentsBlockingStub>

com.google.cloud.orchestration.airflow.service.v1beta1.EnvironmentsGrpc.EnvironmentsBlockingStub

Enclosing class:

EnvironmentsGrpc

public static final class EnvironmentsGrpc.EnvironmentsBlockingStub
extends io.grpc.stub.AbstractBlockingStub<EnvironmentsGrpc.EnvironmentsBlockingStub>

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

 Managed Apache Airflow Environments.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
protected EnvironmentsGrpc.EnvironmentsBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
Operation	checkUpgrade(CheckUpgradeRequest request)	Check if an upgrade operation on the environment will succeed.
Operation	createEnvironment(CreateEnvironmentRequest request)	Create a new environment.
UserWorkloadsConfigMap	createUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest request)	Creates a user workloads ConfigMap.
UserWorkloadsSecret	createUserWorkloadsSecret(CreateUserWorkloadsSecretRequest request)	Creates a user workloads Secret.
Operation	databaseFailover(DatabaseFailoverRequest request)	Triggers database failover (only for highly resilient environments).
Operation	deleteEnvironment(DeleteEnvironmentRequest request)	Delete an environment.
com.google.protobuf.Empty	deleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest request)	Deletes a user workloads ConfigMap.
com.google.protobuf.Empty	deleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest request)	Deletes a user workloads Secret.
ExecuteAirflowCommandResponse	executeAirflowCommand(ExecuteAirflowCommandRequest request)	Executes Airflow CLI command.
FetchDatabasePropertiesResponse	fetchDatabaseProperties(FetchDatabasePropertiesRequest request)	Fetches database properties.
Environment	getEnvironment(GetEnvironmentRequest request)	Get an existing environment.
UserWorkloadsConfigMap	getUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest request)	Gets an existing user workloads ConfigMap.
UserWorkloadsSecret	getUserWorkloadsSecret(GetUserWorkloadsSecretRequest request)	Gets an existing user workloads Secret.
ListEnvironmentsResponse	listEnvironments(ListEnvironmentsRequest request)	List environments.
ListUserWorkloadsConfigMapsResponse	listUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest request)	Lists user workloads ConfigMaps.
ListUserWorkloadsSecretsResponse	listUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest request)	Lists user workloads Secrets.
ListWorkloadsResponse	listWorkloads(ListWorkloadsRequest request)	Lists workloads in a Cloud Composer environment.
Operation	loadSnapshot(LoadSnapshotRequest request)	Loads a snapshot of a Cloud Composer environment.
PollAirflowCommandResponse	pollAirflowCommand(PollAirflowCommandRequest request)	Polls Airflow CLI command execution and fetches logs.
Operation	restartWebServer(RestartWebServerRequest request)	Restart Airflow web server.
Operation	saveSnapshot(SaveSnapshotRequest request)	Creates a snapshots of a Cloud Composer environment.
StopAirflowCommandResponse	stopAirflowCommand(StopAirflowCommandRequest request)	Stops Airflow CLI command execution.
Operation	updateEnvironment(UpdateEnvironmentRequest request)	Update an environment.
UserWorkloadsConfigMap	updateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest request)	Updates a user workloads ConfigMap.
UserWorkloadsSecret	updateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest request)	Updates a user workloads Secret.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

build

protected EnvironmentsGrpc.EnvironmentsBlockingStub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<EnvironmentsGrpc.EnvironmentsBlockingStub>

createEnvironment

public Operation createEnvironment(CreateEnvironmentRequest request)

 Create a new environment.
 

getEnvironment

public Environment getEnvironment(GetEnvironmentRequest request)

 Get an existing environment.
 

listEnvironments

public ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest request)

 List environments.
 

updateEnvironment

public Operation updateEnvironment(UpdateEnvironmentRequest request)

 Update an environment.
 

deleteEnvironment

public Operation deleteEnvironment(DeleteEnvironmentRequest request)

 Delete an environment.
 

restartWebServer

public Operation restartWebServer(RestartWebServerRequest request)

 Restart Airflow web server.
 

checkUpgrade

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.
 

executeAirflowCommand

public ExecuteAirflowCommandResponse executeAirflowCommand(ExecuteAirflowCommandRequest request)

 Executes Airflow CLI command.
 

stopAirflowCommand

public StopAirflowCommandResponse stopAirflowCommand(StopAirflowCommandRequest request)

 Stops Airflow CLI command execution.
 

pollAirflowCommand

public PollAirflowCommandResponse pollAirflowCommand(PollAirflowCommandRequest request)

 Polls Airflow CLI command execution and fetches logs.
 

listWorkloads

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-2.*.*-airflow-*.*.* and newer.
 

createUserWorkloadsSecret

public UserWorkloadsSecret createUserWorkloadsSecret(CreateUserWorkloadsSecretRequest request)

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

getUserWorkloadsSecret

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-*.*.*-build.* and newer.
 

listUserWorkloadsSecrets

public ListUserWorkloadsSecretsResponse listUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest request)

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

updateUserWorkloadsSecret

public UserWorkloadsSecret updateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest request)

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

deleteUserWorkloadsSecret

public com.google.protobuf.Empty deleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest request)

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

createUserWorkloadsConfigMap

public UserWorkloadsConfigMap createUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest request)

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

getUserWorkloadsConfigMap

public UserWorkloadsConfigMap getUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest request)

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

listUserWorkloadsConfigMaps

public ListUserWorkloadsConfigMapsResponse listUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest request)

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

updateUserWorkloadsConfigMap

public UserWorkloadsConfigMap updateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest request)

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

deleteUserWorkloadsConfigMap

public com.google.protobuf.Empty deleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest request)

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

saveSnapshot

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.
 

loadSnapshot

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.
 

databaseFailover

public Operation databaseFailover(DatabaseFailoverRequest request)

 Triggers database failover (only for highly resilient environments).
 

fetchDatabaseProperties

public FetchDatabasePropertiesResponse fetchDatabaseProperties(FetchDatabasePropertiesRequest request)

 Fetches database properties.