com.oracle.bmc.certificatesmanagement

Class CertificatesManagementClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.certificatesmanagement.CertificatesManagementClient

All Implemented Interfaces:

CertificatesManagement, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210224")
public class CertificatesManagementClient
extends BaseSyncClient
implements CertificatesManagement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CertificatesManagementClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for CertificatesManagement.

Constructor Summary

Constructors

Constructor and Description
CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
CertificatesManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
CertificatesManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
CertificatesManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static CertificatesManagementClient.Builder	builder() Create a builder for this client.
CancelCertificateAuthorityDeletionResponse	cancelCertificateAuthorityDeletion(CancelCertificateAuthorityDeletionRequest request) Cancels the scheduled deletion of the specified certificate authority (CA).
CancelCertificateAuthorityVersionDeletionResponse	cancelCertificateAuthorityVersionDeletion(CancelCertificateAuthorityVersionDeletionRequest request) Cancels the scheduled deletion of the specified certificate authority (CA) version.
CancelCertificateDeletionResponse	cancelCertificateDeletion(CancelCertificateDeletionRequest request) Cancels the pending deletion of the specified certificate.
CancelCertificateVersionDeletionResponse	cancelCertificateVersionDeletion(CancelCertificateVersionDeletionRequest request) Cancels the scheduled deletion of the specified certificate version.
ChangeCaBundleCompartmentResponse	changeCaBundleCompartment(ChangeCaBundleCompartmentRequest request) Moves a CA bundle to a different compartment in the same tenancy.
ChangeCertificateAuthorityCompartmentResponse	changeCertificateAuthorityCompartment(ChangeCertificateAuthorityCompartmentRequest request) Moves a certificate authority (CA) to a different compartment within the same tenancy.
ChangeCertificateCompartmentResponse	changeCertificateCompartment(ChangeCertificateCompartmentRequest request) Moves a certificate to a different compartment within the same tenancy.
void	close()
CreateCaBundleResponse	createCaBundle(CreateCaBundleRequest request) Creates a new CA bundle according to the details of the request.
CreateCertificateResponse	createCertificate(CreateCertificateRequest request) Creates a new certificate according to the details of the request.
CreateCertificateAuthorityResponse	createCertificateAuthority(CreateCertificateAuthorityRequest request) Creates a new certificate authority (CA) according to the details of the request.
DeleteCaBundleResponse	deleteCaBundle(DeleteCaBundleRequest request) Deletes the specified CA bundle.
GetAssociationResponse	getAssociation(GetAssociationRequest request) Gets details about the specified association.
GetCaBundleResponse	getCaBundle(GetCaBundleRequest request) Gets details about the specified CA bundle.
GetCertificateResponse	getCertificate(GetCertificateRequest request) Gets details about the specified certificate.
GetCertificateAuthorityResponse	getCertificateAuthority(GetCertificateAuthorityRequest request) Gets details about the specified certificate authority (CA).
GetCertificateAuthorityVersionResponse	getCertificateAuthorityVersion(GetCertificateAuthorityVersionRequest request) Gets details about the specified certificate authority (CA) version.
GetCertificateVersionResponse	getCertificateVersion(GetCertificateVersionRequest request) Gets details about the specified version of a certificate.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
CertificatesManagementPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
CertificatesManagementWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListAssociationsResponse	listAssociations(ListAssociationsRequest request) Lists all associations that match the query parameters.
ListCaBundlesResponse	listCaBundles(ListCaBundlesRequest request) Lists all CA bundles that match the query parameters.
ListCertificateAuthoritiesResponse	listCertificateAuthorities(ListCertificateAuthoritiesRequest request) Lists all certificate authorities (CAs) in the specified compartment.
ListCertificateAuthorityVersionsResponse	listCertificateAuthorityVersions(ListCertificateAuthorityVersionsRequest request) Lists all versions for the specified certificate authority (CA).
ListCertificatesResponse	listCertificates(ListCertificatesRequest request) Lists all certificates that match the query parameters.
ListCertificateVersionsResponse	listCertificateVersions(ListCertificateVersionsRequest request) Lists all certificate versions for the specified certificate.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
RevokeCertificateAuthorityVersionResponse	revokeCertificateAuthorityVersion(RevokeCertificateAuthorityVersionRequest request) Revokes a certificate authority (CA) version.
RevokeCertificateVersionResponse	revokeCertificateVersion(RevokeCertificateVersionRequest request) Revokes the specified certificate version.
ScheduleCertificateAuthorityDeletionResponse	scheduleCertificateAuthorityDeletion(ScheduleCertificateAuthorityDeletionRequest request) Schedules the deletion of the specified certificate authority (CA).
ScheduleCertificateAuthorityVersionDeletionResponse	scheduleCertificateAuthorityVersionDeletion(ScheduleCertificateAuthorityVersionDeletionRequest request) Schedules the deletion of the specified certificate authority (CA) version.
ScheduleCertificateDeletionResponse	scheduleCertificateDeletion(ScheduleCertificateDeletionRequest request) Schedules the deletion of the specified certificate.
ScheduleCertificateVersionDeletionResponse	scheduleCertificateVersionDeletion(ScheduleCertificateVersionDeletionRequest request) Schedules the deletion of the specified certificate version.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateCaBundleResponse	updateCaBundle(UpdateCaBundleRequest request) Updates the properties of a CA bundle.
UpdateCertificateResponse	updateCertificate(UpdateCertificateRequest request) Updates the properties of a certificate.
UpdateCertificateAuthorityResponse	updateCertificateAuthority(UpdateCertificateAuthorityRequest request) Updates the properties of the specified certificate authority (CA).
void	useRealmSpecificEndpointTemplate(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 com.oracle.bmc.certificatesmanagement.CertificatesManagement

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for CertificatesManagement.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

CertificatesManagementClient

@Deprecated
public CertificatesManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CertificatesManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

CertificatesManagementClient

@Deprecated
public CertificatesManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CertificatesManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

CertificatesManagementClient

@Deprecated
public CertificatesManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                ClientConfiguration configuration,
                                                ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CertificatesManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

CertificatesManagementClient

@Deprecated
public CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                ClientConfiguration configuration,
                                                ClientConfigurator clientConfigurator,
                                                RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CertificatesManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

CertificatesManagementClient

@Deprecated
public CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                ClientConfiguration configuration,
                                                ClientConfigurator clientConfigurator,
                                                RequestSignerFactory defaultRequestSignerFactory,
                                                List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CertificatesManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

CertificatesManagementClient

@Deprecated
public CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                ClientConfiguration configuration,
                                                ClientConfigurator clientConfigurator,
                                                RequestSignerFactory defaultRequestSignerFactory,
                                                List<ClientConfigurator> additionalClientConfigurators,
                                                String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CertificatesManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

CertificatesManagementClient

@Deprecated
public CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                ClientConfiguration configuration,
                                                ClientConfigurator clientConfigurator,
                                                RequestSignerFactory defaultRequestSignerFactory,
                                                Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                                List<ClientConfigurator> additionalClientConfigurators,
                                                String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CertificatesManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

CertificatesManagementClient

@Deprecated
public CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                ClientConfiguration configuration,
                                                ClientConfigurator clientConfigurator,
                                                RequestSignerFactory defaultRequestSignerFactory,
                                                Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                                List<ClientConfigurator> additionalClientConfigurators,
                                                String endpoint,
                                                ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CertificatesManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - CertificatesManagementClient.Builder.executorService

Method Detail

builder

public static CertificatesManagementClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: CertificatesManagement

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.

Specified by:

setRegion in interface CertificatesManagement

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: CertificatesManagement

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.

Specified by:

setRegion in interface CertificatesManagement

Parameters:

regionId - The public region ID.

cancelCertificateAuthorityDeletion

public CancelCertificateAuthorityDeletionResponse cancelCertificateAuthorityDeletion(CancelCertificateAuthorityDeletionRequest request)

Description copied from interface: CertificatesManagement

Cancels the scheduled deletion of the specified certificate authority (CA).

Specified by:

cancelCertificateAuthorityDeletion in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelCertificateAuthorityVersionDeletion

public CancelCertificateAuthorityVersionDeletionResponse cancelCertificateAuthorityVersionDeletion(CancelCertificateAuthorityVersionDeletionRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

cancelCertificateAuthorityVersionDeletion in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelCertificateDeletion

public CancelCertificateDeletionResponse cancelCertificateDeletion(CancelCertificateDeletionRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

cancelCertificateDeletion in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelCertificateVersionDeletion

public CancelCertificateVersionDeletionResponse cancelCertificateVersionDeletion(CancelCertificateVersionDeletionRequest request)

Description copied from interface: CertificatesManagement

Cancels the scheduled deletion of the specified certificate version.

Specified by:

cancelCertificateVersionDeletion in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeCaBundleCompartment

public ChangeCaBundleCompartmentResponse changeCaBundleCompartment(ChangeCaBundleCompartmentRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

changeCaBundleCompartment in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeCertificateAuthorityCompartment

public ChangeCertificateAuthorityCompartmentResponse changeCertificateAuthorityCompartment(ChangeCertificateAuthorityCompartmentRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

changeCertificateAuthorityCompartment in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeCertificateCompartment

public ChangeCertificateCompartmentResponse changeCertificateCompartment(ChangeCertificateCompartmentRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

changeCertificateCompartment in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createCaBundle

public CreateCaBundleResponse createCaBundle(CreateCaBundleRequest request)

Description copied from interface: CertificatesManagement

Creates a new CA bundle according to the details of the request.

Specified by:

createCaBundle in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createCertificate

public CreateCertificateResponse createCertificate(CreateCertificateRequest request)

Description copied from interface: CertificatesManagement

Creates a new certificate according to the details of the request.

Specified by:

createCertificate in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createCertificateAuthority

public CreateCertificateAuthorityResponse createCertificateAuthority(CreateCertificateAuthorityRequest request)

Description copied from interface: CertificatesManagement

Creates a new certificate authority (CA) according to the details of the request.

Specified by:

createCertificateAuthority in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteCaBundle

public DeleteCaBundleResponse deleteCaBundle(DeleteCaBundleRequest request)

Description copied from interface: CertificatesManagement

Deletes the specified CA bundle.

Specified by:

deleteCaBundle in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAssociation

public GetAssociationResponse getAssociation(GetAssociationRequest request)

Description copied from interface: CertificatesManagement

Gets details about the specified association.

Specified by:

getAssociation in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCaBundle

public GetCaBundleResponse getCaBundle(GetCaBundleRequest request)

Description copied from interface: CertificatesManagement

Gets details about the specified CA bundle.

Specified by:

getCaBundle in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCertificate

public GetCertificateResponse getCertificate(GetCertificateRequest request)

Description copied from interface: CertificatesManagement

Gets details about the specified certificate.

Specified by:

getCertificate in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCertificateAuthority

public GetCertificateAuthorityResponse getCertificateAuthority(GetCertificateAuthorityRequest request)

Description copied from interface: CertificatesManagement

Gets details about the specified certificate authority (CA).

Specified by:

getCertificateAuthority in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCertificateAuthorityVersion

public GetCertificateAuthorityVersionResponse getCertificateAuthorityVersion(GetCertificateAuthorityVersionRequest request)

Description copied from interface: CertificatesManagement

Gets details about the specified certificate authority (CA) version.

Specified by:

getCertificateAuthorityVersion in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCertificateVersion

public GetCertificateVersionResponse getCertificateVersion(GetCertificateVersionRequest request)

Description copied from interface: CertificatesManagement

Gets details about the specified version of a certificate.

Specified by:

getCertificateVersion in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAssociations

public ListAssociationsResponse listAssociations(ListAssociationsRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

listAssociations in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listCaBundles

public ListCaBundlesResponse listCaBundles(ListCaBundlesRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

listCaBundles in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listCertificateAuthorities

public ListCertificateAuthoritiesResponse listCertificateAuthorities(ListCertificateAuthoritiesRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

listCertificateAuthorities in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listCertificateAuthorityVersions

public ListCertificateAuthorityVersionsResponse listCertificateAuthorityVersions(ListCertificateAuthorityVersionsRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

listCertificateAuthorityVersions in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listCertificateVersions

public ListCertificateVersionsResponse listCertificateVersions(ListCertificateVersionsRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

listCertificateVersions in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listCertificates

public ListCertificatesResponse listCertificates(ListCertificatesRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

listCertificates in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

revokeCertificateAuthorityVersion

public RevokeCertificateAuthorityVersionResponse revokeCertificateAuthorityVersion(RevokeCertificateAuthorityVersionRequest request)

Description copied from interface: CertificatesManagement

Revokes a certificate authority (CA) version.

Specified by:

revokeCertificateAuthorityVersion in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

revokeCertificateVersion

public RevokeCertificateVersionResponse revokeCertificateVersion(RevokeCertificateVersionRequest request)

Description copied from interface: CertificatesManagement

Revokes the specified certificate version.

Specified by:

revokeCertificateVersion in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

scheduleCertificateAuthorityDeletion

public ScheduleCertificateAuthorityDeletionResponse scheduleCertificateAuthorityDeletion(ScheduleCertificateAuthorityDeletionRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

scheduleCertificateAuthorityDeletion in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

scheduleCertificateAuthorityVersionDeletion

public ScheduleCertificateAuthorityVersionDeletionResponse scheduleCertificateAuthorityVersionDeletion(ScheduleCertificateAuthorityVersionDeletionRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

scheduleCertificateAuthorityVersionDeletion in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

scheduleCertificateDeletion

public ScheduleCertificateDeletionResponse scheduleCertificateDeletion(ScheduleCertificateDeletionRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

scheduleCertificateDeletion in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

scheduleCertificateVersionDeletion

public ScheduleCertificateVersionDeletionResponse scheduleCertificateVersionDeletion(ScheduleCertificateVersionDeletionRequest request)

Description copied from interface: CertificatesManagement

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.

Specified by:

scheduleCertificateVersionDeletion in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateCaBundle

public UpdateCaBundleResponse updateCaBundle(UpdateCaBundleRequest request)

Description copied from interface: CertificatesManagement

Updates the properties of a CA bundle.

Specified by:

updateCaBundle in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateCertificate

public UpdateCertificateResponse updateCertificate(UpdateCertificateRequest request)

Description copied from interface: CertificatesManagement

Updates the properties of a certificate.

Specified by:

updateCertificate in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateCertificateAuthority

public UpdateCertificateAuthorityResponse updateCertificateAuthority(UpdateCertificateAuthorityRequest request)

Description copied from interface: CertificatesManagement

Updates the properties of the specified certificate authority (CA).

Specified by:

updateCertificateAuthority in interface CertificatesManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public CertificatesManagementWaiters getWaiters()

Description copied from interface: CertificatesManagement

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface CertificatesManagement

Returns:

The service waiters.

getPaginators

public CertificatesManagementPaginators getPaginators()

Description copied from interface: CertificatesManagement

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.

Specified by:

getPaginators in interface CertificatesManagement

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

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

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()