Class BlockstorageAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.core.BlockstorageAsyncClient
-
- All Implemented Interfaces:
BlockstorageAsync
,AutoCloseable
@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 anInputStream
, 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BlockstorageAsyncClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field 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 Summary
Constructors Constructor Description BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.core.BlockstorageAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
BlockstorageAsyncClient
@Deprecated public BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeBlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
BlockstorageAsyncClient
@Deprecated public BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeBlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
BlockstorageAsyncClient
@Deprecated public BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeBlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
BlockstorageAsyncClient
@Deprecated public BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeBlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
BlockstorageAsyncClient
@Deprecated public BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeBlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
BlockstorageAsyncClient
@Deprecated public BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeBlockstorageAsyncClient.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)
-
BlockstorageAsyncClient
@Deprecated public BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeBlockstorageAsyncClient.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
-
-
Method Detail
-
builder
public static BlockstorageAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface: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.- Specified by:
setRegion
in interfaceBlockstorageAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface: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 callsetEndpoint
.- Specified by:
setRegion
in interfaceBlockstorageAsync
- Parameters:
regionId
- The public region ID.
-
changeBootVolumeBackupCompartment
public Future<ChangeBootVolumeBackupCompartmentResponse> changeBootVolumeBackupCompartment(ChangeBootVolumeBackupCompartmentRequest request, AsyncHandler<ChangeBootVolumeBackupCompartmentRequest,ChangeBootVolumeBackupCompartmentResponse> handler)
Description copied from interface: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.
- Specified by:
changeBootVolumeBackupCompartment
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeBootVolumeCompartment
public Future<ChangeBootVolumeCompartmentResponse> changeBootVolumeCompartment(ChangeBootVolumeCompartmentRequest request, AsyncHandler<ChangeBootVolumeCompartmentRequest,ChangeBootVolumeCompartmentResponse> handler)
Description copied from interface: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.
- Specified by:
changeBootVolumeCompartment
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeVolumeBackupCompartment
public Future<ChangeVolumeBackupCompartmentResponse> changeVolumeBackupCompartment(ChangeVolumeBackupCompartmentRequest request, AsyncHandler<ChangeVolumeBackupCompartmentRequest,ChangeVolumeBackupCompartmentResponse> handler)
Description copied from interface: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.
- Specified by:
changeVolumeBackupCompartment
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeVolumeCompartment
public Future<ChangeVolumeCompartmentResponse> changeVolumeCompartment(ChangeVolumeCompartmentRequest request, AsyncHandler<ChangeVolumeCompartmentRequest,ChangeVolumeCompartmentResponse> handler)
Description copied from interface: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.
- Specified by:
changeVolumeCompartment
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeVolumeGroupBackupCompartment
public Future<ChangeVolumeGroupBackupCompartmentResponse> changeVolumeGroupBackupCompartment(ChangeVolumeGroupBackupCompartmentRequest request, AsyncHandler<ChangeVolumeGroupBackupCompartmentRequest,ChangeVolumeGroupBackupCompartmentResponse> handler)
Description copied from interface: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.
- Specified by:
changeVolumeGroupBackupCompartment
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeVolumeGroupCompartment
public Future<ChangeVolumeGroupCompartmentResponse> changeVolumeGroupCompartment(ChangeVolumeGroupCompartmentRequest request, AsyncHandler<ChangeVolumeGroupCompartmentRequest,ChangeVolumeGroupCompartmentResponse> handler)
Description copied from interface: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.
- Specified by:
changeVolumeGroupCompartment
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
copyBootVolumeBackup
public Future<CopyBootVolumeBackupResponse> copyBootVolumeBackup(CopyBootVolumeBackupRequest request, AsyncHandler<CopyBootVolumeBackupRequest,CopyBootVolumeBackupResponse> handler)
Description copied from interface:BlockstorageAsync
Creates a boot volume backup copy in specified region.For general information about volume backups, see Overview of Boot Volume Backups
- Specified by:
copyBootVolumeBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
copyVolumeBackup
public Future<CopyVolumeBackupResponse> copyVolumeBackup(CopyVolumeBackupRequest request, AsyncHandler<CopyVolumeBackupRequest,CopyVolumeBackupResponse> handler)
Description copied from interface:BlockstorageAsync
Creates a volume backup copy in specified region.For general information about volume backups, see Overview of Block Volume Service Backups
- Specified by:
copyVolumeBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
copyVolumeGroupBackup
public Future<CopyVolumeGroupBackupResponse> copyVolumeGroupBackup(CopyVolumeGroupBackupRequest request, AsyncHandler<CopyVolumeGroupBackupRequest,CopyVolumeGroupBackupResponse> handler)
Description copied from interface:BlockstorageAsync
Creates a volume group backup copy in specified region.For general information about volume group backups, see Overview of Block Volume Backups.
- Specified by:
copyVolumeGroupBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createBootVolume
public Future<CreateBootVolumeResponse> createBootVolume(CreateBootVolumeRequest request, AsyncHandler<CreateBootVolumeRequest,CreateBootVolumeResponse> handler)
Description copied from interface: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.
- Specified by:
createBootVolume
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createBootVolumeBackup
public Future<CreateBootVolumeBackupResponse> createBootVolumeBackup(CreateBootVolumeBackupRequest request, AsyncHandler<CreateBootVolumeBackupRequest,CreateBootVolumeBackupResponse> handler)
Description copied from interface: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.
- Specified by:
createBootVolumeBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createVolume
public Future<CreateVolumeResponse> createVolume(CreateVolumeRequest request, AsyncHandler<CreateVolumeRequest,CreateVolumeResponse> handler)
Description copied from interface: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.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about availability domains, see [Regions and Availability Domains](https://docs.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.
- Specified by:
createVolume
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createVolumeBackup
public Future<CreateVolumeBackupResponse> createVolumeBackup(CreateVolumeBackupRequest request, AsyncHandler<CreateVolumeBackupRequest,CreateVolumeBackupResponse> handler)
Description copied from interface: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.
- Specified by:
createVolumeBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createVolumeBackupPolicy
public Future<CreateVolumeBackupPolicyResponse> createVolumeBackupPolicy(CreateVolumeBackupPolicyRequest request, AsyncHandler<CreateVolumeBackupPolicyRequest,CreateVolumeBackupPolicyResponse> handler)
Description copied from interface: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.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).
- Specified by:
createVolumeBackupPolicy
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createVolumeBackupPolicyAssignment
public Future<CreateVolumeBackupPolicyAssignmentResponse> createVolumeBackupPolicyAssignment(CreateVolumeBackupPolicyAssignmentRequest request, AsyncHandler<CreateVolumeBackupPolicyAssignmentRequest,CreateVolumeBackupPolicyAssignmentResponse> handler)
Description copied from interface: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.
- Specified by:
createVolumeBackupPolicyAssignment
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createVolumeGroup
public Future<CreateVolumeGroupResponse> createVolumeGroup(CreateVolumeGroupRequest request, AsyncHandler<CreateVolumeGroupRequest,CreateVolumeGroupResponse> handler)
Description copied from interface: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.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm).
- Specified by:
createVolumeGroup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createVolumeGroupBackup
public Future<CreateVolumeGroupBackupResponse> createVolumeGroupBackup(CreateVolumeGroupBackupRequest request, AsyncHandler<CreateVolumeGroupBackupRequest,CreateVolumeGroupBackupResponse> handler)
Description copied from interface:BlockstorageAsync
Creates a new backup volume group of the specified volume group.For more information, see Volume Groups.
- Specified by:
createVolumeGroupBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteBootVolume
public Future<DeleteBootVolumeResponse> deleteBootVolume(DeleteBootVolumeRequest request, AsyncHandler<DeleteBootVolumeRequest,DeleteBootVolumeResponse> handler)
Description copied from interface: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.
- Specified by:
deleteBootVolume
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteBootVolumeBackup
public Future<DeleteBootVolumeBackupResponse> deleteBootVolumeBackup(DeleteBootVolumeBackupRequest request, AsyncHandler<DeleteBootVolumeBackupRequest,DeleteBootVolumeBackupResponse> handler)
Description copied from interface:BlockstorageAsync
Deletes a boot volume backup.- Specified by:
deleteBootVolumeBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteBootVolumeKmsKey
public Future<DeleteBootVolumeKmsKeyResponse> deleteBootVolumeKmsKey(DeleteBootVolumeKmsKeyRequest request, AsyncHandler<DeleteBootVolumeKmsKeyRequest,DeleteBootVolumeKmsKeyResponse> handler)
Description copied from interface:BlockstorageAsync
Removes the specified boot volume’s assigned Vault Service encryption key.- Specified by:
deleteBootVolumeKmsKey
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteVolume
public Future<DeleteVolumeResponse> deleteVolume(DeleteVolumeRequest request, AsyncHandler<DeleteVolumeRequest,DeleteVolumeResponse> handler)
Description copied from interface: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.
- Specified by:
deleteVolume
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteVolumeBackup
public Future<DeleteVolumeBackupResponse> deleteVolumeBackup(DeleteVolumeBackupRequest request, AsyncHandler<DeleteVolumeBackupRequest,DeleteVolumeBackupResponse> handler)
Description copied from interface:BlockstorageAsync
Deletes a volume backup.- Specified by:
deleteVolumeBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteVolumeBackupPolicy
public Future<DeleteVolumeBackupPolicyResponse> deleteVolumeBackupPolicy(DeleteVolumeBackupPolicyRequest request, AsyncHandler<DeleteVolumeBackupPolicyRequest,DeleteVolumeBackupPolicyResponse> handler)
Description copied from interface:BlockstorageAsync
Deletes a user defined backup policy.For more information about user defined backup policies, see Policy-Based Backups.
Avoid entering confidential information.
- Specified by:
deleteVolumeBackupPolicy
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteVolumeBackupPolicyAssignment
public Future<DeleteVolumeBackupPolicyAssignmentResponse> deleteVolumeBackupPolicyAssignment(DeleteVolumeBackupPolicyAssignmentRequest request, AsyncHandler<DeleteVolumeBackupPolicyAssignmentRequest,DeleteVolumeBackupPolicyAssignmentResponse> handler)
Description copied from interface:BlockstorageAsync
Deletes a volume backup policy assignment.- Specified by:
deleteVolumeBackupPolicyAssignment
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteVolumeGroup
public Future<DeleteVolumeGroupResponse> deleteVolumeGroup(DeleteVolumeGroupRequest request, AsyncHandler<DeleteVolumeGroupRequest,DeleteVolumeGroupResponse> handler)
Description copied from interface:BlockstorageAsync
Deletes the specified volume group.Individual volumes are not deleted, only the volume group is deleted. For more information, see Volume Groups.
- Specified by:
deleteVolumeGroup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteVolumeGroupBackup
public Future<DeleteVolumeGroupBackupResponse> deleteVolumeGroupBackup(DeleteVolumeGroupBackupRequest request, AsyncHandler<DeleteVolumeGroupBackupRequest,DeleteVolumeGroupBackupResponse> handler)
Description copied from interface:BlockstorageAsync
Deletes a volume group backup.This operation deletes all the backups in the volume group. For more information, see Volume Groups.
- Specified by:
deleteVolumeGroupBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteVolumeKmsKey
public Future<DeleteVolumeKmsKeyResponse> deleteVolumeKmsKey(DeleteVolumeKmsKeyRequest request, AsyncHandler<DeleteVolumeKmsKeyRequest,DeleteVolumeKmsKeyResponse> handler)
Description copied from interface:BlockstorageAsync
Removes the specified volume’s assigned Vault service encryption key.- Specified by:
deleteVolumeKmsKey
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBlockVolumeReplica
public Future<GetBlockVolumeReplicaResponse> getBlockVolumeReplica(GetBlockVolumeReplicaRequest request, AsyncHandler<GetBlockVolumeReplicaRequest,GetBlockVolumeReplicaResponse> handler)
Description copied from interface:BlockstorageAsync
Gets information for the specified block volume replica.- Specified by:
getBlockVolumeReplica
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBootVolume
public Future<GetBootVolumeResponse> getBootVolume(GetBootVolumeRequest request, AsyncHandler<GetBootVolumeRequest,GetBootVolumeResponse> handler)
Description copied from interface:BlockstorageAsync
Gets information for the specified boot volume.- Specified by:
getBootVolume
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBootVolumeBackup
public Future<GetBootVolumeBackupResponse> getBootVolumeBackup(GetBootVolumeBackupRequest request, AsyncHandler<GetBootVolumeBackupRequest,GetBootVolumeBackupResponse> handler)
Description copied from interface:BlockstorageAsync
Gets information for the specified boot volume backup.- Specified by:
getBootVolumeBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBootVolumeKmsKey
public Future<GetBootVolumeKmsKeyResponse> getBootVolumeKmsKey(GetBootVolumeKmsKeyRequest request, AsyncHandler<GetBootVolumeKmsKeyRequest,GetBootVolumeKmsKeyResponse> handler)
Description copied from interface:BlockstorageAsync
Gets the Vault service encryption key assigned to the specified boot volume.- Specified by:
getBootVolumeKmsKey
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBootVolumeReplica
public Future<GetBootVolumeReplicaResponse> getBootVolumeReplica(GetBootVolumeReplicaRequest request, AsyncHandler<GetBootVolumeReplicaRequest,GetBootVolumeReplicaResponse> handler)
Description copied from interface:BlockstorageAsync
Gets information for the specified boot volume replica.- Specified by:
getBootVolumeReplica
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getVolume
public Future<GetVolumeResponse> getVolume(GetVolumeRequest request, AsyncHandler<GetVolumeRequest,GetVolumeResponse> handler)
Description copied from interface:BlockstorageAsync
Gets information for the specified volume.- Specified by:
getVolume
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getVolumeBackup
public Future<GetVolumeBackupResponse> getVolumeBackup(GetVolumeBackupRequest request, AsyncHandler<GetVolumeBackupRequest,GetVolumeBackupResponse> handler)
Description copied from interface:BlockstorageAsync
Gets information for the specified volume backup.- Specified by:
getVolumeBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getVolumeBackupPolicy
public Future<GetVolumeBackupPolicyResponse> getVolumeBackupPolicy(GetVolumeBackupPolicyRequest request, AsyncHandler<GetVolumeBackupPolicyRequest,GetVolumeBackupPolicyResponse> handler)
Description copied from interface:BlockstorageAsync
Gets information for the specified volume backup policy.- Specified by:
getVolumeBackupPolicy
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getVolumeBackupPolicyAssetAssignment
public Future<GetVolumeBackupPolicyAssetAssignmentResponse> getVolumeBackupPolicyAssetAssignment(GetVolumeBackupPolicyAssetAssignmentRequest request, AsyncHandler<GetVolumeBackupPolicyAssetAssignmentRequest,GetVolumeBackupPolicyAssetAssignmentResponse> handler)
Description copied from interface: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.- Specified by:
getVolumeBackupPolicyAssetAssignment
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getVolumeBackupPolicyAssignment
public Future<GetVolumeBackupPolicyAssignmentResponse> getVolumeBackupPolicyAssignment(GetVolumeBackupPolicyAssignmentRequest request, AsyncHandler<GetVolumeBackupPolicyAssignmentRequest,GetVolumeBackupPolicyAssignmentResponse> handler)
Description copied from interface:BlockstorageAsync
Gets information for the specified volume backup policy assignment.- Specified by:
getVolumeBackupPolicyAssignment
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getVolumeGroup
public Future<GetVolumeGroupResponse> getVolumeGroup(GetVolumeGroupRequest request, AsyncHandler<GetVolumeGroupRequest,GetVolumeGroupResponse> handler)
Description copied from interface:BlockstorageAsync
Gets information for the specified volume group.For more information, see Volume Groups.
- Specified by:
getVolumeGroup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getVolumeGroupBackup
public Future<GetVolumeGroupBackupResponse> getVolumeGroupBackup(GetVolumeGroupBackupRequest request, AsyncHandler<GetVolumeGroupBackupRequest,GetVolumeGroupBackupResponse> handler)
Description copied from interface:BlockstorageAsync
Gets information for the specified volume group backup.For more information, see Volume Groups.
- Specified by:
getVolumeGroupBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getVolumeGroupReplica
public Future<GetVolumeGroupReplicaResponse> getVolumeGroupReplica(GetVolumeGroupReplicaRequest request, AsyncHandler<GetVolumeGroupReplicaRequest,GetVolumeGroupReplicaResponse> handler)
Description copied from interface:BlockstorageAsync
Gets information for the specified volume group replica.- Specified by:
getVolumeGroupReplica
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getVolumeKmsKey
public Future<GetVolumeKmsKeyResponse> getVolumeKmsKey(GetVolumeKmsKeyRequest request, AsyncHandler<GetVolumeKmsKeyRequest,GetVolumeKmsKeyResponse> handler)
Description copied from interface:BlockstorageAsync
Gets the Vault service encryption key assigned to the specified volume.- Specified by:
getVolumeKmsKey
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBlockVolumeReplicas
public Future<ListBlockVolumeReplicasResponse> listBlockVolumeReplicas(ListBlockVolumeReplicasRequest request, AsyncHandler<ListBlockVolumeReplicasRequest,ListBlockVolumeReplicasResponse> handler)
Description copied from interface:BlockstorageAsync
Lists the block volume replicas in the specified compartment and availability domain.- Specified by:
listBlockVolumeReplicas
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBootVolumeBackups
public Future<ListBootVolumeBackupsResponse> listBootVolumeBackups(ListBootVolumeBackupsRequest request, AsyncHandler<ListBootVolumeBackupsRequest,ListBootVolumeBackupsResponse> handler)
Description copied from interface:BlockstorageAsync
Lists the boot volume backups in the specified compartment.You can filter the results by boot volume.
- Specified by:
listBootVolumeBackups
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBootVolumeReplicas
public Future<ListBootVolumeReplicasResponse> listBootVolumeReplicas(ListBootVolumeReplicasRequest request, AsyncHandler<ListBootVolumeReplicasRequest,ListBootVolumeReplicasResponse> handler)
Description copied from interface:BlockstorageAsync
Lists the boot volume replicas in the specified compartment and availability domain.- Specified by:
listBootVolumeReplicas
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBootVolumes
public Future<ListBootVolumesResponse> listBootVolumes(ListBootVolumesRequest request, AsyncHandler<ListBootVolumesRequest,ListBootVolumesResponse> handler)
Description copied from interface:BlockstorageAsync
Lists the boot volumes in the specified compartment and availability domain.- Specified by:
listBootVolumes
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listVolumeBackupPolicies
public Future<ListVolumeBackupPoliciesResponse> listVolumeBackupPolicies(ListVolumeBackupPoliciesRequest request, AsyncHandler<ListVolumeBackupPoliciesRequest,ListVolumeBackupPoliciesResponse> handler)
Description copied from interface: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.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).
- Specified by:
listVolumeBackupPolicies
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listVolumeBackups
public Future<ListVolumeBackupsResponse> listVolumeBackups(ListVolumeBackupsRequest request, AsyncHandler<ListVolumeBackupsRequest,ListVolumeBackupsResponse> handler)
Description copied from interface:BlockstorageAsync
Lists the volume backups in the specified compartment.You can filter the results by volume.
- Specified by:
listVolumeBackups
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listVolumeGroupBackups
public Future<ListVolumeGroupBackupsResponse> listVolumeGroupBackups(ListVolumeGroupBackupsRequest request, AsyncHandler<ListVolumeGroupBackupsRequest,ListVolumeGroupBackupsResponse> handler)
Description copied from interface:BlockstorageAsync
Lists the volume group backups in the specified compartment.You can filter the results by volume group. For more information, see Volume Groups.
- Specified by:
listVolumeGroupBackups
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listVolumeGroupReplicas
public Future<ListVolumeGroupReplicasResponse> listVolumeGroupReplicas(ListVolumeGroupReplicasRequest request, AsyncHandler<ListVolumeGroupReplicasRequest,ListVolumeGroupReplicasResponse> handler)
Description copied from interface: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.
- Specified by:
listVolumeGroupReplicas
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listVolumeGroups
public Future<ListVolumeGroupsResponse> listVolumeGroups(ListVolumeGroupsRequest request, AsyncHandler<ListVolumeGroupsRequest,ListVolumeGroupsResponse> handler)
Description copied from interface:BlockstorageAsync
Lists the volume groups in the specified compartment and availability domain.For more information, see Volume Groups.
- Specified by:
listVolumeGroups
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listVolumes
public Future<ListVolumesResponse> listVolumes(ListVolumesRequest request, AsyncHandler<ListVolumesRequest,ListVolumesResponse> handler)
Description copied from interface:BlockstorageAsync
Lists the volumes in the specified compartment and availability domain.- Specified by:
listVolumes
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateBootVolume
public Future<UpdateBootVolumeResponse> updateBootVolume(UpdateBootVolumeRequest request, AsyncHandler<UpdateBootVolumeRequest,UpdateBootVolumeResponse> handler)
Description copied from interface:BlockstorageAsync
Updates the specified boot volume’s display name, defined tags, and free-form tags.- Specified by:
updateBootVolume
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateBootVolumeBackup
public Future<UpdateBootVolumeBackupResponse> updateBootVolumeBackup(UpdateBootVolumeBackupRequest request, AsyncHandler<UpdateBootVolumeBackupRequest,UpdateBootVolumeBackupResponse> handler)
Description copied from interface:BlockstorageAsync
Updates the display name for the specified boot volume backup.Avoid entering confidential information.
- Specified by:
updateBootVolumeBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateBootVolumeKmsKey
public Future<UpdateBootVolumeKmsKeyResponse> updateBootVolumeKmsKey(UpdateBootVolumeKmsKeyRequest request, AsyncHandler<UpdateBootVolumeKmsKeyRequest,UpdateBootVolumeKmsKeyResponse> handler)
Description copied from interface:BlockstorageAsync
Updates the specified volume with a new Vault service master encryption key.- Specified by:
updateBootVolumeKmsKey
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateVolume
public Future<UpdateVolumeResponse> updateVolume(UpdateVolumeRequest request, AsyncHandler<UpdateVolumeRequest,UpdateVolumeResponse> handler)
Description copied from interface:BlockstorageAsync
Updates the specified volume’s display name.Avoid entering confidential information.
- Specified by:
updateVolume
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateVolumeBackup
public Future<UpdateVolumeBackupResponse> updateVolumeBackup(UpdateVolumeBackupRequest request, AsyncHandler<UpdateVolumeBackupRequest,UpdateVolumeBackupResponse> handler)
Description copied from interface:BlockstorageAsync
Updates the display name for the specified volume backup.Avoid entering confidential information.
- Specified by:
updateVolumeBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateVolumeBackupPolicy
public Future<UpdateVolumeBackupPolicyResponse> updateVolumeBackupPolicy(UpdateVolumeBackupPolicyRequest request, AsyncHandler<UpdateVolumeBackupPolicyRequest,UpdateVolumeBackupPolicyResponse> handler)
Description copied from interface:BlockstorageAsync
Updates a user defined backup policy.For more information about user defined backup policies, see Policy-Based Backups.
Avoid entering confidential information.
- Specified by:
updateVolumeBackupPolicy
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateVolumeGroup
public Future<UpdateVolumeGroupResponse> updateVolumeGroup(UpdateVolumeGroupRequest request, AsyncHandler<UpdateVolumeGroupRequest,UpdateVolumeGroupResponse> handler)
Description copied from interface: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.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm).
- Specified by:
updateVolumeGroup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateVolumeGroupBackup
public Future<UpdateVolumeGroupBackupResponse> updateVolumeGroupBackup(UpdateVolumeGroupBackupRequest request, AsyncHandler<UpdateVolumeGroupBackupRequest,UpdateVolumeGroupBackupResponse> handler)
Description copied from interface:BlockstorageAsync
Updates the display name for the specified volume group backup.For more information, see Volume Groups.
- Specified by:
updateVolumeGroupBackup
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateVolumeKmsKey
public Future<UpdateVolumeKmsKeyResponse> updateVolumeKmsKey(UpdateVolumeKmsKeyRequest request, AsyncHandler<UpdateVolumeKmsKeyRequest,UpdateVolumeKmsKeyResponse> handler)
Description copied from interface:BlockstorageAsync
Updates the specified volume with a new Key Management master encryption key.- Specified by:
updateVolumeKmsKey
in interfaceBlockstorageAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
getMinimumClientCommonLibraryVersionFromClient
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
-
clientCall
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)
-
-