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 Description static classCertificatesManagementClient.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 CertificatesManagement.
-
Constructor Summary
Constructors Constructor Description CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.CertificatesManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.CertificatesManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.CertificatesManagementClient(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 CertificatesManagementClient.Builderbuilder()Create a builder for this client.CancelCertificateAuthorityDeletionResponsecancelCertificateAuthorityDeletion(CancelCertificateAuthorityDeletionRequest request)Cancels the scheduled deletion of the specified certificate authority (CA).CancelCertificateAuthorityVersionDeletionResponsecancelCertificateAuthorityVersionDeletion(CancelCertificateAuthorityVersionDeletionRequest request)Cancels the scheduled deletion of the specified certificate authority (CA) version.CancelCertificateDeletionResponsecancelCertificateDeletion(CancelCertificateDeletionRequest request)Cancels the pending deletion of the specified certificate.CancelCertificateVersionDeletionResponsecancelCertificateVersionDeletion(CancelCertificateVersionDeletionRequest request)Cancels the scheduled deletion of the specified certificate version.ChangeCaBundleCompartmentResponsechangeCaBundleCompartment(ChangeCaBundleCompartmentRequest request)Moves a CA bundle to a different compartment in the same tenancy.ChangeCertificateAuthorityCompartmentResponsechangeCertificateAuthorityCompartment(ChangeCertificateAuthorityCompartmentRequest request)Moves a certificate authority (CA) to a different compartment within the same tenancy.ChangeCertificateCompartmentResponsechangeCertificateCompartment(ChangeCertificateCompartmentRequest request)Moves a certificate to a different compartment within the same tenancy.voidclose()CreateCaBundleResponsecreateCaBundle(CreateCaBundleRequest request)Creates a new CA bundle according to the details of the request.CreateCertificateResponsecreateCertificate(CreateCertificateRequest request)Creates a new certificate according to the details of the request.CreateCertificateAuthorityResponsecreateCertificateAuthority(CreateCertificateAuthorityRequest request)Creates a new certificate authority (CA) according to the details of the request.DeleteCaBundleResponsedeleteCaBundle(DeleteCaBundleRequest request)Deletes the specified CA bundle.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.GetAssociationResponsegetAssociation(GetAssociationRequest request)Gets details about the specified association.GetCaBundleResponsegetCaBundle(GetCaBundleRequest request)Gets details about the specified CA bundle.GetCertificateResponsegetCertificate(GetCertificateRequest request)Gets details about the specified certificate.GetCertificateAuthorityResponsegetCertificateAuthority(GetCertificateAuthorityRequest request)Gets details about the specified certificate authority (CA).GetCertificateAuthorityVersionResponsegetCertificateAuthorityVersion(GetCertificateAuthorityVersionRequest request)Gets details about the specified certificate authority (CA) version.GetCertificateVersionResponsegetCertificateVersion(GetCertificateVersionRequest request)Gets details about the specified version of a certificate.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.CertificatesManagementPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.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.CertificatesManagementWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListAssociationsResponselistAssociations(ListAssociationsRequest request)Lists all associations that match the query parameters.ListCaBundlesResponselistCaBundles(ListCaBundlesRequest request)Lists all CA bundles that match the query parameters.ListCertificateAuthoritiesResponselistCertificateAuthorities(ListCertificateAuthoritiesRequest request)Lists all certificate authorities (CAs) in the specified compartment.ListCertificateAuthorityVersionsResponselistCertificateAuthorityVersions(ListCertificateAuthorityVersionsRequest request)Lists all versions for the specified certificate authority (CA).ListCertificatesResponselistCertificates(ListCertificatesRequest request)Lists all certificates that match the query parameters.ListCertificateVersionsResponselistCertificateVersions(ListCertificateVersionsRequest request)Lists all certificate versions for the specified certificate.voidrefreshClient()Rebuild the backingHttpClient.RevokeCertificateAuthorityVersionResponserevokeCertificateAuthorityVersion(RevokeCertificateAuthorityVersionRequest request)Revokes a certificate authority (CA) version.RevokeCertificateVersionResponserevokeCertificateVersion(RevokeCertificateVersionRequest request)Revokes the specified certificate version.ScheduleCertificateAuthorityDeletionResponsescheduleCertificateAuthorityDeletion(ScheduleCertificateAuthorityDeletionRequest request)Schedules the deletion of the specified certificate authority (CA).ScheduleCertificateAuthorityVersionDeletionResponsescheduleCertificateAuthorityVersionDeletion(ScheduleCertificateAuthorityVersionDeletionRequest request)Schedules the deletion of the specified certificate authority (CA) version.ScheduleCertificateDeletionResponsescheduleCertificateDeletion(ScheduleCertificateDeletionRequest request)Schedules the deletion of the specified certificate.ScheduleCertificateVersionDeletionResponsescheduleCertificateVersionDeletion(ScheduleCertificateVersionDeletionRequest request)Schedules the deletion of the specified certificate version.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’).UpdateCaBundleResponseupdateCaBundle(UpdateCaBundleRequest request)Updates the properties of a CA bundle.UpdateCertificateResponseupdateCertificate(UpdateCertificateRequest request)Updates the properties of a certificate.UpdateCertificateAuthorityResponseupdateCertificateAuthority(UpdateCertificateAuthorityRequest request)Updates the properties of the specified certificate authority (CA).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.certificatesmanagement.CertificatesManagement
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
CertificatesManagementClient
@Deprecated public CertificatesManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCertificatesManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
CertificatesManagementClient
@Deprecated public CertificatesManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCertificatesManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
CertificatesManagementClient
@Deprecated public CertificatesManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCertificatesManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
CertificatesManagementClient
@Deprecated public CertificatesManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCertificatesManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCertificatesManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
CertificatesManagementClient
@Deprecated public CertificatesManagementClient(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 (seeCertificatesManagementClient.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)
-
CertificatesManagementClient
@Deprecated public CertificatesManagementClient(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 (seeCertificatesManagementClient.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
-
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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCertificatesManagementClient.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-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:CertificatesManagementSets 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 interfaceCertificatesManagement- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:CertificatesManagementSets 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 interfaceCertificatesManagement- Parameters:
regionId- The public region ID.
-
cancelCertificateAuthorityDeletion
public CancelCertificateAuthorityDeletionResponse cancelCertificateAuthorityDeletion(CancelCertificateAuthorityDeletionRequest request)
Description copied from interface:CertificatesManagementCancels the scheduled deletion of the specified certificate authority (CA).- Specified by:
cancelCertificateAuthorityDeletionin interfaceCertificatesManagement- 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:CertificatesManagementCancels 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:
cancelCertificateAuthorityVersionDeletionin interfaceCertificatesManagement- 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:CertificatesManagementCancels 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:
cancelCertificateDeletionin interfaceCertificatesManagement- 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:CertificatesManagementCancels the scheduled deletion of the specified certificate version.- Specified by:
cancelCertificateVersionDeletionin interfaceCertificatesManagement- 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:CertificatesManagementMoves 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:
changeCaBundleCompartmentin interfaceCertificatesManagement- 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:CertificatesManagementMoves 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:
changeCertificateAuthorityCompartmentin interfaceCertificatesManagement- 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:CertificatesManagementMoves 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:
changeCertificateCompartmentin interfaceCertificatesManagement- 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:CertificatesManagementCreates a new CA bundle according to the details of the request.- Specified by:
createCaBundlein interfaceCertificatesManagement- 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:CertificatesManagementCreates a new certificate according to the details of the request.- Specified by:
createCertificatein interfaceCertificatesManagement- 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:CertificatesManagementCreates a new certificate authority (CA) according to the details of the request.- Specified by:
createCertificateAuthorityin interfaceCertificatesManagement- 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:CertificatesManagementDeletes the specified CA bundle.- Specified by:
deleteCaBundlein interfaceCertificatesManagement- 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:CertificatesManagementGets details about the specified association.- Specified by:
getAssociationin interfaceCertificatesManagement- 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:CertificatesManagementGets details about the specified CA bundle.- Specified by:
getCaBundlein interfaceCertificatesManagement- 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:CertificatesManagementGets details about the specified certificate.- Specified by:
getCertificatein interfaceCertificatesManagement- 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:CertificatesManagementGets details about the specified certificate authority (CA).- Specified by:
getCertificateAuthorityin interfaceCertificatesManagement- 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:CertificatesManagementGets details about the specified certificate authority (CA) version.- Specified by:
getCertificateAuthorityVersionin interfaceCertificatesManagement- 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:CertificatesManagementGets details about the specified version of a certificate.- Specified by:
getCertificateVersionin interfaceCertificatesManagement- 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:CertificatesManagementLists all associations that match the query parameters.Optionally, you can use the parameter
FilterByAssociationIdQueryParamto limit the result set to a single item that matches the specified association.- Specified by:
listAssociationsin interfaceCertificatesManagement- 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:CertificatesManagementLists all CA bundles that match the query parameters.Optionally, you can use the parameter
FilterByCaBundleIdQueryParamto limit the result set to a single item that matches the specified CA bundle.- Specified by:
listCaBundlesin interfaceCertificatesManagement- 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:CertificatesManagementLists all certificate authorities (CAs) in the specified compartment.Optionally, you can use the parameter
FilterByCertificateAuthorityIdQueryParamto limit the results to a single item that matches the specified CA.- Specified by:
listCertificateAuthoritiesin interfaceCertificatesManagement- 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:CertificatesManagementLists all versions for the specified certificate authority (CA).Optionally, you can use the parameter
FilterByVersionNumberQueryParamto limit the results to a single item that matches the specified version number.- Specified by:
listCertificateAuthorityVersionsin interfaceCertificatesManagement- 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:CertificatesManagementLists all certificate versions for the specified certificate.Optionally, you can use the parameter
FilterByVersionNumberQueryParamto limit the result set to a single item that matches the specified version number.- Specified by:
listCertificateVersionsin interfaceCertificatesManagement- 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:CertificatesManagementLists all certificates that match the query parameters.Optionally, you can use the parameter
FilterByCertificateIdQueryParamto limit the result set to a single item that matches the specified certificate.- Specified by:
listCertificatesin interfaceCertificatesManagement- 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:CertificatesManagementRevokes a certificate authority (CA) version.- Specified by:
revokeCertificateAuthorityVersionin interfaceCertificatesManagement- 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:CertificatesManagementRevokes the specified certificate version.- Specified by:
revokeCertificateVersionin interfaceCertificatesManagement- 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:CertificatesManagementSchedules the deletion of the specified certificate authority (CA).This sets the lifecycle state of the CA to
PENDING_DELETIONand then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by usingGetCertificateAuthority.- Specified by:
scheduleCertificateAuthorityDeletionin interfaceCertificatesManagement- 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:CertificatesManagementSchedules the deletion of the specified certificate authority (CA) version.This sets the lifecycle state of the CA version to
PENDING_DELETIONand then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by usingGetCertificateAuthorityVersion.- Specified by:
scheduleCertificateAuthorityVersionDeletionin interfaceCertificatesManagement- 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:CertificatesManagementSchedules the deletion of the specified certificate.This sets the lifecycle state of the certificate to
PENDING_DELETIONand then deletes it after the specified retention period ends. You can subsequently useGetCertificateto determine the current deletion status.- Specified by:
scheduleCertificateDeletionin interfaceCertificatesManagement- 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:CertificatesManagementSchedules the deletion of the specified certificate version.This sets the lifecycle state of the certificate version to
PENDING_DELETIONand then deletes it after the specified retention period ends. You can only delete a certificate version if the certificate version rotation state is marked asDEPRECATED.You can subsequently use `GetCertificateVersion` to determine the current certificate version deletion status.
- Specified by:
scheduleCertificateVersionDeletionin interfaceCertificatesManagement- 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:CertificatesManagementUpdates the properties of a CA bundle.- Specified by:
updateCaBundlein interfaceCertificatesManagement- 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:CertificatesManagementUpdates the properties of a certificate.- Specified by:
updateCertificatein interfaceCertificatesManagement- 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:CertificatesManagementUpdates the properties of the specified certificate authority (CA).- Specified by:
updateCertificateAuthorityin interfaceCertificatesManagement- 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:CertificatesManagementGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceCertificatesManagement- Returns:
- The service waiters.
-
getPaginators
public CertificatesManagementPaginators getPaginators()
Description copied from interface:CertificatesManagementGets 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 interfaceCertificatesManagement- 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()
-
-