com.oracle.bmc.keymanagement

Interface Ekm

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

EkmClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: release")
public interface Ekm
extends AutoCloseable

Use the Key Management API to manage vaults and keys. For more information, see Managing Vaults and Managing Keys.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
CreateEkmsPrivateEndpointResponse	createEkmsPrivateEndpoint(CreateEkmsPrivateEndpointRequest request) Create a new EKMS private endpoint used to connect to external key manager system
DeleteEkmsPrivateEndpointResponse	deleteEkmsPrivateEndpoint(DeleteEkmsPrivateEndpointRequest request) Deletes EKMS private endpoint by identifier.
GetEkmsPrivateEndpointResponse	getEkmsPrivateEndpoint(GetEkmsPrivateEndpointRequest request) Gets a specific EKMS private by identifier.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
EkmPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
EkmWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListEkmsPrivateEndpointsResponse	listEkmsPrivateEndpoints(ListEkmsPrivateEndpointsRequest request) Returns a list of all the EKMS private endpoints in the specified compartment.
void	refreshClient() Rebuilds the client from scratch.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
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’).
UpdateEkmsPrivateEndpointResponse	updateEkmsPrivateEndpoint(UpdateEkmsPrivateEndpointRequest request) Updates EKMS private endpoint.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

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.

Parameters:

region - The region of the service.

setRegion

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.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

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”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

createEkmsPrivateEndpoint

CreateEkmsPrivateEndpointResponse createEkmsPrivateEndpoint(CreateEkmsPrivateEndpointRequest request)

Create a new EKMS private endpoint used to connect to external key manager system

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreateEkmsPrivateEndpoint API.

deleteEkmsPrivateEndpoint

DeleteEkmsPrivateEndpointResponse deleteEkmsPrivateEndpoint(DeleteEkmsPrivateEndpointRequest request)

Deletes EKMS private endpoint by identifier.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteEkmsPrivateEndpoint API.

getEkmsPrivateEndpoint

GetEkmsPrivateEndpointResponse getEkmsPrivateEndpoint(GetEkmsPrivateEndpointRequest request)

Gets a specific EKMS private by identifier.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetEkmsPrivateEndpoint API.

listEkmsPrivateEndpoints

ListEkmsPrivateEndpointsResponse listEkmsPrivateEndpoints(ListEkmsPrivateEndpointsRequest request)

Returns a list of all the EKMS private endpoints in the specified compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListEkmsPrivateEndpoints API.

updateEkmsPrivateEndpoint

UpdateEkmsPrivateEndpointResponse updateEkmsPrivateEndpoint(UpdateEkmsPrivateEndpointRequest request)

Updates EKMS private endpoint.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateEkmsPrivateEndpoint API.

getWaiters

EkmWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

EkmPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.