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

Class EnvironmentsStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<EnvironmentsStubSettings>

com.google.cloud.orchestration.airflow.service.v1beta1.stub.EnvironmentsStubSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class EnvironmentsStubSettings
extends com.google.api.gax.rpc.StubSettings<EnvironmentsStubSettings>

Settings class to configure an instance of EnvironmentsStub.

The default instance has everything set to sensible defaults:

• The default service address (composer.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getEnvironment to 30 seconds:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EnvironmentsStubSettings.Builder environmentsSettingsBuilder =
     EnvironmentsStubSettings.newBuilder();
 environmentsSettingsBuilder
     .getEnvironmentSettings()
     .setRetrySettings(
         environmentsSettingsBuilder
             .getEnvironmentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EnvironmentsStubSettings environmentsSettings = environmentsSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnvironmentsStubSettings.Builder Builder for EnvironmentsStubSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnvironmentsStubSettings(EnvironmentsStubSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.OperationCallSettings<CheckUpgradeRequest,CheckUpgradeResponse,OperationMetadata>	checkUpgradeOperationSettings() Returns the object with the settings used for calls to checkUpgrade.
com.google.api.gax.rpc.UnaryCallSettings<CheckUpgradeRequest,com.google.longrunning.Operation>	checkUpgradeSettings() Returns the object with the settings used for calls to checkUpgrade.
com.google.api.gax.rpc.OperationCallSettings<CreateEnvironmentRequest,Environment,OperationMetadata>	createEnvironmentOperationSettings() Returns the object with the settings used for calls to createEnvironment.
com.google.api.gax.rpc.UnaryCallSettings<CreateEnvironmentRequest,com.google.longrunning.Operation>	createEnvironmentSettings() Returns the object with the settings used for calls to createEnvironment.
EnvironmentsStub	createStub()
com.google.api.gax.rpc.OperationCallSettings<DatabaseFailoverRequest,DatabaseFailoverResponse,OperationMetadata>	databaseFailoverOperationSettings() Returns the object with the settings used for calls to databaseFailover.
com.google.api.gax.rpc.UnaryCallSettings<DatabaseFailoverRequest,com.google.longrunning.Operation>	databaseFailoverSettings() Returns the object with the settings used for calls to databaseFailover.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultGrpcApiClientHeaderProviderBuilder()
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultHttpJsonApiClientHeaderProviderBuilder()
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteEnvironmentRequest,com.google.protobuf.Empty,OperationMetadata>	deleteEnvironmentOperationSettings() Returns the object with the settings used for calls to deleteEnvironment.
com.google.api.gax.rpc.UnaryCallSettings<DeleteEnvironmentRequest,com.google.longrunning.Operation>	deleteEnvironmentSettings() Returns the object with the settings used for calls to deleteEnvironment.
com.google.api.gax.rpc.UnaryCallSettings<ExecuteAirflowCommandRequest,ExecuteAirflowCommandResponse>	executeAirflowCommandSettings() Returns the object with the settings used for calls to executeAirflowCommand.
com.google.api.gax.rpc.UnaryCallSettings<FetchDatabasePropertiesRequest,FetchDatabasePropertiesResponse>	fetchDatabasePropertiesSettings() Returns the object with the settings used for calls to fetchDatabaseProperties.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetEnvironmentRequest,Environment>	getEnvironmentSettings() Returns the object with the settings used for calls to getEnvironment.
com.google.api.gax.rpc.PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,EnvironmentsClient.ListEnvironmentsPagedResponse>	listEnvironmentsSettings() Returns the object with the settings used for calls to listEnvironments.
com.google.api.gax.rpc.OperationCallSettings<LoadSnapshotRequest,LoadSnapshotResponse,OperationMetadata>	loadSnapshotOperationSettings() Returns the object with the settings used for calls to loadSnapshot.
com.google.api.gax.rpc.UnaryCallSettings<LoadSnapshotRequest,com.google.longrunning.Operation>	loadSnapshotSettings() Returns the object with the settings used for calls to loadSnapshot.
static EnvironmentsStubSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static EnvironmentsStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static EnvironmentsStubSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<PollAirflowCommandRequest,PollAirflowCommandResponse>	pollAirflowCommandSettings() Returns the object with the settings used for calls to pollAirflowCommand.
com.google.api.gax.rpc.OperationCallSettings<RestartWebServerRequest,Environment,OperationMetadata>	restartWebServerOperationSettings() Returns the object with the settings used for calls to restartWebServer.
com.google.api.gax.rpc.UnaryCallSettings<RestartWebServerRequest,com.google.longrunning.Operation>	restartWebServerSettings() Returns the object with the settings used for calls to restartWebServer.
com.google.api.gax.rpc.OperationCallSettings<SaveSnapshotRequest,SaveSnapshotResponse,OperationMetadata>	saveSnapshotOperationSettings() Returns the object with the settings used for calls to saveSnapshot.
com.google.api.gax.rpc.UnaryCallSettings<SaveSnapshotRequest,com.google.longrunning.Operation>	saveSnapshotSettings() Returns the object with the settings used for calls to saveSnapshot.
com.google.api.gax.rpc.UnaryCallSettings<StopAirflowCommandRequest,StopAirflowCommandResponse>	stopAirflowCommandSettings() Returns the object with the settings used for calls to stopAirflowCommand.
EnvironmentsStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateEnvironmentRequest,Environment,OperationMetadata>	updateEnvironmentOperationSettings() Returns the object with the settings used for calls to updateEnvironment.
com.google.api.gax.rpc.UnaryCallSettings<UpdateEnvironmentRequest,com.google.longrunning.Operation>	updateEnvironmentSettings() Returns the object with the settings used for calls to updateEnvironment.

Methods inherited from class com.google.api.gax.rpc.StubSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentsStubSettings

protected EnvironmentsStubSettings(EnvironmentsStubSettings.Builder settingsBuilder)
                            throws IOException

Throws:

IOException

Method Detail

createEnvironmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateEnvironmentRequest,com.google.longrunning.Operation> createEnvironmentSettings()

Returns the object with the settings used for calls to createEnvironment.

createEnvironmentOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateEnvironmentRequest,Environment,OperationMetadata> createEnvironmentOperationSettings()

Returns the object with the settings used for calls to createEnvironment.

getEnvironmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetEnvironmentRequest,Environment> getEnvironmentSettings()

Returns the object with the settings used for calls to getEnvironment.

listEnvironmentsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,EnvironmentsClient.ListEnvironmentsPagedResponse> listEnvironmentsSettings()

Returns the object with the settings used for calls to listEnvironments.

updateEnvironmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateEnvironmentRequest,com.google.longrunning.Operation> updateEnvironmentSettings()

Returns the object with the settings used for calls to updateEnvironment.

updateEnvironmentOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateEnvironmentRequest,Environment,OperationMetadata> updateEnvironmentOperationSettings()

Returns the object with the settings used for calls to updateEnvironment.

deleteEnvironmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteEnvironmentRequest,com.google.longrunning.Operation> deleteEnvironmentSettings()

Returns the object with the settings used for calls to deleteEnvironment.

deleteEnvironmentOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteEnvironmentRequest,com.google.protobuf.Empty,OperationMetadata> deleteEnvironmentOperationSettings()

Returns the object with the settings used for calls to deleteEnvironment.

restartWebServerSettings

public com.google.api.gax.rpc.UnaryCallSettings<RestartWebServerRequest,com.google.longrunning.Operation> restartWebServerSettings()

Returns the object with the settings used for calls to restartWebServer.

restartWebServerOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<RestartWebServerRequest,Environment,OperationMetadata> restartWebServerOperationSettings()

Returns the object with the settings used for calls to restartWebServer.

checkUpgradeSettings

public com.google.api.gax.rpc.UnaryCallSettings<CheckUpgradeRequest,com.google.longrunning.Operation> checkUpgradeSettings()

Returns the object with the settings used for calls to checkUpgrade.

checkUpgradeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CheckUpgradeRequest,CheckUpgradeResponse,OperationMetadata> checkUpgradeOperationSettings()

Returns the object with the settings used for calls to checkUpgrade.

executeAirflowCommandSettings

public com.google.api.gax.rpc.UnaryCallSettings<ExecuteAirflowCommandRequest,ExecuteAirflowCommandResponse> executeAirflowCommandSettings()

Returns the object with the settings used for calls to executeAirflowCommand.

stopAirflowCommandSettings

public com.google.api.gax.rpc.UnaryCallSettings<StopAirflowCommandRequest,StopAirflowCommandResponse> stopAirflowCommandSettings()

Returns the object with the settings used for calls to stopAirflowCommand.

pollAirflowCommandSettings

public com.google.api.gax.rpc.UnaryCallSettings<PollAirflowCommandRequest,PollAirflowCommandResponse> pollAirflowCommandSettings()

Returns the object with the settings used for calls to pollAirflowCommand.

saveSnapshotSettings

public com.google.api.gax.rpc.UnaryCallSettings<SaveSnapshotRequest,com.google.longrunning.Operation> saveSnapshotSettings()

Returns the object with the settings used for calls to saveSnapshot.

saveSnapshotOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SaveSnapshotRequest,SaveSnapshotResponse,OperationMetadata> saveSnapshotOperationSettings()

Returns the object with the settings used for calls to saveSnapshot.

loadSnapshotSettings

public com.google.api.gax.rpc.UnaryCallSettings<LoadSnapshotRequest,com.google.longrunning.Operation> loadSnapshotSettings()

Returns the object with the settings used for calls to loadSnapshot.

loadSnapshotOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<LoadSnapshotRequest,LoadSnapshotResponse,OperationMetadata> loadSnapshotOperationSettings()

Returns the object with the settings used for calls to loadSnapshot.

databaseFailoverSettings

public com.google.api.gax.rpc.UnaryCallSettings<DatabaseFailoverRequest,com.google.longrunning.Operation> databaseFailoverSettings()

Returns the object with the settings used for calls to databaseFailover.

databaseFailoverOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DatabaseFailoverRequest,DatabaseFailoverResponse,OperationMetadata> databaseFailoverOperationSettings()

Returns the object with the settings used for calls to databaseFailover.

fetchDatabasePropertiesSettings

public com.google.api.gax.rpc.UnaryCallSettings<FetchDatabasePropertiesRequest,FetchDatabasePropertiesResponse> fetchDatabasePropertiesSettings()

Returns the object with the settings used for calls to fetchDatabaseProperties.

createStub

public EnvironmentsStub createStub()
                            throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultGrpcApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

defaultHttpJsonApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static EnvironmentsStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static EnvironmentsStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static EnvironmentsStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public EnvironmentsStubSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<EnvironmentsStubSettings>