Class DbLifeCycleManagementClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.dblm.DbLifeCycleManagementClient
-
- All Implemented Interfaces:
DbLifeCycleManagement,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20240102") public class DbLifeCycleManagementClient extends BaseSyncClient implements DbLifeCycleManagement
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDbLifeCycleManagementClient.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 DbLifeCycleManagement.
-
Constructor Summary
Constructors Constructor Description DbLifeCycleManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.DbLifeCycleManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.DbLifeCycleManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DbLifeCycleManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DbLifeCycleManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.DbLifeCycleManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.DbLifeCycleManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.DbLifeCycleManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DbLifeCycleManagementClient.Builderbuilder()Create a builder for this client.voidclose()CreateVulnerabilityScanResponsecreateVulnerabilityScan(CreateVulnerabilityScanRequest request)Creates a VulnerabilityScan.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.DbLifeCycleManagementPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetPatchManagementResponsegetPatchManagement(GetPatchManagementRequest request)Overview of Patch Management.StringgetResolvedEndpoint(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.GetVulnerabilityResponsegetVulnerability(GetVulnerabilityRequest request)Gets a VulnerabilityGetVulnerabilityScanResponsegetVulnerabilityScan(GetVulnerabilityScanRequest request)Gets information about a VulnerabilityScan.DbLifeCycleManagementWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponsegetWorkRequest(GetWorkRequestRequest request)Gets details of the work request with the given ID.ListAggregatedVulnerabilityDataResponselistAggregatedVulnerabilityData(ListAggregatedVulnerabilityDataRequest request)Gets an AggregatedVulnerabilityDataListDatabasesResponselistDatabases(ListDatabasesRequest request)Gets the list of databasesListNotificationsResponselistNotifications(ListNotificationsRequest request)List of notificationsListVulnerabilitiesResponselistVulnerabilities(ListVulnerabilitiesRequest request)Gets the vulnerabilities summary listListVulnerabilityResourcesResponselistVulnerabilityResources(ListVulnerabilityResourcesRequest request)Lists the summary of vulnerable and clean resourceesListVulnerabilityScansResponselistVulnerabilityScans(ListVulnerabilityScansRequest request)Gets a list of VulnerabilityScans.ListWorkRequestErrorsResponselistWorkRequestErrors(ListWorkRequestErrorsRequest request)Returns a (paginated) list of errors for the work request with the given ID.ListWorkRequestLogsResponselistWorkRequestLogs(ListWorkRequestLogsRequest request)Returns a (paginated) list of logs for the work request with the given ID.ListWorkRequestsResponselistWorkRequests(ListWorkRequestsRequest request)Lists the work requests in a compartment.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).voiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.-
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.dblm.DbLifeCycleManagement
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DbLifeCycleManagementClient
@Deprecated public DbLifeCycleManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDbLifeCycleManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
DbLifeCycleManagementClient
@Deprecated public DbLifeCycleManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDbLifeCycleManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
DbLifeCycleManagementClient
@Deprecated public DbLifeCycleManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDbLifeCycleManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DbLifeCycleManagementClient
@Deprecated public DbLifeCycleManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDbLifeCycleManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
DbLifeCycleManagementClient
@Deprecated public DbLifeCycleManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDbLifeCycleManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
DbLifeCycleManagementClient
@Deprecated public DbLifeCycleManagementClient(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 (seeDbLifeCycleManagementClient.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)
-
DbLifeCycleManagementClient
@Deprecated public DbLifeCycleManagementClient(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 (seeDbLifeCycleManagementClient.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
-
DbLifeCycleManagementClient
@Deprecated public DbLifeCycleManagementClient(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 (seeDbLifeCycleManagementClient.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-DbLifeCycleManagementClient.Builder.executorService
-
-
Method Detail
-
builder
public static DbLifeCycleManagementClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DbLifeCycleManagementSets 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 interfaceDbLifeCycleManagement- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DbLifeCycleManagementSets 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 interfaceDbLifeCycleManagement- Parameters:
regionId- The public region ID.
-
createVulnerabilityScan
public CreateVulnerabilityScanResponse createVulnerabilityScan(CreateVulnerabilityScanRequest request)
Description copied from interface:DbLifeCycleManagementCreates a VulnerabilityScan.- Specified by:
createVulnerabilityScanin interfaceDbLifeCycleManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPatchManagement
public GetPatchManagementResponse getPatchManagement(GetPatchManagementRequest request)
Description copied from interface:DbLifeCycleManagementOverview of Patch Management.- Specified by:
getPatchManagementin interfaceDbLifeCycleManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getVulnerability
public GetVulnerabilityResponse getVulnerability(GetVulnerabilityRequest request)
Description copied from interface:DbLifeCycleManagementGets a Vulnerability- Specified by:
getVulnerabilityin interfaceDbLifeCycleManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getVulnerabilityScan
public GetVulnerabilityScanResponse getVulnerabilityScan(GetVulnerabilityScanRequest request)
Description copied from interface:DbLifeCycleManagementGets information about a VulnerabilityScan.- Specified by:
getVulnerabilityScanin interfaceDbLifeCycleManagement- 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:DbLifeCycleManagementGets details of the work request with the given ID.- Specified by:
getWorkRequestin interfaceDbLifeCycleManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAggregatedVulnerabilityData
public ListAggregatedVulnerabilityDataResponse listAggregatedVulnerabilityData(ListAggregatedVulnerabilityDataRequest request)
Description copied from interface:DbLifeCycleManagementGets an AggregatedVulnerabilityData- Specified by:
listAggregatedVulnerabilityDatain interfaceDbLifeCycleManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDatabases
public ListDatabasesResponse listDatabases(ListDatabasesRequest request)
Description copied from interface:DbLifeCycleManagementGets the list of databases- Specified by:
listDatabasesin interfaceDbLifeCycleManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listNotifications
public ListNotificationsResponse listNotifications(ListNotificationsRequest request)
Description copied from interface:DbLifeCycleManagementList of notifications- Specified by:
listNotificationsin interfaceDbLifeCycleManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listVulnerabilities
public ListVulnerabilitiesResponse listVulnerabilities(ListVulnerabilitiesRequest request)
Description copied from interface:DbLifeCycleManagementGets the vulnerabilities summary list- Specified by:
listVulnerabilitiesin interfaceDbLifeCycleManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listVulnerabilityResources
public ListVulnerabilityResourcesResponse listVulnerabilityResources(ListVulnerabilityResourcesRequest request)
Description copied from interface:DbLifeCycleManagementLists the summary of vulnerable and clean resourcees- Specified by:
listVulnerabilityResourcesin interfaceDbLifeCycleManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listVulnerabilityScans
public ListVulnerabilityScansResponse listVulnerabilityScans(ListVulnerabilityScansRequest request)
Description copied from interface:DbLifeCycleManagementGets a list of VulnerabilityScans.- Specified by:
listVulnerabilityScansin interfaceDbLifeCycleManagement- 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:DbLifeCycleManagementReturns a (paginated) list of errors for the work request with the given ID.- Specified by:
listWorkRequestErrorsin interfaceDbLifeCycleManagement- 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:DbLifeCycleManagementReturns a (paginated) list of logs for the work request with the given ID.- Specified by:
listWorkRequestLogsin interfaceDbLifeCycleManagement- 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:DbLifeCycleManagementLists the work requests in a compartment.- Specified by:
listWorkRequestsin interfaceDbLifeCycleManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public DbLifeCycleManagementWaiters getWaiters()
Description copied from interface:DbLifeCycleManagementGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceDbLifeCycleManagement- Returns:
- The service waiters.
-
getPaginators
public DbLifeCycleManagementPaginators getPaginators()
Description copied from interface:DbLifeCycleManagementGets 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 interfaceDbLifeCycleManagement- 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()
-
-