Class EnvironmentsGrpc.EnvironmentsBlockingV2Stub
java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractBlockingStub<EnvironmentsGrpc.EnvironmentsBlockingV2Stub>
com.google.cloud.orchestration.airflow.service.v1beta1.EnvironmentsGrpc.EnvironmentsBlockingV2Stub
- Enclosing class:
- EnvironmentsGrpc
public static final class EnvironmentsGrpc.EnvironmentsBlockingV2Stub
extends io.grpc.stub.AbstractBlockingStub<EnvironmentsGrpc.EnvironmentsBlockingV2Stub>
A stub to allow clients to do 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 TypeMethodDescriptionbuild(io.grpc.Channel channel, io.grpc.CallOptions callOptions) checkUpgrade(CheckUpgradeRequest request) Check if an upgrade operation on the environment will succeed.Create a new environment.Creates a user workloads ConfigMap.Creates a user workloads Secret.databaseFailover(DatabaseFailoverRequest request) Triggers database failover (only for highly resilient environments).Delete an environment.com.google.protobuf.EmptyDeletes a user workloads ConfigMap.com.google.protobuf.EmptyDeletes a user workloads Secret.Executes Airflow CLI command.Fetches database properties.getEnvironment(GetEnvironmentRequest request) Get an existing environment.Gets an existing user workloads ConfigMap.Gets an existing user workloads Secret.listEnvironments(ListEnvironmentsRequest request) List environments.Lists user workloads ConfigMaps.Lists user workloads Secrets.listWorkloads(ListWorkloadsRequest request) Lists workloads in a Cloud Composer environment.loadSnapshot(LoadSnapshotRequest request) Loads a snapshot of a Cloud Composer environment.Polls Airflow CLI command execution and fetches logs.restartWebServer(RestartWebServerRequest request) Restart Airflow web server.saveSnapshot(SaveSnapshotRequest request) Creates a snapshots of a Cloud Composer environment.Stops Airflow CLI command execution.Update an environment.Updates a user workloads ConfigMap.Updates a user workloads Secret.Methods inherited from class io.grpc.stub.AbstractBlockingStub
newStub, newStubMethods inherited from class io.grpc.stub.AbstractStub
getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady
-
Method Details
-
build
protected EnvironmentsGrpc.EnvironmentsBlockingV2Stub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions) - Specified by:
buildin classio.grpc.stub.AbstractStub<EnvironmentsGrpc.EnvironmentsBlockingV2Stub>
-
createEnvironment
Create a new environment.
- Throws:
io.grpc.StatusException
-
getEnvironment
Get an existing environment.
- Throws:
io.grpc.StatusException
-
listEnvironments
public ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest request) throws io.grpc.StatusException List environments.
- Throws:
io.grpc.StatusException
-
updateEnvironment
Update an environment.
- Throws:
io.grpc.StatusException
-
deleteEnvironment
Delete an environment.
- Throws:
io.grpc.StatusException
-
restartWebServer
Restart Airflow web server.
- Throws:
io.grpc.StatusException
-
checkUpgrade
Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.
- Throws:
io.grpc.StatusException
-
executeAirflowCommand
public ExecuteAirflowCommandResponse executeAirflowCommand(ExecuteAirflowCommandRequest request) throws io.grpc.StatusException Executes Airflow CLI command.
- Throws:
io.grpc.StatusException
-
stopAirflowCommand
public StopAirflowCommandResponse stopAirflowCommand(StopAirflowCommandRequest request) throws io.grpc.StatusException Stops Airflow CLI command execution.
- Throws:
io.grpc.StatusException
-
pollAirflowCommand
public PollAirflowCommandResponse pollAirflowCommand(PollAirflowCommandRequest request) throws io.grpc.StatusException Polls Airflow CLI command execution and fetches logs.
- Throws:
io.grpc.StatusException
-
listWorkloads
public ListWorkloadsResponse listWorkloads(ListWorkloadsRequest request) throws io.grpc.StatusException 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.
- Throws:
io.grpc.StatusException
-
createUserWorkloadsSecret
public UserWorkloadsSecret createUserWorkloadsSecret(CreateUserWorkloadsSecretRequest request) throws io.grpc.StatusException Creates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.
- Throws:
io.grpc.StatusException
-
getUserWorkloadsSecret
public UserWorkloadsSecret getUserWorkloadsSecret(GetUserWorkloadsSecretRequest request) throws io.grpc.StatusException 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.
- Throws:
io.grpc.StatusException
-
listUserWorkloadsSecrets
public ListUserWorkloadsSecretsResponse listUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest request) throws io.grpc.StatusException Lists user workloads Secrets. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.
- Throws:
io.grpc.StatusException
-
updateUserWorkloadsSecret
public UserWorkloadsSecret updateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest request) throws io.grpc.StatusException Updates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.
- Throws:
io.grpc.StatusException
-
deleteUserWorkloadsSecret
public com.google.protobuf.Empty deleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest request) throws io.grpc.StatusException Deletes a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.
- Throws:
io.grpc.StatusException
-
createUserWorkloadsConfigMap
public UserWorkloadsConfigMap createUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest request) throws io.grpc.StatusException Creates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.
- Throws:
io.grpc.StatusException
-
getUserWorkloadsConfigMap
public UserWorkloadsConfigMap getUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest request) throws io.grpc.StatusException Gets an existing user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.
- Throws:
io.grpc.StatusException
-
listUserWorkloadsConfigMaps
public ListUserWorkloadsConfigMapsResponse listUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest request) throws io.grpc.StatusException Lists user workloads ConfigMaps. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.
- Throws:
io.grpc.StatusException
-
updateUserWorkloadsConfigMap
public UserWorkloadsConfigMap updateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest request) throws io.grpc.StatusException Updates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.
- Throws:
io.grpc.StatusException
-
deleteUserWorkloadsConfigMap
public com.google.protobuf.Empty deleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest request) throws io.grpc.StatusException Deletes a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.
- Throws:
io.grpc.StatusException
-
saveSnapshot
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.
- Throws:
io.grpc.StatusException
-
loadSnapshot
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.
- Throws:
io.grpc.StatusException
-
databaseFailover
Triggers database failover (only for highly resilient environments).
- Throws:
io.grpc.StatusException
-
fetchDatabaseProperties
public FetchDatabasePropertiesResponse fetchDatabaseProperties(FetchDatabasePropertiesRequest request) throws io.grpc.StatusException Fetches database properties.
- Throws:
io.grpc.StatusException
-