com.emc.vipr.client.core

Class BlockSnapshots

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<BlockSnapshotRestRep>

com.emc.vipr.client.core.BlockSnapshots

All Implemented Interfaces:

BulkResources<BlockSnapshotRestRep>, Resources<BlockSnapshotRestRep>, TaskResources<BlockSnapshotRestRep>

public class BlockSnapshots
extends ProjectResources<BlockSnapshotRestRep>
implements TaskResources<BlockSnapshotRestRep>

Block snapshot resources.

Base URL: /block/snapshots

Constructor Summary

Constructors

Constructor and Description
BlockSnapshots(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<BlockSnapshotRestRep>	activate(java.net.URI id) Begins activating a given block snapshot by ID.
Task<BlockSnapshotRestRep>	activateForConsistencyGroup(java.net.URI consistencyGroupId, java.net.URI id) Begins activating a block snapshot for a given consistency group by ID.
Tasks<BlockSnapshotRestRep>	createForConsistencyGroup(java.net.URI consistencyGroupId, BlockConsistencyGroupSnapshotCreate input) Begins creating a block snapshot for the given consistency group by ID.
Tasks<BlockSnapshotRestRep>	createForVolume(java.net.URI volumeId, VolumeSnapshotParam input) Begins creating a snapshot (or snapshots) of a given block volume by ID.
Tasks<BlockSnapshotRestRep>	createFullCopy(java.net.URI id, VolumeFullCopyCreateParam input)
Tasks<BlockSnapshotRestRep>	deactivate(java.net.URI id) Begins deactivating a given block snapshot by ID.
Tasks<BlockSnapshotRestRep>	deactivate(java.net.URI id, VolumeDeleteTypeEnum type) Begins deactivating a given block snapshot by ID.
Tasks<BlockSnapshotRestRep>	deactivateForConsistencyGroup(java.net.URI consistencyGroupId, java.net.URI id) Begins deactivating a block snapshot for a consistency group by ID.
Task<BlockSnapshotRestRep>	expose(java.net.URI id) Creates a new VPLEX volume using the target volume associated with BlockSnapshot instance with the passed id as the source side backend volume for the VPLEX volume.
java.util.List<BlockSnapshotRestRep>	getByConsistencyGroup(java.net.URI consistencyGroupId) Gets the block snapshots for a consistency group by ID.
java.util.List<BlockSnapshotRestRep>	getByConsistencyGroup(java.net.URI consistencyGroupId, ResourceFilter<BlockSnapshotRestRep> filter) Gets the block snapshots for a consistency group by ID, optionally filtering the results.
java.util.List<BlockSnapshotRestRep>	getByVolume(java.net.URI volumeId) Gets the block snapshots for a given block volume.
java.util.List<BlockSnapshotRestRep>	getByVolume(java.net.URI volumeId, ResourceFilter<BlockSnapshotRestRep> filter) Gets the block snapshots for a given block volume, optionally filtering the results.
BlockSnapshotRestRep	getForConsistencyGroup(java.net.URI consistencyGroupId, java.net.URI id) Gets a particular block snapshot for a given consistency group by ID.
Task<BlockSnapshotRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<BlockSnapshotRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
java.util.List<NamedRelatedResourceRep>	listByConsistencyGroup(java.net.URI consistencyGroupId) Lists the block snapshots for a consistency group by ID.
java.util.List<NamedRelatedResourceRep>	listByVolume(java.net.URI volumeId) Lists the block snapshots for a given block volume.
java.util.List<ITLRestRep>	listExports(java.net.URI id) Gets the list of exports (initiator-target-lun) for a given block snapshot by ID.
Task<BlockSnapshotRestRep>	restore(java.net.URI id) Begins restoring a given block snapshot by ID.
Task<BlockSnapshotRestRep>	restoreForConsistencyGroup(java.net.URI consistencyGroupId, java.net.URI id) Begins restoring a block snapshot for a consistency group by ID
Task<BlockSnapshotRestRep>	resynchronizeBlockSnapshot(java.net.URI snapshotId) Begins resynchronizing a blocksnapshot of the given block volume.
Task<BlockSnapshotRestRep>	start(java.net.URI id) Begins creating group synchronization between volume group and snapshot group.
BlockSnapshots	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
BlockSnapshots	withInternal(boolean internal) Configures the fetch operations to include internal resources.

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

findByProject, findByProject, findByProject, findByProject, search

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

BlockSnapshots

public BlockSnapshots(ViPRCoreClient parent,
                      RestClient client)

Method Detail

withInactive

public BlockSnapshots withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<BlockSnapshotRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public BlockSnapshots withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<BlockSnapshotRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

public Tasks<BlockSnapshotRestRep> 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<BlockSnapshotRestRep>

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

public Task<BlockSnapshotRestRep> 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<BlockSnapshotRestRep>

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

activate

public Task<BlockSnapshotRestRep> activate(java.net.URI id)

Begins activating a given block snapshot by ID.

API Call: POST /block/snapshots/{id}/activate

Parameters:

id - the ID of the snapshot to activate.

Returns:

a task for monitoring the progress of the operation.

restore

public Task<BlockSnapshotRestRep> restore(java.net.URI id)

Begins restoring a given block snapshot by ID.

API Call: POST /block/snapshots/{id}/restore

Parameters:

id - the ID of the snapshot to restore.

Returns:

a task for monitoring the progress of the operation.

start

public Task<BlockSnapshotRestRep> start(java.net.URI id)

Begins creating group synchronization between volume group and snapshot group.

API Call: POST /block/snapshots/{id}/start

Parameters:

id - the ID of the snapshot.

Returns:

a task for monitoring the progress of the operation.

deactivate

public Tasks<BlockSnapshotRestRep> deactivate(java.net.URI id)

Begins deactivating a given block snapshot by ID.

API Call: POST /block/snapshots/{id}/deactivate

Parameters:

id - the ID of the snapshot to deactivate.

Returns:

a task for monitoring the progress of the operation.

deactivate

public Tasks<BlockSnapshotRestRep> deactivate(java.net.URI id,
                                              VolumeDeleteTypeEnum type)

Begins deactivating a given block snapshot by ID.

API Call: POST /block/snapshots/{id}/deactivate

Parameters:

id - the ID of the snapshot to deactivate.

type - FULL or VIPR_ONLY

Returns:

a task for monitoring the progress of the operation.

listExports

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

Gets the list of exports (initiator-target-lun) for a given block snapshot by ID.

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

Parameters:

id - the ID of the snapshot.

Returns:

the list of exports for a snapshot.

listByVolume

public java.util.List<NamedRelatedResourceRep> listByVolume(java.net.URI volumeId)

Lists the block snapshots for a given block volume.

API Call: GET /block/volumes/{volumeId}/protection/snapshots

Parameters:

volumeId - the ID of the block volume.

Returns:

the list of snapshot references for the volume.

getByVolume

public java.util.List<BlockSnapshotRestRep> getByVolume(java.net.URI volumeId)

Gets the block snapshots for a given block volume.

Parameters:

volumeId - the ID of the block volume.

Returns:

the list of block snapshots for the volume.

See Also:

listByVolume(URI), AbstractResources.getByRefs(java.util.Collection)

getByVolume

public java.util.List<BlockSnapshotRestRep> getByVolume(java.net.URI volumeId,
                                                        ResourceFilter<BlockSnapshotRestRep> filter)

Gets the block snapshots for a given block volume, optionally filtering the results.

Parameters:

volumeId - the ID of the block volume.

filter - the filter to apply (may be null, for no filtering).

Returns:

the list of block snapshots for the volume.

See Also:

listByVolume(URI), AbstractBulkResources.getByRefs(java.util.Collection, ResourceFilter)

createForVolume

public Tasks<BlockSnapshotRestRep> createForVolume(java.net.URI volumeId,
                                                   VolumeSnapshotParam input)

Begins creating a snapshot (or snapshots) of a given block volume by ID.

API Call: POST /block/volumes/{volumeId}/protection/snapshots

Parameters:

volumeId - the ID of the block volume to snapshot.

input - the snapshot configuration.

Returns:

tasks for monitoring the progress each snapshot creation.

listByConsistencyGroup

public java.util.List<NamedRelatedResourceRep> listByConsistencyGroup(java.net.URI consistencyGroupId)

Lists the block snapshots for a consistency group by ID.

API Call: GET /block/consistency-groups/{consistencyGroupId}/protection/snapshots

Parameters:

consistencyGroupId - the ID of the consistency group.

Returns:

the list of block snapshot references.

getByConsistencyGroup

public java.util.List<BlockSnapshotRestRep> getByConsistencyGroup(java.net.URI consistencyGroupId)

Gets the block snapshots for a consistency group by ID.

Parameters:

consistencyGroupId - the ID of the consistency group.

Returns:

the list of consistency groups.

See Also:

listByConsistencyGroup(URI), AbstractResources.getByRefs(java.util.Collection)

getByConsistencyGroup

public java.util.List<BlockSnapshotRestRep> getByConsistencyGroup(java.net.URI consistencyGroupId,
                                                                  ResourceFilter<BlockSnapshotRestRep> filter)

Gets the block snapshots for a consistency group by ID, optionally filtering the results.

Parameters:

consistencyGroupId - the ID of the consistency group.

filter - the filter to apply (may be null, for no filtering).

Returns:

the list of consistency groups.

See Also:

listByConsistencyGroup(URI), AbstractBulkResources.getByRefs(java.util.Collection, ResourceFilter)

createForConsistencyGroup

public Tasks<BlockSnapshotRestRep> createForConsistencyGroup(java.net.URI consistencyGroupId,
                                                             BlockConsistencyGroupSnapshotCreate input)

Begins creating a block snapshot for the given consistency group by ID.

API Call: POST /block/consistency-groups/{consistencyGroupId}/protection/snapshots

Parameters:

consistencyGroupId - the ID of the consistency group.

input - the create configuration.

Returns:

tasks for monitoring the progress of the block snapshot creation.

getForConsistencyGroup

public BlockSnapshotRestRep getForConsistencyGroup(java.net.URI consistencyGroupId,
                                                   java.net.URI id)

Gets a particular block snapshot for a given consistency group by ID.

API Call: GET /block/consistency-groups/{consistencyGroupId}/protection/snapshots/{id}

Parameters:

consistencyGroupId - the ID of the consistency group.

id - the ID of the block snapshot.

Returns:

the block snapshot.

activateForConsistencyGroup

public Task<BlockSnapshotRestRep> activateForConsistencyGroup(java.net.URI consistencyGroupId,
                                                              java.net.URI id)

Begins activating a block snapshot for a given consistency group by ID.

API Call: POST /block/consistency-groups/{consistencyGroupId}/protection/snapshots/{id}/activate

Parameters:

consistencyGroupId - the ID of the consistency group.

id - the ID of the block snapshot to activate.

Returns:

a task for monitoring the progress of the operation.

deactivateForConsistencyGroup

public Tasks<BlockSnapshotRestRep> deactivateForConsistencyGroup(java.net.URI consistencyGroupId,
                                                                 java.net.URI id)

Begins deactivating a block snapshot for a consistency group by ID.

API Call: POST /block/consistency-groups/{consistencyGroupId}/protection/snapshots/{id}/deactivate

Parameters:

consistencyGroupId - the ID of the consistency group.

id - the ID of the block snapshot to deactivate.

Returns:

tasks for monitoring the progress of the operation.

restoreForConsistencyGroup

public Task<BlockSnapshotRestRep> restoreForConsistencyGroup(java.net.URI consistencyGroupId,
                                                             java.net.URI id)

Begins restoring a block snapshot for a consistency group by ID

API Call: POST /block/consistency-groups/{consistencyGroupId}/protection/snapshots/{id}/restore

Parameters:

consistencyGroupId - the ID of the consistency group.

id - the ID of the block snapshot to restore.

Returns:

a task for monitoring the progress of the operation.

expose

public Task<BlockSnapshotRestRep> expose(java.net.URI id)

Creates a new VPLEX volume using the target volume associated with BlockSnapshot instance with the passed id as the source side backend volume for the VPLEX volume.

API Call: POST /block/snapshots/{id}/expose

Parameters:

id - the URI of the block snapshot

Returns:

a task for monitoring the progress of the operation.

createFullCopy

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

resynchronizeBlockSnapshot

public Task<BlockSnapshotRestRep> resynchronizeBlockSnapshot(java.net.URI snapshotId)

Begins resynchronizing a blocksnapshot of the given block volume.

API Call: POST /block/snapshots/{id}/resynchronize

Parameters:

snapshotId - the ID of the block snapshot to resynchronize.

Returns:

a task for monitoring the progress of the operation.