Class EnvironmentsSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<EnvironmentsSettings>
com.google.cloud.orchestration.airflow.service.v1.EnvironmentsSettings
@Generated("by gapic-generator-java")
public class EnvironmentsSettings
extends ClientSettings<EnvironmentsSettings>
Settings class to configure an instance of
EnvironmentsClient.
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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getEnvironment:
// 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
EnvironmentsSettings.Builder environmentsSettingsBuilder = EnvironmentsSettings.newBuilder();
environmentsSettingsBuilder
.getEnvironmentSettings()
.setRetrySettings(
environmentsSettingsBuilder
.getEnvironmentSettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
EnvironmentsSettings environmentsSettings = environmentsSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createEnvironment:
// 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
EnvironmentsSettings.Builder environmentsSettingsBuilder = EnvironmentsSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
environmentsSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for EnvironmentsSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedEnvironmentsSettings(EnvironmentsSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to checkUpgrade.Returns the object with the settings used for calls to checkUpgrade.static final EnvironmentsSettingsReturns the object with the settings used for calls to createEnvironment.Returns the object with the settings used for calls to createEnvironment.Returns the object with the settings used for calls to createUserWorkloadsConfigMap.Returns the object with the settings used for calls to createUserWorkloadsSecret.Returns the object with the settings used for calls to databaseFailover.Returns the object with the settings used for calls to databaseFailover.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteEnvironmentRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteEnvironment.Returns the object with the settings used for calls to deleteEnvironment.UnaryCallSettings<DeleteUserWorkloadsConfigMapRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteUserWorkloadsConfigMap.UnaryCallSettings<DeleteUserWorkloadsSecretRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteUserWorkloadsSecret.Returns the object with the settings used for calls to executeAirflowCommand.Returns the object with the settings used for calls to fetchDatabaseProperties.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getEnvironment.Returns the object with the settings used for calls to getUserWorkloadsConfigMap.Returns the object with the settings used for calls to getUserWorkloadsSecret.PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse, EnvironmentsClient.ListEnvironmentsPagedResponse> Returns the object with the settings used for calls to listEnvironments.PagedCallSettings<ListUserWorkloadsConfigMapsRequest,ListUserWorkloadsConfigMapsResponse, EnvironmentsClient.ListUserWorkloadsConfigMapsPagedResponse> Returns the object with the settings used for calls to listUserWorkloadsConfigMaps.PagedCallSettings<ListUserWorkloadsSecretsRequest,ListUserWorkloadsSecretsResponse, EnvironmentsClient.ListUserWorkloadsSecretsPagedResponse> Returns the object with the settings used for calls to listUserWorkloadsSecrets.PagedCallSettings<ListWorkloadsRequest,ListWorkloadsResponse, EnvironmentsClient.ListWorkloadsPagedResponse> Returns the object with the settings used for calls to listWorkloads.Returns the object with the settings used for calls to loadSnapshot.Returns the object with the settings used for calls to loadSnapshot.static EnvironmentsSettings.BuilderReturns a new gRPC builder for this class.static EnvironmentsSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static EnvironmentsSettings.BuilderReturns a new REST builder for this class.Returns the object with the settings used for calls to pollAirflowCommand.Returns the object with the settings used for calls to saveSnapshot.Returns the object with the settings used for calls to saveSnapshot.Returns the object with the settings used for calls to stopAirflowCommand.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateEnvironment.Returns the object with the settings used for calls to updateEnvironment.Returns the object with the settings used for calls to updateUserWorkloadsConfigMap.Returns the object with the settings used for calls to updateUserWorkloadsSecret.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
EnvironmentsSettings
- Throws:
IOException
-
-
Method Details
-
createEnvironmentSettings
Returns the object with the settings used for calls to createEnvironment. -
createEnvironmentOperationSettings
public OperationCallSettings<CreateEnvironmentRequest,Environment, createEnvironmentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createEnvironment. -
getEnvironmentSettings
Returns the object with the settings used for calls to getEnvironment. -
listEnvironmentsSettings
public PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse, listEnvironmentsSettings()EnvironmentsClient.ListEnvironmentsPagedResponse> Returns the object with the settings used for calls to listEnvironments. -
updateEnvironmentSettings
Returns the object with the settings used for calls to updateEnvironment. -
updateEnvironmentOperationSettings
public OperationCallSettings<UpdateEnvironmentRequest,Environment, updateEnvironmentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateEnvironment. -
deleteEnvironmentSettings
Returns the object with the settings used for calls to deleteEnvironment. -
deleteEnvironmentOperationSettings
public OperationCallSettings<DeleteEnvironmentRequest,com.google.protobuf.Empty, deleteEnvironmentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteEnvironment. -
executeAirflowCommandSettings
public UnaryCallSettings<ExecuteAirflowCommandRequest,ExecuteAirflowCommandResponse> executeAirflowCommandSettings()Returns the object with the settings used for calls to executeAirflowCommand. -
stopAirflowCommandSettings
public UnaryCallSettings<StopAirflowCommandRequest,StopAirflowCommandResponse> stopAirflowCommandSettings()Returns the object with the settings used for calls to stopAirflowCommand. -
pollAirflowCommandSettings
public UnaryCallSettings<PollAirflowCommandRequest,PollAirflowCommandResponse> pollAirflowCommandSettings()Returns the object with the settings used for calls to pollAirflowCommand. -
listWorkloadsSettings
public PagedCallSettings<ListWorkloadsRequest,ListWorkloadsResponse, listWorkloadsSettings()EnvironmentsClient.ListWorkloadsPagedResponse> Returns the object with the settings used for calls to listWorkloads. -
checkUpgradeSettings
Returns the object with the settings used for calls to checkUpgrade. -
checkUpgradeOperationSettings
public OperationCallSettings<CheckUpgradeRequest,CheckUpgradeResponse, checkUpgradeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to checkUpgrade. -
createUserWorkloadsSecretSettings
public UnaryCallSettings<CreateUserWorkloadsSecretRequest,UserWorkloadsSecret> createUserWorkloadsSecretSettings()Returns the object with the settings used for calls to createUserWorkloadsSecret. -
getUserWorkloadsSecretSettings
public UnaryCallSettings<GetUserWorkloadsSecretRequest,UserWorkloadsSecret> getUserWorkloadsSecretSettings()Returns the object with the settings used for calls to getUserWorkloadsSecret. -
listUserWorkloadsSecretsSettings
public PagedCallSettings<ListUserWorkloadsSecretsRequest,ListUserWorkloadsSecretsResponse, listUserWorkloadsSecretsSettings()EnvironmentsClient.ListUserWorkloadsSecretsPagedResponse> Returns the object with the settings used for calls to listUserWorkloadsSecrets. -
updateUserWorkloadsSecretSettings
public UnaryCallSettings<UpdateUserWorkloadsSecretRequest,UserWorkloadsSecret> updateUserWorkloadsSecretSettings()Returns the object with the settings used for calls to updateUserWorkloadsSecret. -
deleteUserWorkloadsSecretSettings
public UnaryCallSettings<DeleteUserWorkloadsSecretRequest,com.google.protobuf.Empty> deleteUserWorkloadsSecretSettings()Returns the object with the settings used for calls to deleteUserWorkloadsSecret. -
createUserWorkloadsConfigMapSettings
public UnaryCallSettings<CreateUserWorkloadsConfigMapRequest,UserWorkloadsConfigMap> createUserWorkloadsConfigMapSettings()Returns the object with the settings used for calls to createUserWorkloadsConfigMap. -
getUserWorkloadsConfigMapSettings
public UnaryCallSettings<GetUserWorkloadsConfigMapRequest,UserWorkloadsConfigMap> getUserWorkloadsConfigMapSettings()Returns the object with the settings used for calls to getUserWorkloadsConfigMap. -
listUserWorkloadsConfigMapsSettings
public PagedCallSettings<ListUserWorkloadsConfigMapsRequest,ListUserWorkloadsConfigMapsResponse, listUserWorkloadsConfigMapsSettings()EnvironmentsClient.ListUserWorkloadsConfigMapsPagedResponse> Returns the object with the settings used for calls to listUserWorkloadsConfigMaps. -
updateUserWorkloadsConfigMapSettings
public UnaryCallSettings<UpdateUserWorkloadsConfigMapRequest,UserWorkloadsConfigMap> updateUserWorkloadsConfigMapSettings()Returns the object with the settings used for calls to updateUserWorkloadsConfigMap. -
deleteUserWorkloadsConfigMapSettings
public UnaryCallSettings<DeleteUserWorkloadsConfigMapRequest,com.google.protobuf.Empty> deleteUserWorkloadsConfigMapSettings()Returns the object with the settings used for calls to deleteUserWorkloadsConfigMap. -
saveSnapshotSettings
Returns the object with the settings used for calls to saveSnapshot. -
saveSnapshotOperationSettings
public OperationCallSettings<SaveSnapshotRequest,SaveSnapshotResponse, saveSnapshotOperationSettings()OperationMetadata> Returns the object with the settings used for calls to saveSnapshot. -
loadSnapshotSettings
Returns the object with the settings used for calls to loadSnapshot. -
loadSnapshotOperationSettings
public OperationCallSettings<LoadSnapshotRequest,LoadSnapshotResponse, loadSnapshotOperationSettings()OperationMetadata> Returns the object with the settings used for calls to loadSnapshot. -
databaseFailoverSettings
Returns the object with the settings used for calls to databaseFailover. -
databaseFailoverOperationSettings
public OperationCallSettings<DatabaseFailoverRequest,DatabaseFailoverResponse, databaseFailoverOperationSettings()OperationMetadata> Returns the object with the settings used for calls to databaseFailover. -
fetchDatabasePropertiesSettings
public UnaryCallSettings<FetchDatabasePropertiesRequest,FetchDatabasePropertiesResponse> fetchDatabasePropertiesSettings()Returns the object with the settings used for calls to fetchDatabaseProperties. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<EnvironmentsSettings>
-