Class OracleDatabaseSettings (0.4.0)

public class OracleDatabaseSettings extends ClientSettings<OracleDatabaseSettings>

Settings class to configure an instance of OracleDatabaseClient.

The default instance has everything set to sensible defaults:

The default service address (oracledatabase.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 of getCloudExadataInfrastructure:


 // 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
 OracleDatabaseSettings.Builder oracleDatabaseSettingsBuilder =
     OracleDatabaseSettings.newBuilder();
 oracleDatabaseSettingsBuilder
     .getCloudExadataInfrastructureSettings()
     .setRetrySettings(
         oracleDatabaseSettingsBuilder
             .getCloudExadataInfrastructureSettings()
             .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());
 OracleDatabaseSettings oracleDatabaseSettings = oracleDatabaseSettingsBuilder.build();

Please refer to the Client Side Retry Guide 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 createCloudExadataInfrastructure:


 // 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
 OracleDatabaseSettings.Builder oracleDatabaseSettingsBuilder =
     OracleDatabaseSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 oracleDatabaseSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > OracleDatabaseSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.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

create(OracleDatabaseStubSettings stub)

public static final OracleDatabaseSettings create(OracleDatabaseStubSettings stub)

Parameter
Name	Description
`stub`	`OracleDatabaseStubSettings`

Returns
Type	Description
`OracleDatabaseSettings`

Exceptions
Type	Description
`IOException`

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`

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default 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`

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
`List<String>`

newBuilder()

public static OracleDatabaseSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
`OracleDatabaseSettings.Builder`

newBuilder(ClientContext clientContext)

public static OracleDatabaseSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`OracleDatabaseSettings.Builder`

Constructors

OracleDatabaseSettings(OracleDatabaseSettings.Builder settingsBuilder)

protected OracleDatabaseSettings(OracleDatabaseSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`OracleDatabaseSettings.Builder`

Methods

createAutonomousDatabaseOperationSettings()

public OperationCallSettings<CreateAutonomousDatabaseRequest,AutonomousDatabase,OperationMetadata> createAutonomousDatabaseOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateAutonomousDatabaseRequest,AutonomousDatabase,OperationMetadata>`

createAutonomousDatabaseSettings()

public UnaryCallSettings<CreateAutonomousDatabaseRequest,Operation> createAutonomousDatabaseSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateAutonomousDatabaseRequest,Operation>`

createCloudExadataInfrastructureOperationSettings()

public OperationCallSettings<CreateCloudExadataInfrastructureRequest,CloudExadataInfrastructure,OperationMetadata> createCloudExadataInfrastructureOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateCloudExadataInfrastructureRequest,CloudExadataInfrastructure,OperationMetadata>`

createCloudExadataInfrastructureSettings()

public UnaryCallSettings<CreateCloudExadataInfrastructureRequest,Operation> createCloudExadataInfrastructureSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateCloudExadataInfrastructureRequest,Operation>`

createCloudVmClusterOperationSettings()

public OperationCallSettings<CreateCloudVmClusterRequest,CloudVmCluster,OperationMetadata> createCloudVmClusterOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateCloudVmClusterRequest,CloudVmCluster,OperationMetadata>`

createCloudVmClusterSettings()

public UnaryCallSettings<CreateCloudVmClusterRequest,Operation> createCloudVmClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateCloudVmClusterRequest,Operation>`

deleteAutonomousDatabaseOperationSettings()

public OperationCallSettings<DeleteAutonomousDatabaseRequest,Empty,OperationMetadata> deleteAutonomousDatabaseOperationSettings()

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

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

deleteAutonomousDatabaseSettings()

public UnaryCallSettings<DeleteAutonomousDatabaseRequest,Operation> deleteAutonomousDatabaseSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteAutonomousDatabaseRequest,Operation>`

deleteCloudExadataInfrastructureOperationSettings()

public OperationCallSettings<DeleteCloudExadataInfrastructureRequest,Empty,OperationMetadata> deleteCloudExadataInfrastructureOperationSettings()

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

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

deleteCloudExadataInfrastructureSettings()

public UnaryCallSettings<DeleteCloudExadataInfrastructureRequest,Operation> deleteCloudExadataInfrastructureSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteCloudExadataInfrastructureRequest,Operation>`

deleteCloudVmClusterOperationSettings()

public OperationCallSettings<DeleteCloudVmClusterRequest,Empty,OperationMetadata> deleteCloudVmClusterOperationSettings()

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

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

deleteCloudVmClusterSettings()

public UnaryCallSettings<DeleteCloudVmClusterRequest,Operation> deleteCloudVmClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteCloudVmClusterRequest,Operation>`

generateAutonomousDatabaseWalletSettings()

public UnaryCallSettings<GenerateAutonomousDatabaseWalletRequest,GenerateAutonomousDatabaseWalletResponse> generateAutonomousDatabaseWalletSettings()

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

Returns
Type	Description
`UnaryCallSettings<GenerateAutonomousDatabaseWalletRequest,GenerateAutonomousDatabaseWalletResponse>`

getAutonomousDatabaseSettings()

public UnaryCallSettings<GetAutonomousDatabaseRequest,AutonomousDatabase> getAutonomousDatabaseSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetAutonomousDatabaseRequest,AutonomousDatabase>`

getCloudExadataInfrastructureSettings()

public UnaryCallSettings<GetCloudExadataInfrastructureRequest,CloudExadataInfrastructure> getCloudExadataInfrastructureSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetCloudExadataInfrastructureRequest,CloudExadataInfrastructure>`

getCloudVmClusterSettings()

public UnaryCallSettings<GetCloudVmClusterRequest,CloudVmCluster> getCloudVmClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetCloudVmClusterRequest,CloudVmCluster>`

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

listAutonomousDatabaseBackupsSettings()

public PagedCallSettings<ListAutonomousDatabaseBackupsRequest,ListAutonomousDatabaseBackupsResponse,OracleDatabaseClient.ListAutonomousDatabaseBackupsPagedResponse> listAutonomousDatabaseBackupsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListAutonomousDatabaseBackupsRequest,ListAutonomousDatabaseBackupsResponse,ListAutonomousDatabaseBackupsPagedResponse>`

listAutonomousDatabaseCharacterSetsSettings()

public PagedCallSettings<ListAutonomousDatabaseCharacterSetsRequest,ListAutonomousDatabaseCharacterSetsResponse,OracleDatabaseClient.ListAutonomousDatabaseCharacterSetsPagedResponse> listAutonomousDatabaseCharacterSetsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListAutonomousDatabaseCharacterSetsRequest,ListAutonomousDatabaseCharacterSetsResponse,ListAutonomousDatabaseCharacterSetsPagedResponse>`

listAutonomousDatabasesSettings()

public PagedCallSettings<ListAutonomousDatabasesRequest,ListAutonomousDatabasesResponse,OracleDatabaseClient.ListAutonomousDatabasesPagedResponse> listAutonomousDatabasesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListAutonomousDatabasesRequest,ListAutonomousDatabasesResponse,ListAutonomousDatabasesPagedResponse>`

listAutonomousDbVersionsSettings()

public PagedCallSettings<ListAutonomousDbVersionsRequest,ListAutonomousDbVersionsResponse,OracleDatabaseClient.ListAutonomousDbVersionsPagedResponse> listAutonomousDbVersionsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListAutonomousDbVersionsRequest,ListAutonomousDbVersionsResponse,ListAutonomousDbVersionsPagedResponse>`

listCloudExadataInfrastructuresSettings()

public PagedCallSettings<ListCloudExadataInfrastructuresRequest,ListCloudExadataInfrastructuresResponse,OracleDatabaseClient.ListCloudExadataInfrastructuresPagedResponse> listCloudExadataInfrastructuresSettings()

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

Returns
Type	Description
`PagedCallSettings<ListCloudExadataInfrastructuresRequest,ListCloudExadataInfrastructuresResponse,ListCloudExadataInfrastructuresPagedResponse>`

listCloudVmClustersSettings()

public PagedCallSettings<ListCloudVmClustersRequest,ListCloudVmClustersResponse,OracleDatabaseClient.ListCloudVmClustersPagedResponse> listCloudVmClustersSettings()

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

Returns
Type	Description
`PagedCallSettings<ListCloudVmClustersRequest,ListCloudVmClustersResponse,ListCloudVmClustersPagedResponse>`

listDbNodesSettings()

public PagedCallSettings<ListDbNodesRequest,ListDbNodesResponse,OracleDatabaseClient.ListDbNodesPagedResponse> listDbNodesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListDbNodesRequest,ListDbNodesResponse,ListDbNodesPagedResponse>`

listDbServersSettings()

public PagedCallSettings<ListDbServersRequest,ListDbServersResponse,OracleDatabaseClient.ListDbServersPagedResponse> listDbServersSettings()

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

Returns
Type	Description
`PagedCallSettings<ListDbServersRequest,ListDbServersResponse,ListDbServersPagedResponse>`

listDbSystemShapesSettings()

public PagedCallSettings<ListDbSystemShapesRequest,ListDbSystemShapesResponse,OracleDatabaseClient.ListDbSystemShapesPagedResponse> listDbSystemShapesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListDbSystemShapesRequest,ListDbSystemShapesResponse,ListDbSystemShapesPagedResponse>`

listEntitlementsSettings()

public PagedCallSettings<ListEntitlementsRequest,ListEntitlementsResponse,OracleDatabaseClient.ListEntitlementsPagedResponse> listEntitlementsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListEntitlementsRequest,ListEntitlementsResponse,ListEntitlementsPagedResponse>`

listGiVersionsSettings()

public PagedCallSettings<ListGiVersionsRequest,ListGiVersionsResponse,OracleDatabaseClient.ListGiVersionsPagedResponse> listGiVersionsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListGiVersionsRequest,ListGiVersionsResponse,ListGiVersionsPagedResponse>`

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,OracleDatabaseClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type	Description
`PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>`

restoreAutonomousDatabaseOperationSettings()

public OperationCallSettings<RestoreAutonomousDatabaseRequest,AutonomousDatabase,OperationMetadata> restoreAutonomousDatabaseOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<RestoreAutonomousDatabaseRequest,AutonomousDatabase,OperationMetadata>`

restoreAutonomousDatabaseSettings()

public UnaryCallSettings<RestoreAutonomousDatabaseRequest,Operation> restoreAutonomousDatabaseSettings()

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

Returns
Type	Description
`UnaryCallSettings<RestoreAutonomousDatabaseRequest,Operation>`

toBuilder()

public OracleDatabaseSettings.Builder toBuilder()

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

Returns
Type	Description
`OracleDatabaseSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()