Class DatabaseToolsRuntimeClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.databasetoolsruntime.DatabaseToolsRuntimeClient
-
- All Implemented Interfaces:
DatabaseToolsRuntime,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20230222") public class DatabaseToolsRuntimeClient extends BaseSyncClient implements DatabaseToolsRuntime
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDatabaseToolsRuntimeClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for DatabaseToolsRuntime.
-
Constructor Summary
Constructors Constructor Description DatabaseToolsRuntimeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.DatabaseToolsRuntimeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.DatabaseToolsRuntimeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DatabaseToolsRuntimeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DatabaseToolsRuntimeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.DatabaseToolsRuntimeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.DatabaseToolsRuntimeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.DatabaseToolsRuntimeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.databasetoolsruntime.DatabaseToolsRuntime
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DatabaseToolsRuntimeClient
@Deprecated public DatabaseToolsRuntimeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseToolsRuntimeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
DatabaseToolsRuntimeClient
@Deprecated public DatabaseToolsRuntimeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseToolsRuntimeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
DatabaseToolsRuntimeClient
@Deprecated public DatabaseToolsRuntimeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseToolsRuntimeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DatabaseToolsRuntimeClient
@Deprecated public DatabaseToolsRuntimeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseToolsRuntimeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
DatabaseToolsRuntimeClient
@Deprecated public DatabaseToolsRuntimeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseToolsRuntimeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
DatabaseToolsRuntimeClient
@Deprecated public DatabaseToolsRuntimeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseToolsRuntimeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
DatabaseToolsRuntimeClient
@Deprecated public DatabaseToolsRuntimeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseToolsRuntimeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
DatabaseToolsRuntimeClient
@Deprecated public DatabaseToolsRuntimeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseToolsRuntimeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-DatabaseToolsRuntimeClient.Builder.executorService
-
-
Method Detail
-
builder
public static DatabaseToolsRuntimeClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DatabaseToolsRuntimeSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceDatabaseToolsRuntime- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DatabaseToolsRuntimeSets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)and then callsetEndpoint.- Specified by:
setRegionin interfaceDatabaseToolsRuntime- Parameters:
regionId- The public region ID.
-
cancelWorkRequest
public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
Description copied from interface:DatabaseToolsRuntimeAttempts to cancel the specified work request.- Specified by:
cancelWorkRequestin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createCredential
public CreateCredentialResponse createCredential(CreateCredentialRequest request)
Description copied from interface:DatabaseToolsRuntimeCreates a credential for the user specified by the key.- Specified by:
createCredentialin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createCredentialExecuteGrantee
public CreateCredentialExecuteGranteeResponse createCredentialExecuteGrantee(CreateCredentialExecuteGranteeRequest request)
Description copied from interface:DatabaseToolsRuntimeGrants the EXECUTE privilege on the credential to the user specified by the key.- Specified by:
createCredentialExecuteGranteein interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createCredentialPublicSynonym
public CreateCredentialPublicSynonymResponse createCredentialPublicSynonym(CreateCredentialPublicSynonymRequest request)
Description copied from interface:DatabaseToolsRuntimeCreates a public synonym for the given credentials- Specified by:
createCredentialPublicSynonymin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDatabaseToolsDatabaseApiGatewayConfigPool
public CreateDatabaseToolsDatabaseApiGatewayConfigPoolResponse createDatabaseToolsDatabaseApiGatewayConfigPool(CreateDatabaseToolsDatabaseApiGatewayConfigPoolRequest request)
Description copied from interface:DatabaseToolsRuntimeCreate a Database Tools database API gateway config pool resource- Specified by:
createDatabaseToolsDatabaseApiGatewayConfigPoolin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec
public CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecResponse createDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec(CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecRequest request)
Description copied from interface:DatabaseToolsRuntimeCreate a Database Tools database API gateway config API spec resource- Specified by:
createDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec
public CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResponse createDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRequest request)
Description copied from interface:DatabaseToolsRuntimeCreate a Database Tools database API gateway config auto API spec resource- Specified by:
createDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteCredential
public DeleteCredentialResponse deleteCredential(DeleteCredentialRequest request)
Description copied from interface:DatabaseToolsRuntimeDelete credential- Specified by:
deleteCredentialin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteCredentialExecuteGrantee
public DeleteCredentialExecuteGranteeResponse deleteCredentialExecuteGrantee(DeleteCredentialExecuteGranteeRequest request)
Description copied from interface:DatabaseToolsRuntimeDelete execute grantee- Specified by:
deleteCredentialExecuteGranteein interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteCredentialPublicSynonym
public DeleteCredentialPublicSynonymResponse deleteCredentialPublicSynonym(DeleteCredentialPublicSynonymRequest request)
Description copied from interface:DatabaseToolsRuntimeDeletes the public synonym- Specified by:
deleteCredentialPublicSynonymin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDatabaseToolsDatabaseApiGatewayConfigPool
public DeleteDatabaseToolsDatabaseApiGatewayConfigPoolResponse deleteDatabaseToolsDatabaseApiGatewayConfigPool(DeleteDatabaseToolsDatabaseApiGatewayConfigPoolRequest request)
Description copied from interface:DatabaseToolsRuntimeDeletes the specified Database Tools database API gateway config pool resource.- Specified by:
deleteDatabaseToolsDatabaseApiGatewayConfigPoolin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec
public DeleteDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecResponse deleteDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec(DeleteDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecRequest request)
Description copied from interface:DatabaseToolsRuntimeDeletes the specified Database Tools database API gateway config API spec resource.- Specified by:
deleteDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec
public DeleteDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResponse deleteDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(DeleteDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRequest request)
Description copied from interface:DatabaseToolsRuntimeDeletes the specified Database Tools database API gateway config auto API spec resource.- Specified by:
deleteDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
executeSqlDatabaseToolsConnection
public ExecuteSqlDatabaseToolsConnectionResponse executeSqlDatabaseToolsConnection(ExecuteSqlDatabaseToolsConnectionRequest request)
Description copied from interface:DatabaseToolsRuntimeExecute statements on a database tools connection.- Specified by:
executeSqlDatabaseToolsConnectionin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCredential
public GetCredentialResponse getCredential(GetCredentialRequest request)
Description copied from interface:DatabaseToolsRuntimeGet a credential- Specified by:
getCredentialin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCredentialExecuteGrantee
public GetCredentialExecuteGranteeResponse getCredentialExecuteGrantee(GetCredentialExecuteGranteeRequest request)
Description copied from interface:DatabaseToolsRuntimeGet a credential execute grantee- Specified by:
getCredentialExecuteGranteein interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCredentialPublicSynonym
public GetCredentialPublicSynonymResponse getCredentialPublicSynonym(GetCredentialPublicSynonymRequest request)
Description copied from interface:DatabaseToolsRuntimeGet a public synonym- Specified by:
getCredentialPublicSynonymin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDatabaseToolsDatabaseApiGatewayConfigContent
public GetDatabaseToolsDatabaseApiGatewayConfigContentResponse getDatabaseToolsDatabaseApiGatewayConfigContent(GetDatabaseToolsDatabaseApiGatewayConfigContentRequest request)
Description copied from interface:DatabaseToolsRuntimeGet the content of a Database Tools database API gateway config- Specified by:
getDatabaseToolsDatabaseApiGatewayConfigContentin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDatabaseToolsDatabaseApiGatewayConfigGlobal
public GetDatabaseToolsDatabaseApiGatewayConfigGlobalResponse getDatabaseToolsDatabaseApiGatewayConfigGlobal(GetDatabaseToolsDatabaseApiGatewayConfigGlobalRequest request)
Description copied from interface:DatabaseToolsRuntimeGet a Database Tools database API gateway config global resource- Specified by:
getDatabaseToolsDatabaseApiGatewayConfigGlobalin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDatabaseToolsDatabaseApiGatewayConfigPool
public GetDatabaseToolsDatabaseApiGatewayConfigPoolResponse getDatabaseToolsDatabaseApiGatewayConfigPool(GetDatabaseToolsDatabaseApiGatewayConfigPoolRequest request)
Description copied from interface:DatabaseToolsRuntimeGet a Database Tools database API gateway config pool resource- Specified by:
getDatabaseToolsDatabaseApiGatewayConfigPoolin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec
public GetDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecResponse getDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec(GetDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecRequest request)
Description copied from interface:DatabaseToolsRuntimeGet a Database Tools database API gateway config API spec resource- Specified by:
getDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec
public GetDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResponse getDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(GetDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRequest request)
Description copied from interface:DatabaseToolsRuntimeGet a Database Tools database API gateway config auto API spec resource- Specified by:
getDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPropertySet
public GetPropertySetResponse getPropertySet(GetPropertySetRequest request)
Description copied from interface:DatabaseToolsRuntimeGet a property set- Specified by:
getPropertySetin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getUserCredential
public GetUserCredentialResponse getUserCredential(GetUserCredentialRequest request)
Description copied from interface:DatabaseToolsRuntimeGet a user credential- Specified by:
getUserCredentialin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:DatabaseToolsRuntimeGets the status of the specified work request.- Specified by:
getWorkRequestin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCredentialExecuteGrantees
public ListCredentialExecuteGranteesResponse listCredentialExecuteGrantees(ListCredentialExecuteGranteesRequest request)
Description copied from interface:DatabaseToolsRuntimeGet a list of all execute grantees- Specified by:
listCredentialExecuteGranteesin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCredentialPublicSynonyms
public ListCredentialPublicSynonymsResponse listCredentialPublicSynonyms(ListCredentialPublicSynonymsRequest request)
Description copied from interface:DatabaseToolsRuntimeGet a list of all public synonyms for the given credential- Specified by:
listCredentialPublicSynonymsin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCredentials
public ListCredentialsResponse listCredentials(ListCredentialsRequest request)
Description copied from interface:DatabaseToolsRuntimeReturns a paginated list ofCredentialSummaryfor the specified request.- Specified by:
listCredentialsin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDatabaseToolsDatabaseApiGatewayConfigAdvancedProperties
public ListDatabaseToolsDatabaseApiGatewayConfigAdvancedPropertiesResponse listDatabaseToolsDatabaseApiGatewayConfigAdvancedProperties(ListDatabaseToolsDatabaseApiGatewayConfigAdvancedPropertiesRequest request)
Description copied from interface:DatabaseToolsRuntimeReturns list of database API gateway config setting descriptions to be provided as advanced properties.- Specified by:
listDatabaseToolsDatabaseApiGatewayConfigAdvancedPropertiesin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecs
public ListDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsResponse listDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecs(ListDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsRequest request)
Description copied from interface:DatabaseToolsRuntimeReturns a list of Database Tools database API gateway config API spec resources- Specified by:
listDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecs
public ListDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsResponse listDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecs(ListDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsRequest request)
Description copied from interface:DatabaseToolsRuntimeReturns a list of Database Tools database API gateway config auto API spec resources- Specified by:
listDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDatabaseToolsDatabaseApiGatewayConfigPools
public ListDatabaseToolsDatabaseApiGatewayConfigPoolsResponse listDatabaseToolsDatabaseApiGatewayConfigPools(ListDatabaseToolsDatabaseApiGatewayConfigPoolsRequest request)
Description copied from interface:DatabaseToolsRuntimeReturns a list of Database Tools database API gateway config pool resources- Specified by:
listDatabaseToolsDatabaseApiGatewayConfigPoolsin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listUserCredentials
public ListUserCredentialsResponse listUserCredentials(ListUserCredentialsRequest request)
Description copied from interface:DatabaseToolsRuntimeReturns a paginated list of userUserCredentialSummaryfor the specified request.- Specified by:
listUserCredentialsin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:DatabaseToolsRuntimeReturns a paginated list of errors for the specified work request.- Specified by:
listWorkRequestErrorsin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:DatabaseToolsRuntimeReturns a paginated list of logs for the specified work request.- Specified by:
listWorkRequestLogsin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:DatabaseToolsRuntimeLists the work requests in a compartment.- Specified by:
listWorkRequestsin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateCredential
public UpdateCredentialResponse updateCredential(UpdateCredentialRequest request)
Description copied from interface:DatabaseToolsRuntimeUpdate a credential- Specified by:
updateCredentialin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDatabaseToolsDatabaseApiGatewayConfigGlobal
public UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalResponse updateDatabaseToolsDatabaseApiGatewayConfigGlobal(UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalRequest request)
Description copied from interface:DatabaseToolsRuntimeUpdate a Database Tools database API gateway config global resource- Specified by:
updateDatabaseToolsDatabaseApiGatewayConfigGlobalin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDatabaseToolsDatabaseApiGatewayConfigPool
public UpdateDatabaseToolsDatabaseApiGatewayConfigPoolResponse updateDatabaseToolsDatabaseApiGatewayConfigPool(UpdateDatabaseToolsDatabaseApiGatewayConfigPoolRequest request)
Description copied from interface:DatabaseToolsRuntimeUpdate a Database Tools database API gateway config pool resource- Specified by:
updateDatabaseToolsDatabaseApiGatewayConfigPoolin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec
public UpdateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecResponse updateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec(UpdateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecRequest request)
Description copied from interface:DatabaseToolsRuntimeUpdate a Database Tools database API gateway config API spec resource- Specified by:
updateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec
public UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecResponse updateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec(UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecRequest request)
Description copied from interface:DatabaseToolsRuntimeUpdate a Database Tools database API gateway config auto API spec resource- Specified by:
updateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updatePropertySet
public UpdatePropertySetResponse updatePropertySet(UpdatePropertySetRequest request)
Description copied from interface:DatabaseToolsRuntimeUpdate a property set- Specified by:
updatePropertySetin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateDatabaseToolsConnection
public ValidateDatabaseToolsConnectionResponse validateDatabaseToolsConnection(ValidateDatabaseToolsConnectionRequest request)
Description copied from interface:DatabaseToolsRuntimeValidates the specified Database Tools connection.- Specified by:
validateDatabaseToolsConnectionin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateDatabaseToolsIdentityCredential
public ValidateDatabaseToolsIdentityCredentialResponse validateDatabaseToolsIdentityCredential(ValidateDatabaseToolsIdentityCredentialRequest request)
Description copied from interface:DatabaseToolsRuntimeValidates the Database Tools identity credentials by establishing a connection to the customer database and executing the dbms_cloud.send_request to validate the credential.- Specified by:
validateDatabaseToolsIdentityCredentialin interfaceDatabaseToolsRuntime- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public DatabaseToolsRuntimeWaiters getWaiters()
Description copied from interface:DatabaseToolsRuntimeGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceDatabaseToolsRuntime- Returns:
- The service waiters.
-
getPaginators
public DatabaseToolsRuntimePaginators getPaginators()
Description copied from interface:DatabaseToolsRuntimeGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceDatabaseToolsRuntime- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-