VaultsClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.vault.VaultsClient

All Implemented Interfaces:: Vaults, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180608")
public class VaultsClient
extends Object
implements Vaults

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VaultsClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`VaultsClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for Vaults.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for Vaults.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`VaultsClient(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.
	`VaultsClient(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.
	`VaultsClient(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.
`protected`	`VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
	`VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VaultsClient.Builder`	`builder()` Create a builder for this client.
`CancelSecretDeletionResponse`	`cancelSecretDeletion(CancelSecretDeletionRequest request)` Cancels the pending deletion of the specified secret.
`CancelSecretVersionDeletionResponse`	`cancelSecretVersionDeletion(CancelSecretVersionDeletionRequest request)` Cancels the scheduled deletion of a secret version.
`ChangeSecretCompartmentResponse`	`changeSecretCompartment(ChangeSecretCompartmentRequest request)` Moves a secret into a different compartment within the same tenancy.
`void`	`close()`
`CreateSecretResponse`	`createSecret(CreateSecretRequest request)` Creates a new secret according to the details of the request.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`VaultsPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetSecretResponse`	`getSecret(GetSecretRequest request)` Gets information about the specified secret.
`GetSecretVersionResponse`	`getSecretVersion(GetSecretVersionRequest request)` Gets information about the specified version of a secret.
`VaultsWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`ListSecretsResponse`	`listSecrets(ListSecretsRequest request)` Lists all secrets in the specified vault and compartment.
`ListSecretVersionsResponse`	`listSecretVersions(ListSecretVersionsRequest request)` Lists all secret versions for the specified secret.
`void`	`refreshClient()` Rebuilds the client from scratch.
`ScheduleSecretDeletionResponse`	`scheduleSecretDeletion(ScheduleSecretDeletionRequest request)` Schedules the deletion of the specified secret.
`ScheduleSecretVersionDeletionResponse`	`scheduleSecretVersionDeletion(ScheduleSecretVersionDeletionRequest request)` Schedules the deletion of the specified secret version.
`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’).
`UpdateSecretResponse`	`updateSecret(UpdateSecretRequest request)` Updates the properties of a secret.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for Vaults.
- Constructor Detail
  - VaultsClient
```
public VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - VaultsClient
```
public VaultsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - VaultsClient
```
public VaultsClient(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.
    
    Parameters:
    
    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.
  - VaultsClient
```
public VaultsClient(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.
    
    Parameters:
    
    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.
  - VaultsClient
```
public VaultsClient(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.
    
    Parameters:
    
    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.
  - VaultsClient
```
public VaultsClient(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.
    
    Parameters:
    
    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)
  - VaultsClient
```
public VaultsClient(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.
    
    Parameters:
    
    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 signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - VaultsClient
```
public VaultsClient(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.
    
    Parameters:
    
    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 signer
    
    additionalClientConfigurators - 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 ThreadPoolExecutor
  - VaultsClient
```
protected VaultsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint,
                       ExecutorService executorService,
                       RestClientFactoryBuilder restClientFactoryBuilder)
```
    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. Use the VaultsClient.Builder to get access to all these parameters.
    
    Parameters:
    
    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 signer
    
    additionalClientConfigurators - 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 ThreadPoolExecutor
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static VaultsClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - refreshClient
```
public void refreshClient()
```
    Description copied from interface: Vaults
    
    Rebuilds the client from scratch. Useful to refresh certificates.
    
    Specified by:
    
    refreshClient in interface Vaults
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: Vaults
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface Vaults
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: Vaults
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface Vaults
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: Vaults
    
    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 Vaults
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: Vaults
    
    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 Vaults
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - cancelSecretDeletion
```
public CancelSecretDeletionResponse cancelSecretDeletion(CancelSecretDeletionRequest request)
```
    Description copied from interface: Vaults
    
    Cancels the pending deletion of the specified secret. Canceling a scheduled deletion restores the secret’s lifecycle state to what it was before you scheduled the secret for deletion.
    
    Specified by:
    
    cancelSecretDeletion in interface Vaults
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - cancelSecretVersionDeletion
```
public CancelSecretVersionDeletionResponse cancelSecretVersionDeletion(CancelSecretVersionDeletionRequest request)
```
    Description copied from interface: Vaults
    
    Cancels the scheduled deletion of a secret version.
    
    Specified by:
    
    cancelSecretVersionDeletion in interface Vaults
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeSecretCompartment
```
public ChangeSecretCompartmentResponse changeSecretCompartment(ChangeSecretCompartmentRequest request)
```
    Description copied from interface: Vaults
    
    Moves a secret into 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:
    
    changeSecretCompartment in interface Vaults
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createSecret
```
public CreateSecretResponse createSecret(CreateSecretRequest request)
```
    Description copied from interface: Vaults
    
    Creates a new secret according to the details of the request.
    
    This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.
    
    Specified by:
    
    createSecret in interface Vaults
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getSecret
```
public GetSecretResponse getSecret(GetSecretRequest request)
```
    Description copied from interface: Vaults
    
    Gets information about the specified secret.
    
    Specified by:
    
    getSecret in interface Vaults
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getSecretVersion
```
public GetSecretVersionResponse getSecretVersion(GetSecretVersionRequest request)
```
    Description copied from interface: Vaults
    
    Gets information about the specified version of a secret.
    
    Specified by:
    
    getSecretVersion in interface Vaults
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSecretVersions
```
public ListSecretVersionsResponse listSecretVersions(ListSecretVersionsRequest request)
```
    Description copied from interface: Vaults
    
    Lists all secret versions for the specified secret.
    
    Specified by:
    
    listSecretVersions in interface Vaults
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSecrets
```
public ListSecretsResponse listSecrets(ListSecretsRequest request)
```
    Description copied from interface: Vaults
    
    Lists all secrets in the specified vault and compartment.
    
    Specified by:
    
    listSecrets in interface Vaults
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - scheduleSecretDeletion
```
public ScheduleSecretDeletionResponse scheduleSecretDeletion(ScheduleSecretDeletionRequest request)
```
    Description copied from interface: Vaults
    
    Schedules the deletion of the specified secret. This sets the lifecycle state of the secret to PENDING_DELETION and then deletes it after the specified retention period ends.
    
    Specified by:
    
    scheduleSecretDeletion in interface Vaults
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - scheduleSecretVersionDeletion
```
public ScheduleSecretVersionDeletionResponse scheduleSecretVersionDeletion(ScheduleSecretVersionDeletionRequest request)
```
    Description copied from interface: Vaults
    
    Schedules the deletion of the specified secret version. This deletes it after the specified retention period ends. You can only delete a secret version if the secret version rotation state is marked as DEPRECATED.
    
    Specified by:
    
    scheduleSecretVersionDeletion in interface Vaults
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateSecret
```
public UpdateSecretResponse updateSecret(UpdateSecretRequest request)
```
    Description copied from interface: Vaults
    
    Updates the properties of a secret. Specifically, you can update the version number of the secret to make that version number the current version. You can also update a secret’s description, its free-form or defined tags, rules and the secret contents. Updating the secret content automatically creates a new secret version. You cannot, however, update the current secret version number, secret contents, and secret rules at the same time. Furthermore, the secret must in an ACTIVE lifecycle state to be updated.
    
    This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.
    
    Specified by:
    
    updateSecret in interface Vaults
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public VaultsWaiters getWaiters()
```
    Description copied from interface: Vaults
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface Vaults
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public VaultsPaginators getPaginators()
```
    Description copied from interface: Vaults
    
    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 Vaults
    
    Returns:
    
    The service paginators.

Class VaultsClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

VaultsClient

VaultsClient

VaultsClient

VaultsClient

VaultsClient

VaultsClient

VaultsClient

VaultsClient

VaultsClient

Method Detail

builder

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

close

cancelSecretDeletion

cancelSecretVersionDeletion

changeSecretCompartment

createSecret

getSecret

getSecretVersion

listSecretVersions

listSecrets

scheduleSecretDeletion

scheduleSecretVersionDeletion

updateSecret

getWaiters

getPaginators