Class EnvironmentsStubSettings (1.39.0)

public class EnvironmentsStubSettings extends 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();

Inheritance

java.lang.Object > StubSettings > EnvironmentsStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
`Builder`

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
`Builder`

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
Type	Description
`Builder`

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
Type	Description
`Builder`

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
`TransportChannelProvider`

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
`String`

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type	Description
`String`

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
`List<String>`

newBuilder()

public static EnvironmentsStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
`EnvironmentsStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static EnvironmentsStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`EnvironmentsStubSettings.Builder`

newHttpJsonBuilder()

public static EnvironmentsStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`EnvironmentsStubSettings.Builder`

Constructors

EnvironmentsStubSettings(EnvironmentsStubSettings.Builder settingsBuilder)

protected EnvironmentsStubSettings(EnvironmentsStubSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`EnvironmentsStubSettings.Builder`

Methods

createEnvironmentOperationSettings()

public OperationCallSettings<CreateEnvironmentRequest,Environment,OperationMetadata> createEnvironmentOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateEnvironmentRequest,Environment,OperationMetadata>`

createEnvironmentSettings()

public UnaryCallSettings<CreateEnvironmentRequest,Operation> createEnvironmentSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateEnvironmentRequest,Operation>`

createStub()

public EnvironmentsStub createStub()

Returns
Type	Description
`EnvironmentsStub`

Exceptions
Type	Description
`IOException`

createUserWorkloadsConfigMapSettings()

public UnaryCallSettings<CreateUserWorkloadsConfigMapRequest,UserWorkloadsConfigMap> createUserWorkloadsConfigMapSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateUserWorkloadsConfigMapRequest,UserWorkloadsConfigMap>`

createUserWorkloadsSecretSettings()

public UnaryCallSettings<CreateUserWorkloadsSecretRequest,UserWorkloadsSecret> createUserWorkloadsSecretSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateUserWorkloadsSecretRequest,UserWorkloadsSecret>`

databaseFailoverOperationSettings()

public OperationCallSettings<DatabaseFailoverRequest,DatabaseFailoverResponse,OperationMetadata> databaseFailoverOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DatabaseFailoverRequest,DatabaseFailoverResponse,OperationMetadata>`

databaseFailoverSettings()

public UnaryCallSettings<DatabaseFailoverRequest,Operation> databaseFailoverSettings()

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

Returns
Type	Description
`UnaryCallSettings<DatabaseFailoverRequest,Operation>`

deleteEnvironmentOperationSettings()

public OperationCallSettings<DeleteEnvironmentRequest,Empty,OperationMetadata> deleteEnvironmentOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteEnvironmentRequest,Empty,OperationMetadata>`

deleteEnvironmentSettings()

public UnaryCallSettings<DeleteEnvironmentRequest,Operation> deleteEnvironmentSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteEnvironmentRequest,Operation>`

deleteUserWorkloadsConfigMapSettings()

public UnaryCallSettings<DeleteUserWorkloadsConfigMapRequest,Empty> deleteUserWorkloadsConfigMapSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteUserWorkloadsConfigMapRequest,Empty>`

deleteUserWorkloadsSecretSettings()

public UnaryCallSettings<DeleteUserWorkloadsSecretRequest,Empty> deleteUserWorkloadsSecretSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteUserWorkloadsSecretRequest,Empty>`

executeAirflowCommandSettings()

public UnaryCallSettings<ExecuteAirflowCommandRequest,ExecuteAirflowCommandResponse> executeAirflowCommandSettings()

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

Returns
Type	Description
`UnaryCallSettings<ExecuteAirflowCommandRequest,ExecuteAirflowCommandResponse>`

fetchDatabasePropertiesSettings()

public UnaryCallSettings<FetchDatabasePropertiesRequest,FetchDatabasePropertiesResponse> fetchDatabasePropertiesSettings()

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

Returns
Type	Description
`UnaryCallSettings<FetchDatabasePropertiesRequest,FetchDatabasePropertiesResponse>`

getEndpoint()

public String getEndpoint()

Returns the endpoint set by the user or the the service's default endpoint.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getEndpoint()

getEnvironmentSettings()

public UnaryCallSettings<GetEnvironmentRequest,Environment> getEnvironmentSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetEnvironmentRequest,Environment>`

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getServiceName()

getUserWorkloadsConfigMapSettings()

public UnaryCallSettings<GetUserWorkloadsConfigMapRequest,UserWorkloadsConfigMap> getUserWorkloadsConfigMapSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetUserWorkloadsConfigMapRequest,UserWorkloadsConfigMap>`

getUserWorkloadsSecretSettings()

public UnaryCallSettings<GetUserWorkloadsSecretRequest,UserWorkloadsSecret> getUserWorkloadsSecretSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetUserWorkloadsSecretRequest,UserWorkloadsSecret>`

listEnvironmentsSettings()

public PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,EnvironmentsClient.ListEnvironmentsPagedResponse> listEnvironmentsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,ListEnvironmentsPagedResponse>`

listUserWorkloadsConfigMapsSettings()

public PagedCallSettings<ListUserWorkloadsConfigMapsRequest,ListUserWorkloadsConfigMapsResponse,EnvironmentsClient.ListUserWorkloadsConfigMapsPagedResponse> listUserWorkloadsConfigMapsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListUserWorkloadsConfigMapsRequest,ListUserWorkloadsConfigMapsResponse,ListUserWorkloadsConfigMapsPagedResponse>`

listUserWorkloadsSecretsSettings()

public PagedCallSettings<ListUserWorkloadsSecretsRequest,ListUserWorkloadsSecretsResponse,EnvironmentsClient.ListUserWorkloadsSecretsPagedResponse> listUserWorkloadsSecretsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListUserWorkloadsSecretsRequest,ListUserWorkloadsSecretsResponse,ListUserWorkloadsSecretsPagedResponse>`

listWorkloadsSettings()

public PagedCallSettings<ListWorkloadsRequest,ListWorkloadsResponse,EnvironmentsClient.ListWorkloadsPagedResponse> listWorkloadsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListWorkloadsRequest,ListWorkloadsResponse,ListWorkloadsPagedResponse>`

loadSnapshotOperationSettings()

public OperationCallSettings<LoadSnapshotRequest,LoadSnapshotResponse,OperationMetadata> loadSnapshotOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<LoadSnapshotRequest,LoadSnapshotResponse,OperationMetadata>`

loadSnapshotSettings()

public UnaryCallSettings<LoadSnapshotRequest,Operation> loadSnapshotSettings()

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

Returns
Type	Description
`UnaryCallSettings<LoadSnapshotRequest,Operation>`

pollAirflowCommandSettings()

public UnaryCallSettings<PollAirflowCommandRequest,PollAirflowCommandResponse> pollAirflowCommandSettings()

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

Returns
Type	Description
`UnaryCallSettings<PollAirflowCommandRequest,PollAirflowCommandResponse>`

saveSnapshotOperationSettings()

public OperationCallSettings<SaveSnapshotRequest,SaveSnapshotResponse,OperationMetadata> saveSnapshotOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<SaveSnapshotRequest,SaveSnapshotResponse,OperationMetadata>`

saveSnapshotSettings()

public UnaryCallSettings<SaveSnapshotRequest,Operation> saveSnapshotSettings()

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

Returns
Type	Description
`UnaryCallSettings<SaveSnapshotRequest,Operation>`

stopAirflowCommandSettings()

public UnaryCallSettings<StopAirflowCommandRequest,StopAirflowCommandResponse> stopAirflowCommandSettings()

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

Returns
Type	Description
`UnaryCallSettings<StopAirflowCommandRequest,StopAirflowCommandResponse>`

toBuilder()

public EnvironmentsStubSettings.Builder toBuilder()

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

Returns
Type	Description
`EnvironmentsStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

updateEnvironmentOperationSettings()

public OperationCallSettings<UpdateEnvironmentRequest,Environment,OperationMetadata> updateEnvironmentOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateEnvironmentRequest,Environment,OperationMetadata>`

updateEnvironmentSettings()

public UnaryCallSettings<UpdateEnvironmentRequest,Operation> updateEnvironmentSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateEnvironmentRequest,Operation>`

updateUserWorkloadsConfigMapSettings()

public UnaryCallSettings<UpdateUserWorkloadsConfigMapRequest,UserWorkloadsConfigMap> updateUserWorkloadsConfigMapSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateUserWorkloadsConfigMapRequest,UserWorkloadsConfigMap>`

updateUserWorkloadsSecretSettings()

public UnaryCallSettings<UpdateUserWorkloadsSecretRequest,UserWorkloadsSecret> updateUserWorkloadsSecretSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateUserWorkloadsSecretRequest,UserWorkloadsSecret>`