@Generated(value="OracleSDKGenerator", comments="API Version: 20180608") public class KmsManagementClient extends Object implements KmsManagement
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for KmsManagement.
|
Constructor and Description |
---|
KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
KmsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
static KmsManagementClientBuilder |
builder()
Create a builder for this client.
|
void |
close() |
CreateKeyResponse |
createKey(CreateKeyRequest request)
Creates a new key.
|
CreateKeyVersionResponse |
createKeyVersion(CreateKeyVersionRequest request)
Generates new cryptographic material for a key.
|
DisableKeyResponse |
disableKey(DisableKeyRequest request)
Disables a key to make it unavailable for encryption or decryption.
|
EnableKeyResponse |
enableKey(EnableKeyRequest request)
Enables a key to make it available for encryption or decryption.
|
GetKeyResponse |
getKey(GetKeyRequest request)
Gets information about the specified key.
|
GetKeyVersionResponse |
getKeyVersion(GetKeyVersionRequest request)
Gets information about the specified key version.
|
KmsManagementPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
|
KmsManagementWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListKeysResponse |
listKeys(ListKeysRequest request)
Lists the keys in the specified vault and compartment.
|
ListKeyVersionsResponse |
listKeyVersions(ListKeyVersionsRequest request)
Lists all key versions for the specified key.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
UpdateKeyResponse |
updateKey(UpdateKeyRequest request)
Updates the properties of a key.
|
public static final Service SERVICE
Service instance for KmsManagement.
public KmsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public KmsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public KmsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public KmsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorpublic static KmsManagementClientBuilder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
KmsManagement
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface KmsManagement
endpoint
- The endpoint of the service.public void close()
close
in interface AutoCloseable
public CreateKeyResponse createKey(CreateKeyRequest request)
KmsManagement
Creates a new key.
createKey
in interface KmsManagement
request
- The request object containing the details to sendpublic CreateKeyVersionResponse createKeyVersion(CreateKeyVersionRequest request)
KmsManagement
Generates new cryptographic material for a key. The key must be in an ENABLED
state to be rotated.
createKeyVersion
in interface KmsManagement
request
- The request object containing the details to sendpublic DisableKeyResponse disableKey(DisableKeyRequest request)
KmsManagement
Disables a key to make it unavailable for encryption or decryption.
disableKey
in interface KmsManagement
request
- The request object containing the details to sendpublic EnableKeyResponse enableKey(EnableKeyRequest request)
KmsManagement
Enables a key to make it available for encryption or decryption.
enableKey
in interface KmsManagement
request
- The request object containing the details to sendpublic GetKeyResponse getKey(GetKeyRequest request)
KmsManagement
Gets information about the specified key.
getKey
in interface KmsManagement
request
- The request object containing the details to sendpublic GetKeyVersionResponse getKeyVersion(GetKeyVersionRequest request)
KmsManagement
Gets information about the specified key version.
getKeyVersion
in interface KmsManagement
request
- The request object containing the details to sendpublic ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request)
KmsManagement
Lists all key versions for the specified key.
listKeyVersions
in interface KmsManagement
request
- The request object containing the details to sendpublic ListKeysResponse listKeys(ListKeysRequest request)
KmsManagement
Lists the keys in the specified vault and compartment.
listKeys
in interface KmsManagement
request
- The request object containing the details to sendpublic UpdateKeyResponse updateKey(UpdateKeyRequest request)
KmsManagement
Updates the properties of a key. Specifically, you can update the displayName
, freeformTags
, and definedTags
properties. Furthermore, the key must in an ACTIVE
or CREATING
state to be updated.
updateKey
in interface KmsManagement
request
- The request object containing the details to sendpublic KmsManagementWaiters getWaiters()
KmsManagement
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface KmsManagement
public KmsManagementPaginators getPaginators()
KmsManagement
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.
getPaginators
in interface KmsManagement
Copyright © 2016–2019. All rights reserved.