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 BlockstorageAsyncAsync 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 classBlockstorageAsyncClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for Blockstorage.
-
Constructor Summary
Constructors Constructor Description BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.BlockstorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
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 thebuilderinstead.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 thebuilderinstead.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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
BlockstorageAsyncClient
@Deprecated public BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
BlockstorageAsyncClient
@Deprecated public BlockstorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBlockstorageAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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:BlockstorageAsyncSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceBlockstorageAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:BlockstorageAsyncSets 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:
setRegionin interfaceBlockstorageAsync- Parameters:
regionId- The public region ID.
-
changeBootVolumeBackupCompartment
public Future<ChangeBootVolumeBackupCompartmentResponse> changeBootVolumeBackupCompartment(ChangeBootVolumeBackupCompartmentRequest request, AsyncHandler<ChangeBootVolumeBackupCompartmentRequest,ChangeBootVolumeBackupCompartmentResponse> handler)
Description copied from interface:BlockstorageAsyncMoves 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:
changeBootVolumeBackupCompartmentin 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:BlockstorageAsyncMoves 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:
changeBootVolumeCompartmentin 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:BlockstorageAsyncMoves 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:
changeVolumeBackupCompartmentin 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:BlockstorageAsyncMoves 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:
changeVolumeCompartmentin 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:BlockstorageAsyncMoves 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:
changeVolumeGroupBackupCompartmentin 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:BlockstorageAsyncMoves 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:
changeVolumeGroupCompartmentin 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:BlockstorageAsyncCreates a boot volume backup copy in specified region.For general information about volume backups, see Overview of Boot Volume Backups
- Specified by:
copyBootVolumeBackupin 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:BlockstorageAsyncCreates a volume backup copy in specified region.For general information about volume backups, see Overview of Block Volume Service Backups
- Specified by:
copyVolumeBackupin 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:BlockstorageAsyncCreates a volume group backup copy in specified region.For general information about volume group backups, see Overview of Block Volume Backups.
- Specified by:
copyVolumeGroupBackupin 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:BlockstorageAsyncCreates 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:
createBootVolumein 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:BlockstorageAsyncCreates 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:
createBootVolumeBackupin 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:BlockstorageAsyncCreates 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:
createVolumein 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:BlockstorageAsyncCreates 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:
createVolumeBackupin 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:BlockstorageAsyncCreates 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:
createVolumeBackupPolicyin 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:BlockstorageAsyncAssigns 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:
createVolumeBackupPolicyAssignmentin 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:BlockstorageAsyncCreates 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:
createVolumeGroupin 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:BlockstorageAsyncCreates a new backup volume group of the specified volume group.For more information, see Volume Groups.
- Specified by:
createVolumeGroupBackupin 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:BlockstorageAsyncDeletes 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:
deleteBootVolumein 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:BlockstorageAsyncDeletes a boot volume backup.- Specified by:
deleteBootVolumeBackupin 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:BlockstorageAsyncRemoves the specified boot volume’s assigned Vault Service encryption key.- Specified by:
deleteBootVolumeKmsKeyin 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:BlockstorageAsyncDeletes 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:
deleteVolumein 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:BlockstorageAsyncDeletes a volume backup.- Specified by:
deleteVolumeBackupin 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:BlockstorageAsyncDeletes a user defined backup policy.For more information about user defined backup policies, see Policy-Based Backups.
Avoid entering confidential information.
- Specified by:
deleteVolumeBackupPolicyin 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:BlockstorageAsyncDeletes a volume backup policy assignment.- Specified by:
deleteVolumeBackupPolicyAssignmentin 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:BlockstorageAsyncDeletes the specified volume group.Individual volumes are not deleted, only the volume group is deleted. For more information, see Volume Groups.
- Specified by:
deleteVolumeGroupin 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:BlockstorageAsyncDeletes a volume group backup.This operation deletes all the backups in the volume group. For more information, see Volume Groups.
- Specified by:
deleteVolumeGroupBackupin 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:BlockstorageAsyncRemoves the specified volume’s assigned Vault service encryption key.- Specified by:
deleteVolumeKmsKeyin 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:BlockstorageAsyncGets information for the specified block volume replica.- Specified by:
getBlockVolumeReplicain 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:BlockstorageAsyncGets information for the specified boot volume.- Specified by:
getBootVolumein 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:BlockstorageAsyncGets information for the specified boot volume backup.- Specified by:
getBootVolumeBackupin 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:BlockstorageAsyncGets the Vault service encryption key assigned to the specified boot volume.- Specified by:
getBootVolumeKmsKeyin 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:BlockstorageAsyncGets information for the specified boot volume replica.- Specified by:
getBootVolumeReplicain 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:BlockstorageAsyncGets information for the specified volume.- Specified by:
getVolumein 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:BlockstorageAsyncGets information for the specified volume backup.- Specified by:
getVolumeBackupin 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:BlockstorageAsyncGets information for the specified volume backup policy.- Specified by:
getVolumeBackupPolicyin 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:BlockstorageAsyncGets the volume backup policy assignment for the specified volume.The
assetIdquery 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:
getVolumeBackupPolicyAssetAssignmentin 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:BlockstorageAsyncGets information for the specified volume backup policy assignment.- Specified by:
getVolumeBackupPolicyAssignmentin 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:BlockstorageAsyncGets information for the specified volume group.For more information, see Volume Groups.
- Specified by:
getVolumeGroupin 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:BlockstorageAsyncGets information for the specified volume group backup.For more information, see Volume Groups.
- Specified by:
getVolumeGroupBackupin 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:BlockstorageAsyncGets information for the specified volume group replica.- Specified by:
getVolumeGroupReplicain 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:BlockstorageAsyncGets the Vault service encryption key assigned to the specified volume.- Specified by:
getVolumeKmsKeyin 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:BlockstorageAsyncLists the block volume replicas in the specified compartment and availability domain.- Specified by:
listBlockVolumeReplicasin 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:BlockstorageAsyncLists the boot volume backups in the specified compartment.You can filter the results by boot volume.
- Specified by:
listBootVolumeBackupsin 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:BlockstorageAsyncLists the boot volume replicas in the specified compartment and availability domain.- Specified by:
listBootVolumeReplicasin 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:BlockstorageAsyncLists the boot volumes in the specified compartment and availability domain.- Specified by:
listBootVolumesin 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:BlockstorageAsyncLists 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:
listVolumeBackupPoliciesin 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:BlockstorageAsyncLists the volume backups in the specified compartment.You can filter the results by volume.
- Specified by:
listVolumeBackupsin 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:BlockstorageAsyncLists the volume group backups in the specified compartment.You can filter the results by volume group. For more information, see Volume Groups.
- Specified by:
listVolumeGroupBackupsin 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:BlockstorageAsyncLists 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:
listVolumeGroupReplicasin 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:BlockstorageAsyncLists the volume groups in the specified compartment and availability domain.For more information, see Volume Groups.
- Specified by:
listVolumeGroupsin 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:BlockstorageAsyncLists the volumes in the specified compartment and availability domain.- Specified by:
listVolumesin 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:BlockstorageAsyncUpdates the specified boot volume’s display name, defined tags, and free-form tags.- Specified by:
updateBootVolumein 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:BlockstorageAsyncUpdates the display name for the specified boot volume backup.Avoid entering confidential information.
- Specified by:
updateBootVolumeBackupin 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:BlockstorageAsyncUpdates the specified volume with a new Vault service master encryption key.- Specified by:
updateBootVolumeKmsKeyin 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:BlockstorageAsyncUpdates the specified volume’s display name.Avoid entering confidential information.
- Specified by:
updateVolumein 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:BlockstorageAsyncUpdates the display name for the specified volume backup.Avoid entering confidential information.
- Specified by:
updateVolumeBackupin 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:BlockstorageAsyncUpdates a user defined backup policy.For more information about user defined backup policies, see Policy-Based Backups.
Avoid entering confidential information.
- Specified by:
updateVolumeBackupPolicyin 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:BlockstorageAsyncUpdates 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:
updateVolumeGroupin 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:BlockstorageAsyncUpdates the display name for the specified volume group backup.For more information, see Volume Groups.
- Specified by:
updateVolumeGroupBackupin 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:BlockstorageAsyncUpdates the specified volume with a new Key Management master encryption key.- Specified by:
updateVolumeKmsKeyin 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()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein 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)
-
-