@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public interface Blockstorage extends AutoCloseable
Modifier and Type | Method and Description |
---|---|
CopyVolumeBackupResponse |
copyVolumeBackup(CopyVolumeBackupRequest request)
Creates a volume 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.
|
CreateVolumeBackupPolicyAssignmentResponse |
createVolumeBackupPolicyAssignment(CreateVolumeBackupPolicyAssignmentRequest request)
Assigns a policy to the specified asset, such as a 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 KMS key for the specified boot volume.
|
DeleteVolumeResponse |
deleteVolume(DeleteVolumeRequest request)
Deletes the specified volume.
|
DeleteVolumeBackupResponse |
deleteVolumeBackup(DeleteVolumeBackupRequest request)
Deletes a volume backup.
|
DeleteVolumeBackupPolicyAssignmentResponse |
deleteVolumeBackupPolicyAssignment(DeleteVolumeBackupPolicyAssignmentRequest request)
Deletes a volume backup policy assignment (i.e.
|
DeleteVolumeGroupResponse |
deleteVolumeGroup(DeleteVolumeGroupRequest request)
Deletes the specified volume group.
|
DeleteVolumeGroupBackupResponse |
deleteVolumeGroupBackup(DeleteVolumeGroupBackupRequest request)
Deletes a volume group backup.
|
DeleteVolumeKmsKeyResponse |
deleteVolumeKmsKey(DeleteVolumeKmsKeyRequest request)
Removes the KMS key for the specified volume.
|
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 KMS key ID for the specified boot volume.
|
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 asset.
|
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.
|
GetVolumeKmsKeyResponse |
getVolumeKmsKey(GetVolumeKmsKeyRequest request)
Gets the KMS key ID for the specified volume.
|
BlockstorageWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListBootVolumeBackupsResponse |
listBootVolumeBackups(ListBootVolumeBackupsRequest request)
Lists the boot volume backups in the specified compartment.
|
ListBootVolumesResponse |
listBootVolumes(ListBootVolumesRequest request)
Lists the boot volumes in the specified compartment and availability domain.
|
ListVolumeBackupPoliciesResponse |
listVolumeBackupPolicies(ListVolumeBackupPoliciesRequest request)
Lists all volume backup policies available to the caller.
|
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.
|
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.
|
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 KMS key ID for the specified volume.
|
UpdateVolumeResponse |
updateVolume(UpdateVolumeRequest request)
Updates the specified volume’s display name.
|
UpdateVolumeBackupResponse |
updateVolumeBackup(UpdateVolumeBackupRequest request)
Updates the display name for the specified volume backup.
|
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 KMS key ID for the specified volume.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.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.
region
- The region of the service.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 call setEndpoint
.
regionId
- The public region ID.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
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.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. For information about availability domains, see Regions and Availability Domains. 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.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateVolumeBackupPolicyAssignmentResponse createVolumeBackupPolicyAssignment(CreateVolumeBackupPolicyAssignmentRequest request)
Assigns a policy to the specified asset, such as a volume. Note that a given asset can only have one policy assigned to it; if this method is called for an asset that previously has a different policy assigned, the prior assignment will be silently deleted.
request
- The request object containing the details to sendBmcException
- when an error occurs.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. A volume group can contain up to 64 volumes. 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.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateVolumeGroupBackupResponse createVolumeGroupBackup(CreateVolumeGroupBackupRequest request)
Creates a new backup volume group of the specified volume group. For more information, see Volume Groups.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteBootVolumeBackupResponse deleteBootVolumeBackup(DeleteBootVolumeBackupRequest request)
Deletes a boot volume backup.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteBootVolumeKmsKeyResponse deleteBootVolumeKmsKey(DeleteBootVolumeKmsKeyRequest request)
Removes the KMS key for the specified boot volume.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteVolumeBackupResponse deleteVolumeBackup(DeleteVolumeBackupRequest request)
Deletes a volume backup.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteVolumeBackupPolicyAssignmentResponse deleteVolumeBackupPolicyAssignment(DeleteVolumeBackupPolicyAssignmentRequest request)
Deletes a volume backup policy assignment (i.e. unassigns the policy from an asset).
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteVolumeKmsKeyResponse deleteVolumeKmsKey(DeleteVolumeKmsKeyRequest request)
Removes the KMS key for the specified volume.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetBootVolumeResponse getBootVolume(GetBootVolumeRequest request)
Gets information for the specified boot volume.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetBootVolumeBackupResponse getBootVolumeBackup(GetBootVolumeBackupRequest request)
Gets information for the specified boot volume backup.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetBootVolumeKmsKeyResponse getBootVolumeKmsKey(GetBootVolumeKmsKeyRequest request)
Gets the KMS key ID for the specified boot volume.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetVolumeResponse getVolume(GetVolumeRequest request)
Gets information for the specified volume.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetVolumeBackupResponse getVolumeBackup(GetVolumeBackupRequest request)
Gets information for the specified volume backup.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetVolumeBackupPolicyResponse getVolumeBackupPolicy(GetVolumeBackupPolicyRequest request)
Gets information for the specified volume backup policy.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetVolumeBackupPolicyAssetAssignmentResponse getVolumeBackupPolicyAssetAssignment(GetVolumeBackupPolicyAssetAssignmentRequest request)
Gets the volume backup policy assignment for the specified asset. Note that the assetId query parameter is required, and that the returned list will contain at most one item (since any given asset can only have one policy assigned to it).
request
- The request object containing the details to sendBmcException
- when an error occurs.GetVolumeBackupPolicyAssignmentResponse getVolumeBackupPolicyAssignment(GetVolumeBackupPolicyAssignmentRequest request)
Gets information for the specified volume backup policy assignment.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetVolumeGroupResponse getVolumeGroup(GetVolumeGroupRequest request)
Gets information for the specified volume group. For more information, see Volume Groups.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetVolumeGroupBackupResponse getVolumeGroupBackup(GetVolumeGroupBackupRequest request)
Gets information for the specified volume group backup. For more information, see Volume Groups.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetVolumeKmsKeyResponse getVolumeKmsKey(GetVolumeKmsKeyRequest request)
Gets the KMS key ID for the specified volume.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListBootVolumeBackupsResponse listBootVolumeBackups(ListBootVolumeBackupsRequest request)
Lists the boot volume backups in the specified compartment. You can filter the results by boot volume.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListBootVolumesResponse listBootVolumes(ListBootVolumesRequest request)
Lists the boot volumes in the specified compartment and availability domain.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListVolumeBackupPoliciesResponse listVolumeBackupPolicies(ListVolumeBackupPoliciesRequest request)
Lists all volume backup policies available to the caller.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListVolumeBackupsResponse listVolumeBackups(ListVolumeBackupsRequest request)
Lists the volume backups in the specified compartment. You can filter the results by volume.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListVolumeGroupsResponse listVolumeGroups(ListVolumeGroupsRequest request)
Lists the volume groups in the specified compartment and availability domain. For more information, see Volume Groups.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListVolumesResponse listVolumes(ListVolumesRequest request)
Lists the volumes in the specified compartment and availability domain.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateBootVolumeResponse updateBootVolume(UpdateBootVolumeRequest request)
Updates the specified boot volume’s display name, defined tags, and free-form tags.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateBootVolumeBackupResponse updateBootVolumeBackup(UpdateBootVolumeBackupRequest request)
Updates the display name for the specified boot volume backup. Avoid entering confidential information.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateBootVolumeKmsKeyResponse updateBootVolumeKmsKey(UpdateBootVolumeKmsKeyRequest request)
Updates the KMS key ID for the specified volume.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateVolumeResponse updateVolume(UpdateVolumeRequest request)
Updates the specified volume’s display name. Avoid entering confidential information.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateVolumeBackupResponse updateVolumeBackup(UpdateVolumeBackupRequest request)
Updates the display name for the specified volume backup. Avoid entering confidential information.
request
- The request object containing the details to sendBmcException
- when an error occurs.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.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateVolumeGroupBackupResponse updateVolumeGroupBackup(UpdateVolumeGroupBackupRequest request)
Updates the display name for the specified volume group backup. For more information, see Volume Groups.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateVolumeKmsKeyResponse updateVolumeKmsKey(UpdateVolumeKmsKeyRequest request)
Updates the KMS key ID for the specified volume.
request
- The request object containing the details to sendBmcException
- when an error occurs.BlockstorageWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
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.
Copyright © 2016–2019. All rights reserved.