Interface Blockstorage
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
BlockstorageClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public interface Blockstorage extends AutoCloseable
Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes.For more information, see the console documentation for the Networking, Compute, and Block Volume services. The required permissions are documented in the Details for the Core Services article.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description ChangeBootVolumeBackupCompartmentResponse
changeBootVolumeBackupCompartment(ChangeBootVolumeBackupCompartmentRequest request)
Moves a boot volume backup into a different compartment within the same tenancy.ChangeBootVolumeCompartmentResponse
changeBootVolumeCompartment(ChangeBootVolumeCompartmentRequest request)
Moves a boot volume into a different compartment within the same tenancy.ChangeVolumeBackupCompartmentResponse
changeVolumeBackupCompartment(ChangeVolumeBackupCompartmentRequest request)
Moves a volume backup into a different compartment within the same tenancy.ChangeVolumeCompartmentResponse
changeVolumeCompartment(ChangeVolumeCompartmentRequest request)
Moves a volume into a different compartment within the same tenancy.ChangeVolumeGroupBackupCompartmentResponse
changeVolumeGroupBackupCompartment(ChangeVolumeGroupBackupCompartmentRequest request)
Moves a volume group backup into a different compartment within the same tenancy.ChangeVolumeGroupCompartmentResponse
changeVolumeGroupCompartment(ChangeVolumeGroupCompartmentRequest request)
Moves a volume group into a different compartment within the same tenancy.CopyBootVolumeBackupResponse
copyBootVolumeBackup(CopyBootVolumeBackupRequest request)
Creates a boot volume backup copy in specified region.CopyVolumeBackupResponse
copyVolumeBackup(CopyVolumeBackupRequest request)
Creates a volume backup copy in specified region.CopyVolumeGroupBackupResponse
copyVolumeGroupBackup(CopyVolumeGroupBackupRequest request)
Creates a volume group backup copy in specified region.CreateBootVolumeResponse
createBootVolume(CreateBootVolumeRequest request)
Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup.CreateBootVolumeBackupResponse
createBootVolumeBackup(CreateBootVolumeBackupRequest request)
Creates a new boot volume backup of the specified boot volume.CreateVolumeResponse
createVolume(CreateVolumeRequest request)
Creates a new volume in the specified compartment.CreateVolumeBackupResponse
createVolumeBackup(CreateVolumeBackupRequest request)
Creates a new backup of the specified volume.CreateVolumeBackupPolicyResponse
createVolumeBackupPolicy(CreateVolumeBackupPolicyRequest request)
Creates a new user defined backup policy.CreateVolumeBackupPolicyAssignmentResponse
createVolumeBackupPolicyAssignment(CreateVolumeBackupPolicyAssignmentRequest request)
Assigns a volume backup policy to the specified volume.CreateVolumeGroupResponse
createVolumeGroup(CreateVolumeGroupRequest request)
Creates a new volume group in the specified compartment.CreateVolumeGroupBackupResponse
createVolumeGroupBackup(CreateVolumeGroupBackupRequest request)
Creates a new backup volume group of the specified volume group.DeleteBootVolumeResponse
deleteBootVolume(DeleteBootVolumeRequest request)
Deletes the specified boot volume.DeleteBootVolumeBackupResponse
deleteBootVolumeBackup(DeleteBootVolumeBackupRequest request)
Deletes a boot volume backup.DeleteBootVolumeKmsKeyResponse
deleteBootVolumeKmsKey(DeleteBootVolumeKmsKeyRequest request)
Removes the specified boot volume’s assigned Vault Service encryption key.DeleteVolumeResponse
deleteVolume(DeleteVolumeRequest request)
Deletes the specified volume.DeleteVolumeBackupResponse
deleteVolumeBackup(DeleteVolumeBackupRequest request)
Deletes a volume backup.DeleteVolumeBackupPolicyResponse
deleteVolumeBackupPolicy(DeleteVolumeBackupPolicyRequest request)
Deletes a user defined backup policy.DeleteVolumeBackupPolicyAssignmentResponse
deleteVolumeBackupPolicyAssignment(DeleteVolumeBackupPolicyAssignmentRequest request)
Deletes a volume backup policy assignment.DeleteVolumeGroupResponse
deleteVolumeGroup(DeleteVolumeGroupRequest request)
Deletes the specified volume group.DeleteVolumeGroupBackupResponse
deleteVolumeGroupBackup(DeleteVolumeGroupBackupRequest request)
Deletes a volume group backup.DeleteVolumeKmsKeyResponse
deleteVolumeKmsKey(DeleteVolumeKmsKeyRequest request)
Removes the specified volume’s assigned Vault service encryption key.GetBlockVolumeReplicaResponse
getBlockVolumeReplica(GetBlockVolumeReplicaRequest request)
Gets information for the specified block volume replica.GetBootVolumeResponse
getBootVolume(GetBootVolumeRequest request)
Gets information for the specified boot volume.GetBootVolumeBackupResponse
getBootVolumeBackup(GetBootVolumeBackupRequest request)
Gets information for the specified boot volume backup.GetBootVolumeKmsKeyResponse
getBootVolumeKmsKey(GetBootVolumeKmsKeyRequest request)
Gets the Vault service encryption key assigned to the specified boot volume.GetBootVolumeReplicaResponse
getBootVolumeReplica(GetBootVolumeReplicaRequest request)
Gets information for the specified boot volume replica.String
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)BlockstoragePaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetVolumeResponse
getVolume(GetVolumeRequest request)
Gets information for the specified volume.GetVolumeBackupResponse
getVolumeBackup(GetVolumeBackupRequest request)
Gets information for the specified volume backup.GetVolumeBackupPolicyResponse
getVolumeBackupPolicy(GetVolumeBackupPolicyRequest request)
Gets information for the specified volume backup policy.GetVolumeBackupPolicyAssetAssignmentResponse
getVolumeBackupPolicyAssetAssignment(GetVolumeBackupPolicyAssetAssignmentRequest request)
Gets the volume backup policy assignment for the specified volume.GetVolumeBackupPolicyAssignmentResponse
getVolumeBackupPolicyAssignment(GetVolumeBackupPolicyAssignmentRequest request)
Gets information for the specified volume backup policy assignment.GetVolumeGroupResponse
getVolumeGroup(GetVolumeGroupRequest request)
Gets information for the specified volume group.GetVolumeGroupBackupResponse
getVolumeGroupBackup(GetVolumeGroupBackupRequest request)
Gets information for the specified volume group backup.GetVolumeGroupReplicaResponse
getVolumeGroupReplica(GetVolumeGroupReplicaRequest request)
Gets information for the specified volume group replica.GetVolumeKmsKeyResponse
getVolumeKmsKey(GetVolumeKmsKeyRequest request)
Gets the Vault service encryption key assigned to the specified volume.BlockstorageWaiters
getWaiters()
Deprecated.usenewWaiters(WorkRequest)
instead.ListBlockVolumeReplicasResponse
listBlockVolumeReplicas(ListBlockVolumeReplicasRequest request)
Lists the block volume replicas in the specified compartment and availability domain.ListBootVolumeBackupsResponse
listBootVolumeBackups(ListBootVolumeBackupsRequest request)
Lists the boot volume backups in the specified compartment.ListBootVolumeReplicasResponse
listBootVolumeReplicas(ListBootVolumeReplicasRequest request)
Lists the boot volume replicas in the specified compartment and availability domain.ListBootVolumesResponse
listBootVolumes(ListBootVolumesRequest request)
Lists the boot volumes in the specified compartment and availability domain.ListVolumeBackupPoliciesResponse
listVolumeBackupPolicies(ListVolumeBackupPoliciesRequest request)
Lists all the volume backup policies available in the specified compartment.ListVolumeBackupsResponse
listVolumeBackups(ListVolumeBackupsRequest request)
Lists the volume backups in the specified compartment.ListVolumeGroupBackupsResponse
listVolumeGroupBackups(ListVolumeGroupBackupsRequest request)
Lists the volume group backups in the specified compartment.ListVolumeGroupReplicasResponse
listVolumeGroupReplicas(ListVolumeGroupReplicasRequest request)
Lists the volume group replicas in the specified compartment.ListVolumeGroupsResponse
listVolumeGroups(ListVolumeGroupsRequest request)
Lists the volume groups in the specified compartment and availability domain.ListVolumesResponse
listVolumes(ListVolumesRequest request)
Lists the volumes in the specified compartment and availability domain.BlockstorageWaiters
newWaiters(WorkRequest workRequestClient)
Creates a new BlockstorageWaiters for resources for this service.void
refreshClient()
Rebuilds the client from scratch.void
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).void
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).void
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).UpdateBootVolumeResponse
updateBootVolume(UpdateBootVolumeRequest request)
Updates the specified boot volume’s display name, defined tags, and free-form tags.UpdateBootVolumeBackupResponse
updateBootVolumeBackup(UpdateBootVolumeBackupRequest request)
Updates the display name for the specified boot volume backup.UpdateBootVolumeKmsKeyResponse
updateBootVolumeKmsKey(UpdateBootVolumeKmsKeyRequest request)
Updates the specified volume with a new Vault service master encryption key.UpdateVolumeResponse
updateVolume(UpdateVolumeRequest request)
Updates the specified volume’s display name.UpdateVolumeBackupResponse
updateVolumeBackup(UpdateVolumeBackupRequest request)
Updates the display name for the specified volume backup.UpdateVolumeBackupPolicyResponse
updateVolumeBackupPolicy(UpdateVolumeBackupPolicyRequest request)
Updates a user defined backup policy.UpdateVolumeGroupResponse
updateVolumeGroup(UpdateVolumeGroupRequest request)
Updates the set of volumes in a volume group along with the display name.UpdateVolumeGroupBackupResponse
updateVolumeGroupBackup(UpdateVolumeGroupBackupRequest request)
Updates the display name for the specified volume group backup.UpdateVolumeKmsKeyResponse
updateVolumeKmsKey(UpdateVolumeKmsKeyRequest request)
Updates the specified volume with a new Key Management master encryption key.void
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
refreshClient
void refreshClient()
Rebuilds the client from scratch.Useful to refresh certificates.
-
setEndpoint
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).- Parameters:
endpoint
- The endpoint of the service.
-
getEndpoint
String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
-
setRegion
void setRegion(Region region)
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.- Parameters:
region
- The region of the service.
-
setRegion
void setRegion(String regionId)
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
.- Parameters:
regionId
- The public region ID.
-
useRealmSpecificEndpointTemplate
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
- Parameters:
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint template
-
changeBootVolumeBackupCompartment
ChangeBootVolumeBackupCompartmentResponse changeBootVolumeBackupCompartment(ChangeBootVolumeBackupCompartmentRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ChangeBootVolumeBackupCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeBootVolumeBackupCompartment API.
-
changeBootVolumeCompartment
ChangeBootVolumeCompartmentResponse changeBootVolumeCompartment(ChangeBootVolumeCompartmentRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ChangeBootVolumeCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeBootVolumeCompartment API.
-
changeVolumeBackupCompartment
ChangeVolumeBackupCompartmentResponse changeVolumeBackupCompartment(ChangeVolumeBackupCompartmentRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ChangeVolumeBackupCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeVolumeBackupCompartment API.
-
changeVolumeCompartment
ChangeVolumeCompartmentResponse changeVolumeCompartment(ChangeVolumeCompartmentRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ChangeVolumeCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeVolumeCompartment API.
-
changeVolumeGroupBackupCompartment
ChangeVolumeGroupBackupCompartmentResponse changeVolumeGroupBackupCompartment(ChangeVolumeGroupBackupCompartmentRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ChangeVolumeGroupBackupCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeVolumeGroupBackupCompartment API.
-
changeVolumeGroupCompartment
ChangeVolumeGroupCompartmentResponse changeVolumeGroupCompartment(ChangeVolumeGroupCompartmentRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ChangeVolumeGroupCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeVolumeGroupCompartment API.
-
copyBootVolumeBackup
CopyBootVolumeBackupResponse copyBootVolumeBackup(CopyBootVolumeBackupRequest request)
Creates a boot volume backup copy in specified region.For general information about volume backups, see Overview of Boot Volume Backups
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/CopyBootVolumeBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CopyBootVolumeBackup API.
-
copyVolumeBackup
CopyVolumeBackupResponse copyVolumeBackup(CopyVolumeBackupRequest request)
Creates a volume backup copy in specified region.For general information about volume backups, see Overview of Block Volume Service Backups
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/CopyVolumeBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CopyVolumeBackup API.
-
copyVolumeGroupBackup
CopyVolumeGroupBackupResponse copyVolumeGroupBackup(CopyVolumeGroupBackupRequest request)
Creates a volume group backup copy in specified region.For general information about volume group backups, see Overview of Block Volume Backups.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/CopyVolumeGroupBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CopyVolumeGroupBackup API.
-
createBootVolume
CreateBootVolumeResponse createBootVolume(CreateBootVolumeRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/CreateBootVolumeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateBootVolume API.
-
createBootVolumeBackup
CreateBootVolumeBackupResponse createBootVolumeBackup(CreateBootVolumeBackupRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/CreateBootVolumeBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateBootVolumeBackup API.
-
createVolume
CreateVolumeResponse createVolume(CreateVolumeRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/CreateVolumeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateVolume API.
-
createVolumeBackup
CreateVolumeBackupResponse createVolumeBackup(CreateVolumeBackupRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/CreateVolumeBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateVolumeBackup API.
-
createVolumeBackupPolicy
CreateVolumeBackupPolicyResponse createVolumeBackupPolicy(CreateVolumeBackupPolicyRequest request)
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).
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/CreateVolumeBackupPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateVolumeBackupPolicy API.
-
createVolumeBackupPolicyAssignment
CreateVolumeBackupPolicyAssignmentResponse createVolumeBackupPolicyAssignment(CreateVolumeBackupPolicyAssignmentRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/CreateVolumeBackupPolicyAssignmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateVolumeBackupPolicyAssignment API.
-
createVolumeGroup
CreateVolumeGroupResponse createVolumeGroup(CreateVolumeGroupRequest request)
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).
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/CreateVolumeGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateVolumeGroup API.
-
createVolumeGroupBackup
CreateVolumeGroupBackupResponse createVolumeGroupBackup(CreateVolumeGroupBackupRequest request)
Creates a new backup volume group of the specified volume group.For more information, see Volume Groups.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/CreateVolumeGroupBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateVolumeGroupBackup API.
-
deleteBootVolume
DeleteBootVolumeResponse deleteBootVolume(DeleteBootVolumeRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/DeleteBootVolumeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteBootVolume API.
-
deleteBootVolumeBackup
DeleteBootVolumeBackupResponse deleteBootVolumeBackup(DeleteBootVolumeBackupRequest request)
Deletes a boot volume backup.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/DeleteBootVolumeBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteBootVolumeBackup API.
-
deleteBootVolumeKmsKey
DeleteBootVolumeKmsKeyResponse deleteBootVolumeKmsKey(DeleteBootVolumeKmsKeyRequest request)
Removes the specified boot volume’s assigned Vault Service encryption key.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/DeleteBootVolumeKmsKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteBootVolumeKmsKey API.
-
deleteVolume
DeleteVolumeResponse deleteVolume(DeleteVolumeRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/DeleteVolumeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteVolume API.
-
deleteVolumeBackup
DeleteVolumeBackupResponse deleteVolumeBackup(DeleteVolumeBackupRequest request)
Deletes a volume backup.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/DeleteVolumeBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteVolumeBackup API.
-
deleteVolumeBackupPolicy
DeleteVolumeBackupPolicyResponse deleteVolumeBackupPolicy(DeleteVolumeBackupPolicyRequest request)
Deletes a user defined backup policy.For more information about user defined backup policies, see Policy-Based Backups.
Avoid entering confidential information.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/DeleteVolumeBackupPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteVolumeBackupPolicy API.
-
deleteVolumeBackupPolicyAssignment
DeleteVolumeBackupPolicyAssignmentResponse deleteVolumeBackupPolicyAssignment(DeleteVolumeBackupPolicyAssignmentRequest request)
Deletes a volume backup policy assignment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/DeleteVolumeBackupPolicyAssignmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteVolumeBackupPolicyAssignment API.
-
deleteVolumeGroup
DeleteVolumeGroupResponse deleteVolumeGroup(DeleteVolumeGroupRequest request)
Deletes the specified volume group.Individual volumes are not deleted, only the volume group is deleted. For more information, see Volume Groups.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/DeleteVolumeGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteVolumeGroup API.
-
deleteVolumeGroupBackup
DeleteVolumeGroupBackupResponse deleteVolumeGroupBackup(DeleteVolumeGroupBackupRequest request)
Deletes a volume group backup.This operation deletes all the backups in the volume group. For more information, see Volume Groups.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/DeleteVolumeGroupBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteVolumeGroupBackup API.
-
deleteVolumeKmsKey
DeleteVolumeKmsKeyResponse deleteVolumeKmsKey(DeleteVolumeKmsKeyRequest request)
Removes the specified volume’s assigned Vault service encryption key.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/DeleteVolumeKmsKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteVolumeKmsKey API.
-
getBlockVolumeReplica
GetBlockVolumeReplicaResponse getBlockVolumeReplica(GetBlockVolumeReplicaRequest request)
Gets information for the specified block volume replica.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetBlockVolumeReplicaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBlockVolumeReplica API.
-
getBootVolume
GetBootVolumeResponse getBootVolume(GetBootVolumeRequest request)
Gets information for the specified boot volume.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetBootVolumeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBootVolume API.
-
getBootVolumeBackup
GetBootVolumeBackupResponse getBootVolumeBackup(GetBootVolumeBackupRequest request)
Gets information for the specified boot volume backup.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetBootVolumeBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBootVolumeBackup API.
-
getBootVolumeKmsKey
GetBootVolumeKmsKeyResponse getBootVolumeKmsKey(GetBootVolumeKmsKeyRequest request)
Gets the Vault service encryption key assigned to the specified boot volume.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetBootVolumeKmsKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBootVolumeKmsKey API.
-
getBootVolumeReplica
GetBootVolumeReplicaResponse getBootVolumeReplica(GetBootVolumeReplicaRequest request)
Gets information for the specified boot volume replica.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetBootVolumeReplicaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBootVolumeReplica API.
-
getVolume
GetVolumeResponse getVolume(GetVolumeRequest request)
Gets information for the specified volume.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetVolumeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetVolume API.
-
getVolumeBackup
GetVolumeBackupResponse getVolumeBackup(GetVolumeBackupRequest request)
Gets information for the specified volume backup.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetVolumeBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetVolumeBackup API.
-
getVolumeBackupPolicy
GetVolumeBackupPolicyResponse getVolumeBackupPolicy(GetVolumeBackupPolicyRequest request)
Gets information for the specified volume backup policy.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetVolumeBackupPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetVolumeBackupPolicy API.
-
getVolumeBackupPolicyAssetAssignment
GetVolumeBackupPolicyAssetAssignmentResponse getVolumeBackupPolicyAssetAssignment(GetVolumeBackupPolicyAssetAssignmentRequest request)
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetVolumeBackupPolicyAssetAssignmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetVolumeBackupPolicyAssetAssignment API.
-
getVolumeBackupPolicyAssignment
GetVolumeBackupPolicyAssignmentResponse getVolumeBackupPolicyAssignment(GetVolumeBackupPolicyAssignmentRequest request)
Gets information for the specified volume backup policy assignment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetVolumeBackupPolicyAssignmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetVolumeBackupPolicyAssignment API.
-
getVolumeGroup
GetVolumeGroupResponse getVolumeGroup(GetVolumeGroupRequest request)
Gets information for the specified volume group.For more information, see Volume Groups.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetVolumeGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetVolumeGroup API.
-
getVolumeGroupBackup
GetVolumeGroupBackupResponse getVolumeGroupBackup(GetVolumeGroupBackupRequest request)
Gets information for the specified volume group backup.For more information, see Volume Groups.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetVolumeGroupBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetVolumeGroupBackup API.
-
getVolumeGroupReplica
GetVolumeGroupReplicaResponse getVolumeGroupReplica(GetVolumeGroupReplicaRequest request)
Gets information for the specified volume group replica.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetVolumeGroupReplicaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetVolumeGroupReplica API.
-
getVolumeKmsKey
GetVolumeKmsKeyResponse getVolumeKmsKey(GetVolumeKmsKeyRequest request)
Gets the Vault service encryption key assigned to the specified volume.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/GetVolumeKmsKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetVolumeKmsKey API.
-
listBlockVolumeReplicas
ListBlockVolumeReplicasResponse listBlockVolumeReplicas(ListBlockVolumeReplicasRequest request)
Lists the block volume replicas in the specified compartment and availability domain.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ListBlockVolumeReplicasExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBlockVolumeReplicas API.
-
listBootVolumeBackups
ListBootVolumeBackupsResponse listBootVolumeBackups(ListBootVolumeBackupsRequest request)
Lists the boot volume backups in the specified compartment.You can filter the results by boot volume.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ListBootVolumeBackupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBootVolumeBackups API.
-
listBootVolumeReplicas
ListBootVolumeReplicasResponse listBootVolumeReplicas(ListBootVolumeReplicasRequest request)
Lists the boot volume replicas in the specified compartment and availability domain.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ListBootVolumeReplicasExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBootVolumeReplicas API.
-
listBootVolumes
ListBootVolumesResponse listBootVolumes(ListBootVolumesRequest request)
Lists the boot volumes in the specified compartment and availability domain.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ListBootVolumesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBootVolumes API.
-
listVolumeBackupPolicies
ListVolumeBackupPoliciesResponse listVolumeBackupPolicies(ListVolumeBackupPoliciesRequest request)
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).
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ListVolumeBackupPoliciesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListVolumeBackupPolicies API.
-
listVolumeBackups
ListVolumeBackupsResponse listVolumeBackups(ListVolumeBackupsRequest request)
Lists the volume backups in the specified compartment.You can filter the results by volume.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ListVolumeBackupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListVolumeBackups API.
-
listVolumeGroupBackups
ListVolumeGroupBackupsResponse listVolumeGroupBackups(ListVolumeGroupBackupsRequest request)
Lists the volume group backups in the specified compartment.You can filter the results by volume group. For more information, see Volume Groups.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ListVolumeGroupBackupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListVolumeGroupBackups API.
-
listVolumeGroupReplicas
ListVolumeGroupReplicasResponse listVolumeGroupReplicas(ListVolumeGroupReplicasRequest request)
Lists the volume group replicas in the specified compartment.You can filter the results by volume group. For more information, see Volume Group Replication.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ListVolumeGroupReplicasExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListVolumeGroupReplicas API.
-
listVolumeGroups
ListVolumeGroupsResponse listVolumeGroups(ListVolumeGroupsRequest request)
Lists the volume groups in the specified compartment and availability domain.For more information, see Volume Groups.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ListVolumeGroupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListVolumeGroups API.
-
listVolumes
ListVolumesResponse listVolumes(ListVolumesRequest request)
Lists the volumes in the specified compartment and availability domain.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/ListVolumesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListVolumes API.
-
updateBootVolume
UpdateBootVolumeResponse updateBootVolume(UpdateBootVolumeRequest request)
Updates the specified boot volume’s display name, defined tags, and free-form tags.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/UpdateBootVolumeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateBootVolume API.
-
updateBootVolumeBackup
UpdateBootVolumeBackupResponse updateBootVolumeBackup(UpdateBootVolumeBackupRequest request)
Updates the display name for the specified boot volume backup.Avoid entering confidential information.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/UpdateBootVolumeBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateBootVolumeBackup API.
-
updateBootVolumeKmsKey
UpdateBootVolumeKmsKeyResponse updateBootVolumeKmsKey(UpdateBootVolumeKmsKeyRequest request)
Updates the specified volume with a new Vault service master encryption key.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/UpdateBootVolumeKmsKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateBootVolumeKmsKey API.
-
updateVolume
UpdateVolumeResponse updateVolume(UpdateVolumeRequest request)
Updates the specified volume’s display name.Avoid entering confidential information.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/UpdateVolumeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateVolume API.
-
updateVolumeBackup
UpdateVolumeBackupResponse updateVolumeBackup(UpdateVolumeBackupRequest request)
Updates the display name for the specified volume backup.Avoid entering confidential information.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/UpdateVolumeBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateVolumeBackup API.
-
updateVolumeBackupPolicy
UpdateVolumeBackupPolicyResponse updateVolumeBackupPolicy(UpdateVolumeBackupPolicyRequest request)
Updates a user defined backup policy.For more information about user defined backup policies, see Policy-Based Backups.
Avoid entering confidential information.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/UpdateVolumeBackupPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateVolumeBackupPolicy API.
-
updateVolumeGroup
UpdateVolumeGroupResponse updateVolumeGroup(UpdateVolumeGroupRequest request)
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).
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/UpdateVolumeGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateVolumeGroup API.
-
updateVolumeGroupBackup
UpdateVolumeGroupBackupResponse updateVolumeGroupBackup(UpdateVolumeGroupBackupRequest request)
Updates the display name for the specified volume group backup.For more information, see Volume Groups.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/UpdateVolumeGroupBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateVolumeGroupBackup API.
-
updateVolumeKmsKey
UpdateVolumeKmsKeyResponse updateVolumeKmsKey(UpdateVolumeKmsKeyRequest request)
Updates the specified volume with a new Key Management master encryption key.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/core/UpdateVolumeKmsKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateVolumeKmsKey API.
-
getWaiters
@Deprecated BlockstorageWaiters getWaiters()
Deprecated.usenewWaiters(WorkRequest)
instead. Otherwise, a default one will be provided that does not support operations that rely on the WorkRequestClient for polling. An IllegalStateException will be thrown for such operations.Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
newWaiters
BlockstorageWaiters newWaiters(WorkRequest workRequestClient)
Creates a new BlockstorageWaiters for resources for this service.- Parameters:
workRequestClient
- The work request service client used to query for work request status- Returns:
- The service waiters.
-
getPaginators
BlockstoragePaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Returns:
- The service paginators.
-
-