com.emc.vipr.client.core

Class BlockSnapshotSessions

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

com.emc.vipr.client.core.BlockSnapshotSessions

All Implemented Interfaces:

BulkResources<BlockSnapshotSessionRestRep>, Resources<BlockSnapshotSessionRestRep>, TaskResources<BlockSnapshotSessionRestRep>

public class BlockSnapshotSessions
extends ProjectResources<BlockSnapshotSessionRestRep>
implements TaskResources<BlockSnapshotSessionRestRep>

Block snapshot session resources.

Base URL: /block/snapshot-sessions

Constructor Summary

Constructors

Constructor and Description
BlockSnapshotSessions(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Tasks<BlockSnapshotSessionRestRep>	createForVolume(java.net.URI volumeId, SnapshotSessionCreateParam param) Begins creating a snapshot session (or snapshot sessions) of a given block volume by ID.
Tasks<BlockSnapshotSessionRestRep>	deactivate(java.net.URI id, VolumeDeleteTypeEnum type) Begins deactivating a given block snapshot session by ID.
java.util.List<BlockSnapshotSessionRestRep>	getByConsistencyGroup(java.net.URI consistencyGroupId) Gets the block snapshot sessions for a consistency group by ID.
java.util.List<BlockSnapshotSessionRestRep>	getByConsistencyGroup(java.net.URI consistencyGroupId, ResourceFilter<BlockSnapshotSessionRestRep> filter) Gets the block snapshot sessions for a consistency group by ID, optionally filtering the results.
java.util.List<BlockSnapshotSessionRestRep>	getByVolume(java.net.URI volumeId) Gets the block snapshot sessions for a given block volume.
java.util.List<BlockSnapshotSessionRestRep>	getByVolume(java.net.URI volumeId, ResourceFilter<BlockSnapshotSessionRestRep> filter) Gets the block snapshot sessions for a given block volume, optionally filtering the results.
Task<BlockSnapshotSessionRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<BlockSnapshotSessionRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
Tasks<BlockSnapshotSessionRestRep>	linkTargets(java.net.URI snapshotSessionId, SnapshotSessionLinkTargetsParam linkTargetsParam) Create and link new targets to an existing BlockSnapshotSession instance.
java.util.List<NamedRelatedResourceRep>	listByConsistencyGroup(java.net.URI consistencyGroupId) Lists the block snapshot sessions for a consistency group by ID.
java.util.List<NamedRelatedResourceRep>	listByVolume(java.net.URI volumeId) Lists the block snapshot sessions for a given block volume.
Tasks<BlockSnapshotSessionRestRep>	relinkTargets(java.net.URI snapshotSessionId, SnapshotSessionRelinkTargetsParam relinkTargetsParam) Re-link a target to either its current snapshot session or to a different snapshot session of the same source.
Task<BlockSnapshotSessionRestRep>	restore(java.net.URI id) Restores the data on the array snapshot point-in-time copy represented by the BlockSnapshotSession instance with the passed id, to the snapshot session source object.
Task<BlockSnapshotSessionRestRep>	unlinkTargets(java.net.URI snapshotSessionId, SnapshotSessionUnlinkTargetsParam unlinkTargetsParam) Unlink target volumes from an existing BlockSnapshotSession instance and optionally delete those target volumes.
BlockSnapshotSessions	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
BlockSnapshotSessions	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

BlockSnapshotSessions

public BlockSnapshotSessions(ViPRCoreClient parent,
                             RestClient client)

Method Detail

withInactive

public BlockSnapshotSessions withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<BlockSnapshotSessionRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public BlockSnapshotSessions withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<BlockSnapshotSessionRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

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

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

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

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

createForVolume

public Tasks<BlockSnapshotSessionRestRep> createForVolume(java.net.URI volumeId,
                                                          SnapshotSessionCreateParam param)

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

API Call: POST /block/volumes/{volumeId}/protection/snapshot-sessions

Parameters:

volumeId - the ID of the block volume to create a snapshot session.

param - the snapshot session configuration.

Returns:

tasks for monitoring the progress each snapshot session creation.

listByVolume

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

Lists the block snapshot sessions for a given block volume.

API Call: GET /block/volumes/{volumeId}/protection/snapshot-sessions

Parameters:

volumeId - the ID of the block volume.

Returns:

the list of snapshot session references for the volume.

getByVolume

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

Gets the block snapshot sessions for a given block volume.

Parameters:

volumeId - the ID of the block volume.

Returns:

the list of block snapshot sessions for the volume.

See Also:

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

getByVolume

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

Gets the block snapshot sessions 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 snapshot sessions for the volume.

See Also:

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

linkTargets

public Tasks<BlockSnapshotSessionRestRep> linkTargets(java.net.URI snapshotSessionId,
                                                      SnapshotSessionLinkTargetsParam linkTargetsParam)

Create and link new targets to an existing BlockSnapshotSession instance.

API Call: POST /block/snapshot-sessions/{id}/link-targets

Parameters:

snapshotSessionId - The URI of the BlockSnapshotSession instance to which the new targets will be linked.

linkTargetsParam - The new linked target information.

Returns:

tasks for monitoring the progress of the operation.

relinkTargets

public Tasks<BlockSnapshotSessionRestRep> relinkTargets(java.net.URI snapshotSessionId,
                                                        SnapshotSessionRelinkTargetsParam relinkTargetsParam)

Re-link a target to either its current snapshot session or to a different snapshot session of the same source.

API Call: POST /block/snapshot-sessions/{id}/relink-targets

Parameters:

snapshotSessionId - The URI of the BlockSnapshotSession instance to which the the targets will be relinked.

relinkTargetsParam - The existing linked target information.

Returns:

tasks for monitoring the progress of the operation.

unlinkTargets

public Task<BlockSnapshotSessionRestRep> unlinkTargets(java.net.URI snapshotSessionId,
                                                       SnapshotSessionUnlinkTargetsParam unlinkTargetsParam)

Unlink target volumes from an existing BlockSnapshotSession instance and optionally delete those target volumes.

API Call: POST /block/snapshot-sessions/{id}/unlink-targets

Parameters:

snapshotSessionId - The URI of the BlockSnapshotSession instance to which the new targets are currently linked.

unlinkTargetsParam - The linked target information for the snapshots to unlink.

Returns:

tasks for monitoring the progress of the operation.

restore

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

Restores the data on the array snapshot point-in-time copy represented by the BlockSnapshotSession instance with the passed id, to the snapshot session source object.

API Call: POST /block/snapshot-sessions/{id}/restore

Parameters:

id - the ID of the snapshot session to restore.

Returns:

task for monitoring the progress of the operation.

deactivate

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

Begins deactivating a given block snapshot session by ID.

API Call: POST /block/snapshot-sessions/{id}/deactivate

Parameters:

id - the ID of the snapshot session to deactivate.

type - FULL or VIPR_ONLY

Returns:

a task for monitoring the progress of the operation.

listByConsistencyGroup

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

Lists the block snapshot sessions for a consistency group by ID. API Call: GET /block/consistency-groups/{consistencyGroupId}/protection/snapshot-sessions

Parameters:

consistencyGroupId - the ID of the consistency group.

Returns:

the list of block snapshot session references.

getByConsistencyGroup

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

Gets the block snapshot sessions for a consistency group by ID.

Parameters:

consistencyGroupId - the ID of the consistency group.

Returns:

the list of block snapshot session references.

See Also:

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

getByConsistencyGroup

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

Gets the block snapshot sessions 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 block snapshot session references.

See Also:

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