@Generated(value="OracleSDKGenerator", comments="API Version: 20210224") public interface CertificatesManagementAsync extends AutoCloseable
API for managing certificates.
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 serice.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
templateFuture<CancelCertificateAuthorityDeletionResponse> cancelCertificateAuthorityDeletion(CancelCertificateAuthorityDeletionRequest request, AsyncHandler<CancelCertificateAuthorityDeletionRequest,CancelCertificateAuthorityDeletionResponse> handler)
Cancels the scheduled deletion of the specified certificate authority (CA).
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CancelCertificateAuthorityVersionDeletionResponse> cancelCertificateAuthorityVersionDeletion(CancelCertificateAuthorityVersionDeletionRequest request, AsyncHandler<CancelCertificateAuthorityVersionDeletionRequest,CancelCertificateAuthorityVersionDeletionResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<CancelCertificateDeletionResponse> cancelCertificateDeletion(CancelCertificateDeletionRequest request, AsyncHandler<CancelCertificateDeletionRequest,CancelCertificateDeletionResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<CancelCertificateVersionDeletionResponse> cancelCertificateVersionDeletion(CancelCertificateVersionDeletionRequest request, AsyncHandler<CancelCertificateVersionDeletionRequest,CancelCertificateVersionDeletionResponse> handler)
Cancels the scheduled deletion of the specified certificate version.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeCaBundleCompartmentResponse> changeCaBundleCompartment(ChangeCaBundleCompartmentRequest request, AsyncHandler<ChangeCaBundleCompartmentRequest,ChangeCaBundleCompartmentResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeCertificateAuthorityCompartmentResponse> changeCertificateAuthorityCompartment(ChangeCertificateAuthorityCompartmentRequest request, AsyncHandler<ChangeCertificateAuthorityCompartmentRequest,ChangeCertificateAuthorityCompartmentResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeCertificateCompartmentResponse> changeCertificateCompartment(ChangeCertificateCompartmentRequest request, AsyncHandler<ChangeCertificateCompartmentRequest,ChangeCertificateCompartmentResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateCaBundleResponse> createCaBundle(CreateCaBundleRequest request, AsyncHandler<CreateCaBundleRequest,CreateCaBundleResponse> handler)
Creates a new CA bundle according to the details of the request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateCertificateResponse> createCertificate(CreateCertificateRequest request, AsyncHandler<CreateCertificateRequest,CreateCertificateResponse> handler)
Creates a new certificate according to the details of the request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateCertificateAuthorityResponse> createCertificateAuthority(CreateCertificateAuthorityRequest request, AsyncHandler<CreateCertificateAuthorityRequest,CreateCertificateAuthorityResponse> handler)
Creates a new certificate authority (CA) according to the details of the request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteCaBundleResponse> deleteCaBundle(DeleteCaBundleRequest request, AsyncHandler<DeleteCaBundleRequest,DeleteCaBundleResponse> handler)
Deletes the specified CA bundle.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetAssociationResponse> getAssociation(GetAssociationRequest request, AsyncHandler<GetAssociationRequest,GetAssociationResponse> handler)
Gets details about the specified association.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetCaBundleResponse> getCaBundle(GetCaBundleRequest request, AsyncHandler<GetCaBundleRequest,GetCaBundleResponse> handler)
Gets details about the specified CA bundle.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetCertificateResponse> getCertificate(GetCertificateRequest request, AsyncHandler<GetCertificateRequest,GetCertificateResponse> handler)
Gets details about the specified certificate.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetCertificateAuthorityResponse> getCertificateAuthority(GetCertificateAuthorityRequest request, AsyncHandler<GetCertificateAuthorityRequest,GetCertificateAuthorityResponse> handler)
Gets details about the specified certificate authority (CA).
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetCertificateAuthorityVersionResponse> getCertificateAuthorityVersion(GetCertificateAuthorityVersionRequest request, AsyncHandler<GetCertificateAuthorityVersionRequest,GetCertificateAuthorityVersionResponse> handler)
Gets details about the specified certificate authority (CA) version.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetCertificateVersionResponse> getCertificateVersion(GetCertificateVersionRequest request, AsyncHandler<GetCertificateVersionRequest,GetCertificateVersionResponse> handler)
Gets details about the specified version of a certificate.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAssociationsResponse> listAssociations(ListAssociationsRequest request, AsyncHandler<ListAssociationsRequest,ListAssociationsResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<ListCaBundlesResponse> listCaBundles(ListCaBundlesRequest request, AsyncHandler<ListCaBundlesRequest,ListCaBundlesResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<ListCertificateAuthoritiesResponse> listCertificateAuthorities(ListCertificateAuthoritiesRequest request, AsyncHandler<ListCertificateAuthoritiesRequest,ListCertificateAuthoritiesResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<ListCertificateAuthorityVersionsResponse> listCertificateAuthorityVersions(ListCertificateAuthorityVersionsRequest request, AsyncHandler<ListCertificateAuthorityVersionsRequest,ListCertificateAuthorityVersionsResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<ListCertificateVersionsResponse> listCertificateVersions(ListCertificateVersionsRequest request, AsyncHandler<ListCertificateVersionsRequest,ListCertificateVersionsResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<ListCertificatesResponse> listCertificates(ListCertificatesRequest request, AsyncHandler<ListCertificatesRequest,ListCertificatesResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<RevokeCertificateAuthorityVersionResponse> revokeCertificateAuthorityVersion(RevokeCertificateAuthorityVersionRequest request, AsyncHandler<RevokeCertificateAuthorityVersionRequest,RevokeCertificateAuthorityVersionResponse> handler)
Revokes a certificate authority (CA) version.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RevokeCertificateVersionResponse> revokeCertificateVersion(RevokeCertificateVersionRequest request, AsyncHandler<RevokeCertificateVersionRequest,RevokeCertificateVersionResponse> handler)
Revokes the specified certificate version.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ScheduleCertificateAuthorityDeletionResponse> scheduleCertificateAuthorityDeletion(ScheduleCertificateAuthorityDeletionRequest request, AsyncHandler<ScheduleCertificateAuthorityDeletionRequest,ScheduleCertificateAuthorityDeletionResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<ScheduleCertificateAuthorityVersionDeletionResponse> scheduleCertificateAuthorityVersionDeletion(ScheduleCertificateAuthorityVersionDeletionRequest request, AsyncHandler<ScheduleCertificateAuthorityVersionDeletionRequest,ScheduleCertificateAuthorityVersionDeletionResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<ScheduleCertificateDeletionResponse> scheduleCertificateDeletion(ScheduleCertificateDeletionRequest request, AsyncHandler<ScheduleCertificateDeletionRequest,ScheduleCertificateDeletionResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<ScheduleCertificateVersionDeletionResponse> scheduleCertificateVersionDeletion(ScheduleCertificateVersionDeletionRequest request, AsyncHandler<ScheduleCertificateVersionDeletionRequest,ScheduleCertificateVersionDeletionResponse> handler)
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 sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateCaBundleResponse> updateCaBundle(UpdateCaBundleRequest request, AsyncHandler<UpdateCaBundleRequest,UpdateCaBundleResponse> handler)
Updates the properties of a CA bundle.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateCertificateResponse> updateCertificate(UpdateCertificateRequest request, AsyncHandler<UpdateCertificateRequest,UpdateCertificateResponse> handler)
Updates the properties of a certificate.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateCertificateAuthorityResponse> updateCertificateAuthority(UpdateCertificateAuthorityRequest request, AsyncHandler<UpdateCertificateAuthorityRequest,UpdateCertificateAuthorityResponse> handler)
Updates the properties of the specified certificate authority (CA).
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.