@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class BlockstorageAsyncClient extends BaseAsyncClient implements BlockstorageAsync
Async client implementation for Blockstorage service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response
to the call is an InputStream
, like getObject Api in object storage service,
developers need to process the stream in AsyncHandler, and not anywhere else, because the stream
will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done
with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or
the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the
AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine
whether or not the request was completed via Future.isDone/isCancelled.
Please refer to
https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
Modifier and Type | Class and Description |
---|---|
static class |
BlockstorageAsyncClient.Builder
Builder class for this client.
|
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 Blockstorage.
|
Constructor and Description |
---|
BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for Blockstorage.
public final String clientCommonLibraryVersion
@Deprecated public BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockstorageAsyncClient.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)
@Deprecated public BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockstorageAsyncClient.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
public static BlockstorageAsyncClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
BlockstorageAsync
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.
setRegion
in interface BlockstorageAsync
region
- The region of the service.public void setRegion(String regionId)
BlockstorageAsync
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
.
setRegion
in interface BlockstorageAsync
regionId
- The public region ID.public Future<ChangeBootVolumeBackupCompartmentResponse> changeBootVolumeBackupCompartment(ChangeBootVolumeBackupCompartmentRequest request, AsyncHandler<ChangeBootVolumeBackupCompartmentRequest,ChangeBootVolumeBackupCompartmentResponse> handler)
BlockstorageAsync
Moves a boot volume backup into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeBootVolumeBackupCompartment
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeBootVolumeCompartmentResponse> changeBootVolumeCompartment(ChangeBootVolumeCompartmentRequest request, AsyncHandler<ChangeBootVolumeCompartmentRequest,ChangeBootVolumeCompartmentResponse> handler)
BlockstorageAsync
Moves a boot volume into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeBootVolumeCompartment
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeVolumeBackupCompartmentResponse> changeVolumeBackupCompartment(ChangeVolumeBackupCompartmentRequest request, AsyncHandler<ChangeVolumeBackupCompartmentRequest,ChangeVolumeBackupCompartmentResponse> handler)
BlockstorageAsync
Moves a volume backup into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeVolumeBackupCompartment
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeVolumeCompartmentResponse> changeVolumeCompartment(ChangeVolumeCompartmentRequest request, AsyncHandler<ChangeVolumeCompartmentRequest,ChangeVolumeCompartmentResponse> handler)
BlockstorageAsync
Moves a volume into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeVolumeCompartment
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeVolumeGroupBackupCompartmentResponse> changeVolumeGroupBackupCompartment(ChangeVolumeGroupBackupCompartmentRequest request, AsyncHandler<ChangeVolumeGroupBackupCompartmentRequest,ChangeVolumeGroupBackupCompartmentResponse> handler)
BlockstorageAsync
Moves a volume group backup into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeVolumeGroupBackupCompartment
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeVolumeGroupCompartmentResponse> changeVolumeGroupCompartment(ChangeVolumeGroupCompartmentRequest request, AsyncHandler<ChangeVolumeGroupCompartmentRequest,ChangeVolumeGroupCompartmentResponse> handler)
BlockstorageAsync
Moves a volume group into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeVolumeGroupCompartment
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CopyBootVolumeBackupResponse> copyBootVolumeBackup(CopyBootVolumeBackupRequest request, AsyncHandler<CopyBootVolumeBackupRequest,CopyBootVolumeBackupResponse> handler)
BlockstorageAsync
Creates a boot volume backup copy in specified region. For general information about volume backups, see Overview of Boot Volume Backups
copyBootVolumeBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CopyVolumeBackupResponse> copyVolumeBackup(CopyVolumeBackupRequest request, AsyncHandler<CopyVolumeBackupRequest,CopyVolumeBackupResponse> handler)
BlockstorageAsync
Creates a volume backup copy in specified region. For general information about volume backups, see Overview of Block Volume Service Backups
copyVolumeBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CopyVolumeGroupBackupResponse> copyVolumeGroupBackup(CopyVolumeGroupBackupRequest request, AsyncHandler<CopyVolumeGroupBackupRequest,CopyVolumeGroupBackupResponse> handler)
BlockstorageAsync
Creates a volume group backup copy in specified region. For general information about volume group backups, see Overview of Block Volume Backups.
copyVolumeGroupBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateBootVolumeResponse> createBootVolume(CreateBootVolumeRequest request, AsyncHandler<CreateBootVolumeRequest,CreateBootVolumeResponse> handler)
BlockstorageAsync
Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. For general information about boot volumes, see Boot Volumes. You may optionally specify a display name for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.
createBootVolume
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateBootVolumeBackupResponse> createBootVolumeBackup(CreateBootVolumeBackupRequest request, AsyncHandler<CreateBootVolumeBackupRequest,CreateBootVolumeBackupResponse> handler)
BlockstorageAsync
Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups, see Overview of Boot Volume Backups
When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.
createBootVolumeBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateVolumeResponse> createVolume(CreateVolumeRequest request, AsyncHandler<CreateVolumeRequest,CreateVolumeResponse> handler)
BlockstorageAsync
Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from 50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB). For general information about block volumes, see Overview of Block Volume Service.
A volume and instance can be in separate compartments but must be in the same availability domain. For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about availability domains, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API.
You may optionally specify a *display name* for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.
createVolume
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateVolumeBackupResponse> createVolumeBackup(CreateVolumeBackupRequest request, AsyncHandler<CreateVolumeBackupRequest,CreateVolumeBackupResponse> handler)
BlockstorageAsync
Creates a new backup of the specified volume. For general information about volume backups, see Overview of Block Volume Service Backups
When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.
createVolumeBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateVolumeBackupPolicyResponse> createVolumeBackupPolicy(CreateVolumeBackupPolicyRequest request, AsyncHandler<CreateVolumeBackupPolicyRequest,CreateVolumeBackupPolicyResponse> handler)
BlockstorageAsync
Creates a new user defined backup policy.
For more information about Oracle defined backup policies and user defined backup policies, see [Policy-Based Backups](https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).
createVolumeBackupPolicy
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateVolumeBackupPolicyAssignmentResponse> createVolumeBackupPolicyAssignment(CreateVolumeBackupPolicyAssignmentRequest request, AsyncHandler<CreateVolumeBackupPolicyAssignmentRequest,CreateVolumeBackupPolicyAssignmentResponse> handler)
BlockstorageAsync
Assigns a volume backup policy to the specified volume. Note that a given volume can only have one backup policy assigned to it. If this operation is used for a volume that already has a different backup policy assigned, the prior backup policy will be silently unassigned.
createVolumeBackupPolicyAssignment
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateVolumeGroupResponse> createVolumeGroup(CreateVolumeGroupRequest request, AsyncHandler<CreateVolumeGroupRequest,CreateVolumeGroupResponse> handler)
BlockstorageAsync
Creates a new volume group in the specified compartment. A volume group is a collection of volumes and may be created from a list of volumes, cloning an existing volume group, or by restoring a volume group backup. You may optionally specify a display name for the volume group, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.
For more information, see [Volume Groups](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm).
createVolumeGroup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateVolumeGroupBackupResponse> createVolumeGroupBackup(CreateVolumeGroupBackupRequest request, AsyncHandler<CreateVolumeGroupBackupRequest,CreateVolumeGroupBackupResponse> handler)
BlockstorageAsync
Creates a new backup volume group of the specified volume group. For more information, see Volume Groups.
createVolumeGroupBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteBootVolumeResponse> deleteBootVolume(DeleteBootVolumeRequest request, AsyncHandler<DeleteBootVolumeRequest,DeleteBootVolumeResponse> handler)
BlockstorageAsync
Deletes the specified boot volume. The volume cannot have an active connection to an instance. To disconnect the boot volume from a connected instance, see Disconnecting From a Boot Volume. Warning: All data on the boot volume will be permanently lost when the boot volume is deleted.
deleteBootVolume
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteBootVolumeBackupResponse> deleteBootVolumeBackup(DeleteBootVolumeBackupRequest request, AsyncHandler<DeleteBootVolumeBackupRequest,DeleteBootVolumeBackupResponse> handler)
BlockstorageAsync
Deletes a boot volume backup.
deleteBootVolumeBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteBootVolumeKmsKeyResponse> deleteBootVolumeKmsKey(DeleteBootVolumeKmsKeyRequest request, AsyncHandler<DeleteBootVolumeKmsKeyRequest,DeleteBootVolumeKmsKeyResponse> handler)
BlockstorageAsync
Removes the specified boot volume’s assigned Vault Service encryption key.
deleteBootVolumeKmsKey
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteVolumeResponse> deleteVolume(DeleteVolumeRequest request, AsyncHandler<DeleteVolumeRequest,DeleteVolumeResponse> handler)
BlockstorageAsync
Deletes the specified volume. The volume cannot have an active connection to an instance. To disconnect the volume from a connected instance, see Disconnecting From a Volume. Warning: All data on the volume will be permanently lost when the volume is deleted.
deleteVolume
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteVolumeBackupResponse> deleteVolumeBackup(DeleteVolumeBackupRequest request, AsyncHandler<DeleteVolumeBackupRequest,DeleteVolumeBackupResponse> handler)
BlockstorageAsync
Deletes a volume backup.
deleteVolumeBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteVolumeBackupPolicyResponse> deleteVolumeBackupPolicy(DeleteVolumeBackupPolicyRequest request, AsyncHandler<DeleteVolumeBackupPolicyRequest,DeleteVolumeBackupPolicyResponse> handler)
BlockstorageAsync
Deletes a user defined backup policy. For more information about user defined backup policies, see Policy-Based Backups.
Avoid entering confidential information.
deleteVolumeBackupPolicy
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteVolumeBackupPolicyAssignmentResponse> deleteVolumeBackupPolicyAssignment(DeleteVolumeBackupPolicyAssignmentRequest request, AsyncHandler<DeleteVolumeBackupPolicyAssignmentRequest,DeleteVolumeBackupPolicyAssignmentResponse> handler)
BlockstorageAsync
Deletes a volume backup policy assignment.
deleteVolumeBackupPolicyAssignment
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteVolumeGroupResponse> deleteVolumeGroup(DeleteVolumeGroupRequest request, AsyncHandler<DeleteVolumeGroupRequest,DeleteVolumeGroupResponse> handler)
BlockstorageAsync
Deletes the specified volume group. Individual volumes are not deleted, only the volume group is deleted. For more information, see Volume Groups.
deleteVolumeGroup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteVolumeGroupBackupResponse> deleteVolumeGroupBackup(DeleteVolumeGroupBackupRequest request, AsyncHandler<DeleteVolumeGroupBackupRequest,DeleteVolumeGroupBackupResponse> handler)
BlockstorageAsync
Deletes a volume group backup. This operation deletes all the backups in the volume group. For more information, see Volume Groups.
deleteVolumeGroupBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteVolumeKmsKeyResponse> deleteVolumeKmsKey(DeleteVolumeKmsKeyRequest request, AsyncHandler<DeleteVolumeKmsKeyRequest,DeleteVolumeKmsKeyResponse> handler)
BlockstorageAsync
Removes the specified volume’s assigned Vault service encryption key.
deleteVolumeKmsKey
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetBlockVolumeReplicaResponse> getBlockVolumeReplica(GetBlockVolumeReplicaRequest request, AsyncHandler<GetBlockVolumeReplicaRequest,GetBlockVolumeReplicaResponse> handler)
BlockstorageAsync
Gets information for the specified block volume replica.
getBlockVolumeReplica
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetBootVolumeResponse> getBootVolume(GetBootVolumeRequest request, AsyncHandler<GetBootVolumeRequest,GetBootVolumeResponse> handler)
BlockstorageAsync
Gets information for the specified boot volume.
getBootVolume
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetBootVolumeBackupResponse> getBootVolumeBackup(GetBootVolumeBackupRequest request, AsyncHandler<GetBootVolumeBackupRequest,GetBootVolumeBackupResponse> handler)
BlockstorageAsync
Gets information for the specified boot volume backup.
getBootVolumeBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetBootVolumeKmsKeyResponse> getBootVolumeKmsKey(GetBootVolumeKmsKeyRequest request, AsyncHandler<GetBootVolumeKmsKeyRequest,GetBootVolumeKmsKeyResponse> handler)
BlockstorageAsync
Gets the Vault service encryption key assigned to the specified boot volume.
getBootVolumeKmsKey
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetBootVolumeReplicaResponse> getBootVolumeReplica(GetBootVolumeReplicaRequest request, AsyncHandler<GetBootVolumeReplicaRequest,GetBootVolumeReplicaResponse> handler)
BlockstorageAsync
Gets information for the specified boot volume replica.
getBootVolumeReplica
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetVolumeResponse> getVolume(GetVolumeRequest request, AsyncHandler<GetVolumeRequest,GetVolumeResponse> handler)
BlockstorageAsync
Gets information for the specified volume.
getVolume
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetVolumeBackupResponse> getVolumeBackup(GetVolumeBackupRequest request, AsyncHandler<GetVolumeBackupRequest,GetVolumeBackupResponse> handler)
BlockstorageAsync
Gets information for the specified volume backup.
getVolumeBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetVolumeBackupPolicyResponse> getVolumeBackupPolicy(GetVolumeBackupPolicyRequest request, AsyncHandler<GetVolumeBackupPolicyRequest,GetVolumeBackupPolicyResponse> handler)
BlockstorageAsync
Gets information for the specified volume backup policy.
getVolumeBackupPolicy
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetVolumeBackupPolicyAssetAssignmentResponse> getVolumeBackupPolicyAssetAssignment(GetVolumeBackupPolicyAssetAssignmentRequest request, AsyncHandler<GetVolumeBackupPolicyAssetAssignmentRequest,GetVolumeBackupPolicyAssetAssignmentResponse> handler)
BlockstorageAsync
Gets the volume backup policy assignment for the specified volume. The assetId
query
parameter is required, and the returned list will contain at most one item, since volume can
only have one volume backup policy assigned at a time.
getVolumeBackupPolicyAssetAssignment
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetVolumeBackupPolicyAssignmentResponse> getVolumeBackupPolicyAssignment(GetVolumeBackupPolicyAssignmentRequest request, AsyncHandler<GetVolumeBackupPolicyAssignmentRequest,GetVolumeBackupPolicyAssignmentResponse> handler)
BlockstorageAsync
Gets information for the specified volume backup policy assignment.
getVolumeBackupPolicyAssignment
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetVolumeGroupResponse> getVolumeGroup(GetVolumeGroupRequest request, AsyncHandler<GetVolumeGroupRequest,GetVolumeGroupResponse> handler)
BlockstorageAsync
Gets information for the specified volume group. For more information, see Volume Groups.
getVolumeGroup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetVolumeGroupBackupResponse> getVolumeGroupBackup(GetVolumeGroupBackupRequest request, AsyncHandler<GetVolumeGroupBackupRequest,GetVolumeGroupBackupResponse> handler)
BlockstorageAsync
Gets information for the specified volume group backup. For more information, see Volume Groups.
getVolumeGroupBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetVolumeGroupReplicaResponse> getVolumeGroupReplica(GetVolumeGroupReplicaRequest request, AsyncHandler<GetVolumeGroupReplicaRequest,GetVolumeGroupReplicaResponse> handler)
BlockstorageAsync
Gets information for the specified volume group replica.
getVolumeGroupReplica
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetVolumeKmsKeyResponse> getVolumeKmsKey(GetVolumeKmsKeyRequest request, AsyncHandler<GetVolumeKmsKeyRequest,GetVolumeKmsKeyResponse> handler)
BlockstorageAsync
Gets the Vault service encryption key assigned to the specified volume.
getVolumeKmsKey
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListBlockVolumeReplicasResponse> listBlockVolumeReplicas(ListBlockVolumeReplicasRequest request, AsyncHandler<ListBlockVolumeReplicasRequest,ListBlockVolumeReplicasResponse> handler)
BlockstorageAsync
Lists the block volume replicas in the specified compartment and availability domain.
listBlockVolumeReplicas
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListBootVolumeBackupsResponse> listBootVolumeBackups(ListBootVolumeBackupsRequest request, AsyncHandler<ListBootVolumeBackupsRequest,ListBootVolumeBackupsResponse> handler)
BlockstorageAsync
Lists the boot volume backups in the specified compartment. You can filter the results by boot volume.
listBootVolumeBackups
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListBootVolumeReplicasResponse> listBootVolumeReplicas(ListBootVolumeReplicasRequest request, AsyncHandler<ListBootVolumeReplicasRequest,ListBootVolumeReplicasResponse> handler)
BlockstorageAsync
Lists the boot volume replicas in the specified compartment and availability domain.
listBootVolumeReplicas
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListBootVolumesResponse> listBootVolumes(ListBootVolumesRequest request, AsyncHandler<ListBootVolumesRequest,ListBootVolumesResponse> handler)
BlockstorageAsync
Lists the boot volumes in the specified compartment and availability domain.
listBootVolumes
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListVolumeBackupPoliciesResponse> listVolumeBackupPolicies(ListVolumeBackupPoliciesRequest request, AsyncHandler<ListVolumeBackupPoliciesRequest,ListVolumeBackupPoliciesResponse> handler)
BlockstorageAsync
Lists all the volume backup policies available in the specified compartment.
For more information about Oracle defined backup policies and user defined backup policies, see [Policy-Based Backups](https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).
listVolumeBackupPolicies
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListVolumeBackupsResponse> listVolumeBackups(ListVolumeBackupsRequest request, AsyncHandler<ListVolumeBackupsRequest,ListVolumeBackupsResponse> handler)
BlockstorageAsync
Lists the volume backups in the specified compartment. You can filter the results by volume.
listVolumeBackups
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListVolumeGroupBackupsResponse> listVolumeGroupBackups(ListVolumeGroupBackupsRequest request, AsyncHandler<ListVolumeGroupBackupsRequest,ListVolumeGroupBackupsResponse> handler)
BlockstorageAsync
Lists the volume group backups in the specified compartment. You can filter the results by volume group. For more information, see Volume Groups.
listVolumeGroupBackups
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListVolumeGroupReplicasResponse> listVolumeGroupReplicas(ListVolumeGroupReplicasRequest request, AsyncHandler<ListVolumeGroupReplicasRequest,ListVolumeGroupReplicasResponse> handler)
BlockstorageAsync
Lists the volume group replicas in the specified compartment. You can filter the results by volume group. For more information, see Volume Group Replication.
listVolumeGroupReplicas
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListVolumeGroupsResponse> listVolumeGroups(ListVolumeGroupsRequest request, AsyncHandler<ListVolumeGroupsRequest,ListVolumeGroupsResponse> handler)
BlockstorageAsync
Lists the volume groups in the specified compartment and availability domain. For more information, see Volume Groups.
listVolumeGroups
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListVolumesResponse> listVolumes(ListVolumesRequest request, AsyncHandler<ListVolumesRequest,ListVolumesResponse> handler)
BlockstorageAsync
Lists the volumes in the specified compartment and availability domain.
listVolumes
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateBootVolumeResponse> updateBootVolume(UpdateBootVolumeRequest request, AsyncHandler<UpdateBootVolumeRequest,UpdateBootVolumeResponse> handler)
BlockstorageAsync
Updates the specified boot volume’s display name, defined tags, and free-form tags.
updateBootVolume
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateBootVolumeBackupResponse> updateBootVolumeBackup(UpdateBootVolumeBackupRequest request, AsyncHandler<UpdateBootVolumeBackupRequest,UpdateBootVolumeBackupResponse> handler)
BlockstorageAsync
Updates the display name for the specified boot volume backup. Avoid entering confidential information.
updateBootVolumeBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateBootVolumeKmsKeyResponse> updateBootVolumeKmsKey(UpdateBootVolumeKmsKeyRequest request, AsyncHandler<UpdateBootVolumeKmsKeyRequest,UpdateBootVolumeKmsKeyResponse> handler)
BlockstorageAsync
Updates the specified volume with a new Vault service master encryption key.
updateBootVolumeKmsKey
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateVolumeResponse> updateVolume(UpdateVolumeRequest request, AsyncHandler<UpdateVolumeRequest,UpdateVolumeResponse> handler)
BlockstorageAsync
Updates the specified volume’s display name. Avoid entering confidential information.
updateVolume
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateVolumeBackupResponse> updateVolumeBackup(UpdateVolumeBackupRequest request, AsyncHandler<UpdateVolumeBackupRequest,UpdateVolumeBackupResponse> handler)
BlockstorageAsync
Updates the display name for the specified volume backup. Avoid entering confidential information.
updateVolumeBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateVolumeBackupPolicyResponse> updateVolumeBackupPolicy(UpdateVolumeBackupPolicyRequest request, AsyncHandler<UpdateVolumeBackupPolicyRequest,UpdateVolumeBackupPolicyResponse> handler)
BlockstorageAsync
Updates a user defined backup policy. For more information about user defined backup policies, see Policy-Based Backups.
Avoid entering confidential information.
updateVolumeBackupPolicy
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateVolumeGroupResponse> updateVolumeGroup(UpdateVolumeGroupRequest request, AsyncHandler<UpdateVolumeGroupRequest,UpdateVolumeGroupResponse> handler)
BlockstorageAsync
Updates the set of volumes in a volume group along with the display name. Use this operation to add or remove volumes in a volume group. Specify the full list of volume IDs to include in the volume group. If the volume ID is not specified in the call, it will be removed from the volume group. Avoid entering confidential information.
For more information, see [Volume Groups](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm).
updateVolumeGroup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateVolumeGroupBackupResponse> updateVolumeGroupBackup(UpdateVolumeGroupBackupRequest request, AsyncHandler<UpdateVolumeGroupBackupRequest,UpdateVolumeGroupBackupResponse> handler)
BlockstorageAsync
Updates the display name for the specified volume group backup. For more information, see Volume Groups.
updateVolumeGroupBackup
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateVolumeKmsKeyResponse> updateVolumeKmsKey(UpdateVolumeKmsKeyRequest request, AsyncHandler<UpdateVolumeKmsKeyRequest,UpdateVolumeKmsKeyResponse> handler)
BlockstorageAsync
Updates the specified volume with a new Key Management master encryption key.
updateVolumeKmsKey
in interface BlockstorageAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
Copyright © 2016–2024. All rights reserved.