@Generated(value="OracleSDKGenerator", comments="API Version: 20210224") public interface CertificatesManagement extends AutoCloseable
API for managing certificates. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this Region, however, an
IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets 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 call setEndpoint
.
regionId
- The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateCancelCertificateAuthorityDeletionResponse cancelCertificateAuthorityDeletion(CancelCertificateAuthorityDeletionRequest request)
Cancels the scheduled deletion of the specified certificate authority (CA).
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CancelCertificateAuthorityDeletion API.
CancelCertificateAuthorityVersionDeletionResponse cancelCertificateAuthorityVersionDeletion(CancelCertificateAuthorityVersionDeletionRequest request)
Cancels the scheduled deletion of the specified certificate authority (CA) version. Canceling a scheduled deletion restores the CA version’s lifecycle state to what it was before its scheduled deletion.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CancelCertificateAuthorityVersionDeletion API.
CancelCertificateDeletionResponse cancelCertificateDeletion(CancelCertificateDeletionRequest request)
Cancels the pending deletion of the specified certificate. Canceling a scheduled deletion restores the certificate’s lifecycle state to what it was before you scheduled the certificate for deletion.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CancelCertificateDeletion API.
CancelCertificateVersionDeletionResponse cancelCertificateVersionDeletion(CancelCertificateVersionDeletionRequest request)
Cancels the scheduled deletion of the specified certificate version.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CancelCertificateVersionDeletion API.
ChangeCaBundleCompartmentResponse changeCaBundleCompartment(ChangeCaBundleCompartmentRequest request)
Moves a CA bundle to a different compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
When provided, if-match is checked against the ETag values of the secret.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeCaBundleCompartment API.
ChangeCertificateAuthorityCompartmentResponse changeCertificateAuthorityCompartment(ChangeCertificateAuthorityCompartmentRequest request)
Moves a certificate authority (CA) to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
When provided, If-Match is checked against the ETag values of the source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeCertificateAuthorityCompartment API.
ChangeCertificateCompartmentResponse changeCertificateCompartment(ChangeCertificateCompartmentRequest request)
Moves a certificate to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
When provided, if-match is checked against the ETag values of the secret.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeCertificateCompartment API.
CreateCaBundleResponse createCaBundle(CreateCaBundleRequest request)
Creates a new CA bundle according to the details of the request.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateCaBundle API.
CreateCertificateResponse createCertificate(CreateCertificateRequest request)
Creates a new certificate according to the details of the request.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateCertificate API.
CreateCertificateAuthorityResponse createCertificateAuthority(CreateCertificateAuthorityRequest request)
Creates a new certificate authority (CA) according to the details of the request.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateCertificateAuthority API.
DeleteCaBundleResponse deleteCaBundle(DeleteCaBundleRequest request)
Deletes the specified CA bundle.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteCaBundle API.
GetAssociationResponse getAssociation(GetAssociationRequest request)
Gets details about the specified association.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetAssociation API.
GetCaBundleResponse getCaBundle(GetCaBundleRequest request)
Gets details about the specified CA bundle.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetCaBundle API.
GetCertificateResponse getCertificate(GetCertificateRequest request)
Gets details about the specified certificate.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetCertificate API.
GetCertificateAuthorityResponse getCertificateAuthority(GetCertificateAuthorityRequest request)
Gets details about the specified certificate authority (CA).
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetCertificateAuthority API.
GetCertificateAuthorityVersionResponse getCertificateAuthorityVersion(GetCertificateAuthorityVersionRequest request)
Gets details about the specified certificate authority (CA) version.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetCertificateAuthorityVersion API.
GetCertificateVersionResponse getCertificateVersion(GetCertificateVersionRequest request)
Gets details about the specified version of a certificate.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetCertificateVersion API.
ListAssociationsResponse listAssociations(ListAssociationsRequest request)
Lists all associations that match the query parameters. Optionally, you can use the parameter
FilterByAssociationIdQueryParam
to limit the result set to a single item that matches the
specified association.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAssociations API.
ListCaBundlesResponse listCaBundles(ListCaBundlesRequest request)
Lists all CA bundles that match the query parameters. Optionally, you can use the parameter
FilterByCaBundleIdQueryParam
to limit the result set to a single item that matches the
specified CA bundle.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListCaBundles API.
ListCertificateAuthoritiesResponse listCertificateAuthorities(ListCertificateAuthoritiesRequest request)
Lists all certificate authorities (CAs) in the specified compartment. Optionally, you can use
the parameter FilterByCertificateAuthorityIdQueryParam
to limit the results to a single
item that matches the specified CA.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListCertificateAuthorities API.
ListCertificateAuthorityVersionsResponse listCertificateAuthorityVersions(ListCertificateAuthorityVersionsRequest request)
Lists all versions for the specified certificate authority (CA). Optionally, you can use the
parameter FilterByVersionNumberQueryParam
to limit the results to a single item that
matches the specified version number.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListCertificateAuthorityVersions API.
ListCertificateVersionsResponse listCertificateVersions(ListCertificateVersionsRequest request)
Lists all certificate versions for the specified certificate. Optionally, you can use the
parameter FilterByVersionNumberQueryParam
to limit the result set to a single item that
matches the specified version number.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListCertificateVersions API.
ListCertificatesResponse listCertificates(ListCertificatesRequest request)
Lists all certificates that match the query parameters. Optionally, you can use the parameter
FilterByCertificateIdQueryParam
to limit the result set to a single item that matches the
specified certificate.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListCertificates API.
RevokeCertificateAuthorityVersionResponse revokeCertificateAuthorityVersion(RevokeCertificateAuthorityVersionRequest request)
Revokes a certificate authority (CA) version.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RevokeCertificateAuthorityVersion API.
RevokeCertificateVersionResponse revokeCertificateVersion(RevokeCertificateVersionRequest request)
Revokes the specified certificate version.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RevokeCertificateVersion API.
ScheduleCertificateAuthorityDeletionResponse scheduleCertificateAuthorityDeletion(ScheduleCertificateAuthorityDeletionRequest request)
Schedules the deletion of the specified certificate authority (CA). This sets the lifecycle
state of the CA to PENDING_DELETION
and then deletes it after the specified retention
period ends. If needed, you can determine the status of the deletion by using
GetCertificateAuthority
.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ScheduleCertificateAuthorityDeletion API.
ScheduleCertificateAuthorityVersionDeletionResponse scheduleCertificateAuthorityVersionDeletion(ScheduleCertificateAuthorityVersionDeletionRequest request)
Schedules the deletion of the specified certificate authority (CA) version. This sets the
lifecycle state of the CA version to PENDING_DELETION
and then deletes it after the
specified retention period ends. If needed, you can determine the status of the deletion by
using GetCertificateAuthorityVersion
.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ScheduleCertificateAuthorityVersionDeletion API.
ScheduleCertificateDeletionResponse scheduleCertificateDeletion(ScheduleCertificateDeletionRequest request)
Schedules the deletion of the specified certificate. This sets the lifecycle state of the
certificate to PENDING_DELETION
and then deletes it after the specified retention period
ends. You can subsequently use GetCertificate
to determine the current deletion status.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ScheduleCertificateDeletion API.
ScheduleCertificateVersionDeletionResponse scheduleCertificateVersionDeletion(ScheduleCertificateVersionDeletionRequest request)
Schedules the deletion of the specified certificate version. This sets the lifecycle state of
the certificate version to PENDING_DELETION
and then deletes it after the specified
retention period ends. You can only delete a certificate version if the certificate version
rotation state is marked as DEPRECATED
.
You can subsequently use `GetCertificateVersion` to determine the current certificate version deletion status.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ScheduleCertificateVersionDeletion API.
UpdateCaBundleResponse updateCaBundle(UpdateCaBundleRequest request)
Updates the properties of a CA bundle.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateCaBundle API.
UpdateCertificateResponse updateCertificate(UpdateCertificateRequest request)
Updates the properties of a certificate.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateCertificate API.
UpdateCertificateAuthorityResponse updateCertificateAuthority(UpdateCertificateAuthorityRequest request)
Updates the properties of the specified certificate authority (CA).
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateCertificateAuthority API.
CertificatesManagementWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
CertificatesManagementPaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without
having to manually deal with pagination and page tokens.
Copyright © 2016–2024. All rights reserved.