com.emc.vipr.client.core

Class BlockVolumes

java.lang.Object

com.emc.vipr.client.core.AbstractResources<T>

com.emc.vipr.client.core.AbstractBulkResources<T>

com.emc.vipr.client.core.AbstractCoreBulkResources<T>

com.emc.vipr.client.core.ProjectResources<T>

com.emc.vipr.client.core.BulkExportResources<VolumeRestRep>

com.emc.vipr.client.core.BlockVolumes

All Implemented Interfaces:

BulkResources<VolumeRestRep>, Resources<VolumeRestRep>, TaskResources<VolumeRestRep>

public class BlockVolumes
extends BulkExportResources<VolumeRestRep>
implements TaskResources<VolumeRestRep>

Block Volumes resources.

Base URL: /block/volumes

Constructor Summary

Constructors

Constructor and Description
BlockVolumes(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<VolumeRestRep>	activateFullCopy(java.net.URI id, java.net.URI copyId) Deprecated.
Tasks<VolumeRestRep>	addJournalCapacity(VolumeCreate create) Adds journal capacity
Task<VolumeRestRep>	changeVirtualArray(java.net.URI id, VirtualArrayChangeParam input) Deprecated.
Tasks<VolumeRestRep>	changeVirtualArrayForVolumes(VolumeVirtualArrayChangeParam input) Changes the virtual array for the given block volumes.
Tasks<VolumeRestRep>	changeVirtualPool(VolumeVirtualPoolChangeParam input) Changes the virtual pool for the given block volume.
VolumeRestRep	checkFullCopyProgress(java.net.URI id, java.net.URI copyId) Deprecated.
Tasks<VolumeRestRep>	create(VolumeCreate create) Begins creating one or more block volumes.
Tasks<VolumeRestRep>	createFullCopy(java.net.URI id, VolumeFullCopyCreateParam input) Begins creating a full copy of the given block volume.
Tasks<VolumeRestRep>	deactivate(java.util.List<java.net.URI> ids) Begins deactivating multiple block volumes by their IDs.
Tasks<VolumeRestRep>	deactivate(java.util.List<java.net.URI> ids, VolumeDeleteTypeEnum deletionType) Begins deactivating multiple block volumes by their IDs.
Task<VolumeRestRep>	deactivate(java.net.URI id) Begins deactivating a block volume by ID.
Task<VolumeRestRep>	deactivate(java.net.URI id, VolumeDeleteTypeEnum deletionType) Begins deactivating a block volume by ID.
Tasks<VolumeRestRep>	deactivateContinuousCopies(java.net.URI id, CopiesParam input) Begins deactivating a number of continuous copies for the given block volume.
Tasks<VolumeRestRep>	deactivateContinuousCopies(java.net.URI id, CopiesParam input, VolumeDeleteTypeEnum type) Begins deactivating a number of continuous copies for the given block volume.
Task<VolumeRestRep>	detachFullCopy(java.net.URI id, java.net.URI copyId) Deprecated.
Task<VolumeRestRep>	expand(java.net.URI id, VolumeExpandParam input) Begins expanding a block volume by ID.
Tasks<VolumeRestRep>	failover(java.net.URI id, CopiesParam input) Begins initiating failover for a given block volume.
Tasks<VolumeRestRep>	failoverCancel(java.net.URI id, CopiesParam input) Begins canceling a previously initiated failover for the given block volume.
Tasks<VolumeRestRep>	failoverTest(java.net.URI id, CopiesParam input) Deprecated. failover-test is being replaced by failover.
Tasks<VolumeRestRep>	failoverTestCancel(java.net.URI id, CopiesParam input) Deprecated. failover-test-cancel needs to be replaced by failover-cancel. TO-DO: Add client support for failover-cancel.
java.util.List<VolumeRestRep>	findByName(java.lang.String name) Finds a volume by its name.
java.util.List<VolumeRestRep>	findByWwn(java.lang.String wwn) Finds a volume by its WWN.
java.util.List<VolumeRestRep>	getByExportGroups(java.util.Collection<? extends ExportGroupRestRep> exportGroups) Gets the list of volumes for the given export groups.
java.util.List<VolumeRestRep>	getByExportGroups(java.util.Collection<? extends ExportGroupRestRep> exportGroups, ResourceFilter<VolumeRestRep> filter) Gets the list of volumes for the given export groups, optionally filtering the results.
java.util.List<BlockMirrorRestRep>	getContinuousCopies(java.net.URI id) Gets the list of continuous copies for the given block volume.
java.util.List<BlockMirrorRestRep>	getContinuousCopies(java.net.URI id, ResourceFilter<BlockMirrorRestRep> filter) Gets the list of continuous copies for the given block volume, optionally filtering the results.
BlockMirrorRestRep	getContinuousCopy(java.net.URI id, java.net.URI copyId) Gets a continuous copy for the given block volume.
ITLBulkRep	getExports(BulkIdParam ids) Gets the exports for a list of volumes.
java.util.List<ITLRestRep>	getExports(java.net.URI id) Gets the list of exports for a given block volume.
java.util.List<VolumeRestRep>	getFullCopies(java.net.URI id) Gets the full copies associated with the given block volume.
java.util.List<VolumeRestRep>	getFullCopies(java.net.URI id, ResourceFilter<VolumeRestRep> filter) Gets the full copies associated with the given block volume, with filtering support.
ProtectionSetRestRep	getProtectionSet(java.net.URI volumeId, java.net.URI protectionSetId) Gets a protection set for the given block volume.
Task<VolumeRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<VolumeRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
java.util.List<NamedRelatedResourceRep>	listContinuousCopies(java.net.URI id) Lists the continuous copies for the given volume.
java.util.List<NamedRelatedResourceRep>	listFullCopies(java.net.URI id) List the full copies associated with the given block volume.
java.util.List<NamedRelatedResourceRep>	listMigrations(java.net.URI id) Lists migrations for the given block volume.
NamedVolumesList	listVirtualArrayChangeCandidates(java.net.URI projectId, java.net.URI varrayId) Lists volumes in the given project that can potentially be moved to the given virtual array.
java.util.List<VirtualPoolChangeRep>	listVirtualPoolChangeCandidates(java.net.URI id) Lists virtual pool change candidates for the given block volume.
Task<VolumeRestRep>	migrate(MigrationParam input) Deprecated. Use the Change Virtual Pool API instead
Tasks<VolumeRestRep>	pauseContinuousCopies(java.net.URI id, CopiesParam input) Begins pausing a number of continuous copies for a given block volume.
Tasks<VolumeRestRep>	resumeContinuousCopies(java.net.URI id, CopiesParam input) Begins resuming a number of continuous copies for the given block volume.
VolumeSearchBuilder	search() Creates a search builder specifically for creating volume search queries.
Tasks<VolumeRestRep>	startContinuousCopies(java.net.URI id, CopiesParam input) Begins creating a number of continuous copies for the given block volume.
Tasks<VolumeRestRep>	stopContinuousCopies(java.net.URI id, CopiesParam input) Begins stopping a number of continuous copies for the given block volume.
Tasks<VolumeRestRep>	swapContinuousCopies(java.net.URI id, CopiesParam input) Request to reverse the replication direction, i.e.
Tasks<VolumeRestRep>	syncContinuousCopies(java.net.URI id, CopiesParam input) Sync continuous copies.
Tasks<VolumeRestRep>	updateCopyAccessMode(java.net.URI id, CopiesParam input) Begins initiating access mode update for a given block volume.
BlockVolumes	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
BlockVolumes	withInternal(boolean internal) Configures the fetch operations to include internal resources.

Methods inherited from class com.emc.vipr.client.core.BulkExportResources

getBulkExports

Methods inherited from class com.emc.vipr.client.core.ProjectResources

findByProject, findByProject, findByProject, findByProject

Methods inherited from class com.emc.vipr.client.core.AbstractBulkResources

getByIds, getByRefs, listBulkIds

Methods inherited from class com.emc.vipr.client.core.AbstractResources

addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, updateTags

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.emc.vipr.client.core.BulkResources

getByIds, getByRefs

Methods inherited from interface com.emc.vipr.client.core.Resources

addTags, get, get, getTags, removeTags, updateTags

Constructor Detail

BlockVolumes

public BlockVolumes(ViPRCoreClient parent,
                    RestClient client)

Method Detail

withInactive

public BlockVolumes withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<VolumeRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public BlockVolumes withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<VolumeRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

public Tasks<VolumeRestRep> getTasks(java.net.URI id)

Description copied from interface: TaskResources

Gets the tasks associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks

Specified by:

getTasks in interface TaskResources<VolumeRestRep>

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

public Task<VolumeRestRep> getTask(java.net.URI id,
                                   java.net.URI taskId)

Description copied from interface: TaskResources

Gets a single task associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks/{taskId}

Specified by:

getTask in interface TaskResources<VolumeRestRep>

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

findByWwn

public java.util.List<VolumeRestRep> findByWwn(java.lang.String wwn)

Finds a volume by its WWN.

API Call: GET /block/volumes/search?wwn={wwn}

Parameters:

wwn - the volume WWN.

Returns:

the list of matching volumes.

findByName

public java.util.List<VolumeRestRep> findByName(java.lang.String name)

Finds a volume by its name.

API Call: GET /block/volumes/search?name={name}

Parameters:

name - the volume name.

Returns:

the list of matching volumes.

create

public Tasks<VolumeRestRep> create(VolumeCreate create)

Begins creating one or more block volumes.

API Call: POST /block/volumes

Parameters:

create - the block volume create configuration.

Returns:

tasks for monitoring the progress of the operation(s).

addJournalCapacity

public Tasks<VolumeRestRep> addJournalCapacity(VolumeCreate create)

Adds journal capacity

Parameters:

create - the block volume create configuration for journal volumes.

Returns:

tasks for monitoring the progress of the operation(s).

deactivate

public Task<VolumeRestRep> deactivate(java.net.URI id)

Begins deactivating a block volume by ID.

API Call: POST /block/volumes/{id}/deactivate?type=FULL

Parameters:

id - the ID of the block volume to deactivate.

Returns:

a task for monitoring the progress of the operation.

See Also:

deactivate(List, VolumeDeleteTypeEnum)

deactivate

public Task<VolumeRestRep> deactivate(java.net.URI id,
                                      VolumeDeleteTypeEnum deletionType)

Begins deactivating a block volume by ID.

API Call: POST /block/volumes/{id}/deactivate?type={deletionType}

Parameters:

id - the ID of the block volume to deactivate.

deletionType - FULL or VIPR_ONLY

Returns:

a task for monitoring the progress of the operation.

See Also:

VolumeDeleteTypeEnum

deactivate

public Tasks<VolumeRestRep> deactivate(java.util.List<java.net.URI> ids)

Begins deactivating multiple block volumes by their IDs.

API Call: POST /block/volumes/deactivate?type=FULL

Parameters:

ids - The IDs of the block volumes to deactivate.

Returns:

tasks for monitoring the progress of the operations.

deactivate

public Tasks<VolumeRestRep> deactivate(java.util.List<java.net.URI> ids,
                                       VolumeDeleteTypeEnum deletionType)

Begins deactivating multiple block volumes by their IDs.

API Call: POST /block/volumes/deactivate?type={deletionType}

Parameters:

ids - The IDs of the block volumes to deactivate.

deletionType - FULL or VIPR_ONLY

Returns:

tasks for monitoring the progress of the operations.

See Also:

VolumeDeleteTypeEnum

expand

public Task<VolumeRestRep> expand(java.net.URI id,
                                  VolumeExpandParam input)

Begins expanding a block volume by ID.

API Call: POST /block/volumes/{id}/expand

Parameters:

id - the ID of the block volume to expand.

input - the expand configuration.

Returns:

a task for monitoring the progress of the operation.

getByExportGroups

public java.util.List<VolumeRestRep> getByExportGroups(java.util.Collection<? extends ExportGroupRestRep> exportGroups)

Gets the list of volumes for the given export groups.

Parameters:

exportGroups - the export groups.

Returns:

the list of volumes in the given export groups.

getByExportGroups

public java.util.List<VolumeRestRep> getByExportGroups(java.util.Collection<? extends ExportGroupRestRep> exportGroups,
                                                       ResourceFilter<VolumeRestRep> filter)

Gets the list of volumes for the given export groups, optionally filtering the results.

Parameters:

exportGroups - the export groups.

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

the list of block volumes.

See Also:

ExportGroupRestRep.getVolumes()

getExports

public java.util.List<ITLRestRep> getExports(java.net.URI id)

Gets the list of exports for a given block volume.

API Call: GET /block/volumes/{id}/exports

Parameters:

id - the ID of the block volume.

Returns:

the list of exports.

getExports

public ITLBulkRep getExports(BulkIdParam ids)

Gets the exports for a list of volumes.

API Call: POST /block/volumes/exports/bulk

Parameters:

ids - the IDs of the block volumes.

Returns:

the list of exports.

startContinuousCopies

public Tasks<VolumeRestRep> startContinuousCopies(java.net.URI id,
                                                  CopiesParam input)

Begins creating a number of continuous copies for the given block volume.

API Call: POST /block/volumes/{id}/protection/continuous-copies/start

Parameters:

id - the ID of the block volume.

input - the configuration of the new continuous copies.

Returns:

tasks for monitoring the progress of the operation(s).

stopContinuousCopies

public Tasks<VolumeRestRep> stopContinuousCopies(java.net.URI id,
                                                 CopiesParam input)

Begins stopping a number of continuous copies for the given block volume.

API Call: POST /block/volumes/{id}/protection/continuous-copies/stop

Parameters:

id - the ID of the block volume.

input - the configuration of the copies to stop.

Returns:

tasks for monitoring the progress of the operation(s).

pauseContinuousCopies

public Tasks<VolumeRestRep> pauseContinuousCopies(java.net.URI id,
                                                  CopiesParam input)

Begins pausing a number of continuous copies for a given block volume.

API Call: POST /block/volumes/{id}/protection/continuous-copies/pause

Parameters:

id - the ID of the block volume.

input - the copy configurations.

Returns:

tasks for monitoring the progress if the operations.

resumeContinuousCopies

public Tasks<VolumeRestRep> resumeContinuousCopies(java.net.URI id,
                                                   CopiesParam input)

Begins resuming a number of continuous copies for the given block volume.

API Call: POST /block/volumes/{id}/protection/continuous-copies/resume

Parameters:

id - the ID of the block volume.

input - the copy configurations.

Returns:

tasks for monitoring the progress of the operations.

swapContinuousCopies

public Tasks<VolumeRestRep> swapContinuousCopies(java.net.URI id,
                                                 CopiesParam input)

Request to reverse the replication direction, i.e. R1 and R2 are interchanged for the given block volume.

API Call: POST /block/volumes/{id}/protection/continuous-copies/swap

Parameters:

id - the ID of the block volume.

input - the copy configurations.

Returns:

tasks for monitoring the progress of the operations.

listContinuousCopies

public java.util.List<NamedRelatedResourceRep> listContinuousCopies(java.net.URI id)

Lists the continuous copies for the given volume.

API Call: GET /block/volumes/{id}/protection/continuous-copies

Parameters:

id - the ID of the block volume.

Returns:

the list of continuous copy references.

getContinuousCopy

public BlockMirrorRestRep getContinuousCopy(java.net.URI id,
                                            java.net.URI copyId)

Gets a continuous copy for the given block volume.

API Call: GET /block/volumes/{id}/protection/continuous-copies/{copyId}

Parameters:

id - the ID of the block volume.

copyId - the ID of the continuous copy.

Returns:

the continuous copy.

getContinuousCopies

public java.util.List<BlockMirrorRestRep> getContinuousCopies(java.net.URI id)

Gets the list of continuous copies for the given block volume.

Parameters:

id - the ID of the block volume.

Returns:

the list of continuous copies.

getContinuousCopies

public java.util.List<BlockMirrorRestRep> getContinuousCopies(java.net.URI id,
                                                              ResourceFilter<BlockMirrorRestRep> filter)

Gets the list of continuous copies for the given block volume, optionally filtering the results.

Parameters:

id - the ID of the block volume.

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

the list of continuous copies.

deactivateContinuousCopies

public Tasks<VolumeRestRep> deactivateContinuousCopies(java.net.URI id,
                                                       CopiesParam input)

Begins deactivating a number of continuous copies for the given block volume.

API Call: POST /block/volumes/{id}/protection/continuous-copies/deactivate

Parameters:

id - the ID of the block volume.

input - the copy configurations.

Returns:

tasks for monitoring the progress of the operation.

deactivateContinuousCopies

public Tasks<VolumeRestRep> deactivateContinuousCopies(java.net.URI id,
                                                       CopiesParam input,
                                                       VolumeDeleteTypeEnum type)

Begins deactivating a number of continuous copies for the given block volume.

API Call: POST /block/volumes/{id}/protection/continuous-copies/deactivate

Parameters:

id - the ID of the block volume.

input - the copy configurations.

type - FULL or VIPR_ONLY

Returns:

tasks for monitoring the progress of the operation.

listFullCopies

public java.util.List<NamedRelatedResourceRep> listFullCopies(java.net.URI id)

List the full copies associated with the given block volume.

API Call: GET /block/volumes/{id}/protection/full-copies

Parameters:

id - the ID of the block volume.

Returns:

the list of full copy IDs.

getFullCopies

public java.util.List<VolumeRestRep> getFullCopies(java.net.URI id)

Gets the full copies associated with the given block volume. This is a convenience method for: getByRefs(listFullCopies(id))

Parameters:

id - the ID of the block volume.

Returns:

the full copy volumes.

See Also:

listFullCopies(URI), AbstractResources.getByRefs(Collection)

getFullCopies

public java.util.List<VolumeRestRep> getFullCopies(java.net.URI id,
                                                   ResourceFilter<VolumeRestRep> filter)

Gets the full copies associated with the given block volume, with filtering support. This is a convenience method for: getByRefs(listFullCopies(id), filter)

Parameters:

id - the ID of the block volume.

filter - the resource filter to apply (optional).

Returns:

the full copy volumes.

See Also:

listFullCopies(URI), AbstractBulkResources.getByRefs(Collection, ResourceFilter)

createFullCopy

public Tasks<VolumeRestRep> createFullCopy(java.net.URI id,
                                           VolumeFullCopyCreateParam input)

Begins creating a full copy of the given block volume.

API Call: POST /block/volumes/{id}/protection/full-copies

Parameters:

id - the ID of the block volume.

input - the create configuration.

Returns:

tasks for monitoring the progress of the operation(s).

activateFullCopy

@Deprecated
public Task<VolumeRestRep> activateFullCopy(java.net.URI id,
                                                         java.net.URI copyId)

Deprecated.

Begins activating a full copy of the given block volume.

API Call: POST /block/volumes/{id}/protection/full-copies/{copyId}/activate

Parameters:

id - the ID of the block volume.

copyId - the ID of the full copy to activate.

Returns:

a task for monitoring the progress of the operation.

detachFullCopy

@Deprecated
public Task<VolumeRestRep> detachFullCopy(java.net.URI id,
                                                       java.net.URI copyId)

Deprecated.

Begins detaching a full copy of the given block volume.

API Call: POST /block/volumes/{id}/protection/full-copies/{copyId}/detach

Parameters:

id - the ID of the block volume.

copyId - the ID of the full copy to detach.

Returns:

a task for monitoring the progress of the operation.

checkFullCopyProgress

@Deprecated
public VolumeRestRep checkFullCopyProgress(java.net.URI id,
                                                        java.net.URI copyId)

Deprecated.

Gets the full copy volume with an updated value of the progress of the operation. The progress can be retrieved from: volume.getProtection().getFullCopy().getPercentSynced()

API Call: POST /block/volumes/{id}/protection/full-copies/{copyId}/check-progress

Parameters:

id - the ID of the block volume.

copyId - the ID of the full copy.

Returns:

the full copy volume.

See Also:

VolumeRestRep.FullCopyRestRep#getPercentSynced()

failover

public Tasks<VolumeRestRep> failover(java.net.URI id,
                                     CopiesParam input)

Begins initiating failover for a given block volume.

API Call: POST /block/volumes/{id}/protection/continuous-copies/failover

Parameters:

id - the ID of the block volume.

input - the input configuration.

Returns:

a task for monitoring the progress of the operation.

failoverTest

@Deprecated
public Tasks<VolumeRestRep> failoverTest(java.net.URI id,
                                                      CopiesParam input)

Deprecated. failover-test is being replaced by failover.

Begins initiating a failover test for the given block volume.

API Call: POST /block/volumes/{id}/protection/continuous-copies/failover-test

Parameters:

id - the ID of the block volume.

input - the input configuration.

Returns:

a task for monitoring the progress of the operation.

failoverTestCancel

@Deprecated
public Tasks<VolumeRestRep> failoverTestCancel(java.net.URI id,
                                                            CopiesParam input)

Deprecated. failover-test-cancel needs to be replaced by failover-cancel. TO-DO: Add client support for failover-cancel.

Begins canceling a previously initiated failover test for the given block volume.

API Call: POST /block/volumes/{id}/protection/continuous-copies/failover-test-cancel

Parameters:

id - the ID of the block volume.

input - the input configuration.

Returns:

a task for monitoring the progress of the operation.

See Also:

failoverTest(URI, CopiesParam)

failoverCancel

public Tasks<VolumeRestRep> failoverCancel(java.net.URI id,
                                           CopiesParam input)

Begins canceling a previously initiated failover for the given block volume.

API Call: POST /block/volumes/{id}/protection/continuous-copies/failover-cancel

Parameters:

id - the ID of the block volume.

input - the input configuration.

Returns:

a task for monitoring the progress of the operation.

See Also:

failoverTest(URI, CopiesParam)

updateCopyAccessMode

public Tasks<VolumeRestRep> updateCopyAccessMode(java.net.URI id,
                                                 CopiesParam input)

Begins initiating access mode update for a given block volume.

API Call: POST /block/volumes/{id}/protection/continuous-copies/accessmode

Parameters:

id - the ID of the block volume.

input - the input configuration.

Returns:

a task for monitoring the progress of the operation.

syncContinuousCopies

public Tasks<VolumeRestRep> syncContinuousCopies(java.net.URI id,
                                                 CopiesParam input)

Sync continuous copies.

API Call: POST /block/volumes/{id}/protection/continuous-copies/sync

Parameters:

id - the ID of the block volume.

input - the input configuration.

Returns:

a task for monitoring the progress of the operation.

getProtectionSet

public ProtectionSetRestRep getProtectionSet(java.net.URI volumeId,
                                             java.net.URI protectionSetId)

Gets a protection set for the given block volume.

API Call: GET /block/volumes/{volumeId}/protection/protection-sets/{protectionSetId}

Parameters:

volumeId - the ID of the block volume.

protectionSetId - the ID of the protection set.

Returns:

the protection set.

migrate

@Deprecated
public Task<VolumeRestRep> migrate(MigrationParam input)

Deprecated. Use the Change Virtual Pool API instead

Begin migrating a block volume.

API Call: POST /block/migrations

Parameters:

input - the migration configuration.

Returns:

a task for monitoring the operation progress.

listMigrations

public java.util.List<NamedRelatedResourceRep> listMigrations(java.net.URI id)

Lists migrations for the given block volume.

API Call: GET /block/volumes/{id}/migrations

Parameters:

id - the ID of the block volume.

Returns:

the list of migration references.

listVirtualPoolChangeCandidates

public java.util.List<VirtualPoolChangeRep> listVirtualPoolChangeCandidates(java.net.URI id)

Lists virtual pool change candidates for the given block volume.

API Call: GET /block/volumes/{id}/vpool-change/vpool

Parameters:

id - the ID of the block volume.

Returns:

the list of virtual pool candidates.

listVirtualArrayChangeCandidates

public NamedVolumesList listVirtualArrayChangeCandidates(java.net.URI projectId,
                                                         java.net.URI varrayId)

Lists volumes in the given project that can potentially be moved to the given virtual array.

Parameters:

projectId - the ID of the project to search for potential virtual array change volumes

varrayId - the ID of the virtual array to use as a target when searching

Returns:

the list of volumes that are virtual array change candidates

changeVirtualPool

public Tasks<VolumeRestRep> changeVirtualPool(VolumeVirtualPoolChangeParam input)

Changes the virtual pool for the given block volume.

API Call: POST /block/volumes/vpool-change

Parameters:

input - the virtual pool change configuration.

Returns:

a task for monitoring the progress of the operation.

changeVirtualArray

@Deprecated
public Task<VolumeRestRep> changeVirtualArray(java.net.URI id,
                                                           VirtualArrayChangeParam input)

Deprecated.

Changes the virtual array for the given block volume.

API Call: PUT /block/volumes/{id}/varray

Parameters:

id - the id of the block volume.

input - the virtual array change configuration.

Returns:

a task for monitoring the progress of the operation.

changeVirtualArrayForVolumes

public Tasks<VolumeRestRep> changeVirtualArrayForVolumes(VolumeVirtualArrayChangeParam input)

Changes the virtual array for the given block volumes.

API Call; POST /block/volumes/change-varray

Parameters:

input - the VolumeVirtualArrayChangeParam

Returns:

a list of tasks for monitoring the progress of the Virtual Array Change operation

search

public VolumeSearchBuilder search()

Creates a search builder specifically for creating volume search queries.

Specified by:

search in interface Resources<VolumeRestRep>

Overrides:

search in class ProjectResources<VolumeRestRep>

Returns:

a volume search builder.