com.emc.vipr.client.core

Class BlockConsistencyGroups

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

com.emc.vipr.client.core.BlockConsistencyGroups

All Implemented Interfaces:

BulkResources<BlockConsistencyGroupRestRep>, Resources<BlockConsistencyGroupRestRep>, TaskResources<BlockConsistencyGroupRestRep>

public class BlockConsistencyGroups
extends ProjectResources<BlockConsistencyGroupRestRep>
implements TaskResources<BlockConsistencyGroupRestRep>

Block Consistency Group resources.

Base URL: /block/consistency-groups

See Also:

BlockConsistencyGroupRestRep

Constructor Summary

Constructors

Constructor and Description
BlockConsistencyGroups(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Tasks<BlockConsistencyGroupRestRep>	activateFullCopy(java.net.URI consistencyGroupId, java.net.URI fullCopyId) Activate consistency group full copy
Task<BlockConsistencyGroupRestRep>	activateSnapshot(java.net.URI consistencyGroupId, java.net.URI snapshotId) Activate consistency group snapshot
BlockConsistencyGroupRestRep	create(BlockConsistencyGroupCreate input) Creates a block consistency group.
Tasks<BlockConsistencyGroupRestRep>	createFullCopy(java.net.URI consistencyGroupId, VolumeFullCopyCreateParam input) Begins creating a full copy of the given block volume.
Tasks<BlockConsistencyGroupRestRep>	createSnapshot(java.net.URI consistencyGroupId, BlockConsistencyGroupSnapshotCreate input) Create consistency group snapshot
Tasks<BlockConsistencyGroupRestRep>	createSnapshotSession(java.net.URI consistencyGroupId, SnapshotSessionCreateParam input) Create consistency group snapshot session
Task<BlockConsistencyGroupRestRep>	deactivate(java.net.URI id) Begins deactivating a block consistency group.
Tasks<BlockConsistencyGroupRestRep>	deactivateFullCopy(java.net.URI consistencyGroupId, java.net.URI fullCopyId) Deactivate consistency group full copy
Tasks<BlockConsistencyGroupRestRep>	deactivateSnapshot(java.net.URI consistencyGroupId, java.net.URI snapshotId) Deactivate consistency group snapshot
Tasks<BlockConsistencyGroupRestRep>	deactivateSnapshotSession(java.net.URI consistencyGroupId, java.net.URI snapshotSessionId) Deactivate consistency group snapshot session
Tasks<BlockConsistencyGroupRestRep>	detachFullCopy(java.net.URI consistencyGroupId, java.net.URI fullCopyId) Detach consistency group full copy
Tasks<BlockConsistencyGroupRestRep>	failover(java.net.URI consistencyGroupId, CopiesParam input) Begins initiating failover for a given consistency group.
Tasks<BlockConsistencyGroupRestRep>	failoverCancel(java.net.URI consistencyGroupId, CopiesParam input) Begins initiating failover cancel for a given consistency group.
java.util.List<NamedRelatedResourceRep>	getFullCopies(java.net.URI consistencyGroupId) List full copies for a consistency group
java.util.List<NamedRelatedResourceRep>	getSnapshots(java.net.URI consistencyGroupId) List snapshots in the consistency group
java.util.List<NamedRelatedResourceRep>	getSnapshotSessions(java.net.URI consistencyGroupId) List snapshot sessions in the consistency group
Task<BlockConsistencyGroupRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<BlockConsistencyGroupRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
Tasks<BlockConsistencyGroupRestRep>	restoreFullCopy(java.net.URI consistencyGroupId, java.net.URI fullCopyId) Restore consistency group full copy
Task<BlockConsistencyGroupRestRep>	restoreSnapshot(java.net.URI consistencyGroupId, java.net.URI snapshotId) Restore consistency group snapshot
Task<BlockConsistencyGroupRestRep>	restoreSnapshotSession(java.net.URI consistencyGroupId, java.net.URI snapshotSessionId) Restore consistency group snapshot session
Tasks<BlockConsistencyGroupRestRep>	resynchronizeFullCopy(java.net.URI consistencyGroupId, java.net.URI fullCopyId) Resynchronize consistency group full copy
Task<BlockConsistencyGroupRestRep>	resynchronizeSnapshot(java.net.URI consistencyGroupId, java.net.URI snapshotId) Resynchronize consistency group snapshot
Tasks<BlockConsistencyGroupRestRep>	swap(java.net.URI consistencyGroupId, CopiesParam input) Begins initiating swap for a given consistency group.
Task<BlockConsistencyGroupRestRep>	update(java.net.URI id, BlockConsistencyGroupUpdate input) Begins updating a block consistency group.
Tasks<BlockConsistencyGroupRestRep>	updateCopyAccessMode(java.net.URI consistencyGroupId, CopiesParam input) Begins updating the access mode for a given consistency group copy.
BlockConsistencyGroups	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
BlockConsistencyGroups	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

BlockConsistencyGroups

public BlockConsistencyGroups(ViPRCoreClient parent,
                              RestClient client)

Method Detail

withInactive

public BlockConsistencyGroups withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<BlockConsistencyGroupRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public BlockConsistencyGroups withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<BlockConsistencyGroupRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

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

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

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

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

createFullCopy

public Tasks<BlockConsistencyGroupRestRep> createFullCopy(java.net.URI consistencyGroupId,
                                                          VolumeFullCopyCreateParam input)

Begins creating a full copy of the given block volume.

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

Parameters:

consistencyGroupId - the ID of the consistency group.

input - the create configuration.

Returns:

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

getFullCopies

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

List full copies for a consistency group

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

Parameters:

consistencyGroupId - the ID of the consistency group

Returns:

The list of full copies for the consistency group

activateFullCopy

public Tasks<BlockConsistencyGroupRestRep> activateFullCopy(java.net.URI consistencyGroupId,
                                                            java.net.URI fullCopyId)

Activate consistency group full copy

API Call: POST /block/consistency-groups/{id}/protection/full-copies/{fcid}/activate

Parameters:

consistencyGroupId - the ID of the consistency group.

fullCopyId - the Id of the full copy

Returns:

An asychronous operation realized as a Tasks object

detachFullCopy

public Tasks<BlockConsistencyGroupRestRep> detachFullCopy(java.net.URI consistencyGroupId,
                                                          java.net.URI fullCopyId)

Detach consistency group full copy

API Call: POST /block/consistency-groups/{id}/protection/full-copies/{fcid}/detach

Parameters:

consistencyGroupId - the ID of the consistency group.

fullCopyId - the Id of the full copy

Returns:

An asychronous operation realized as a Tasks object

restoreFullCopy

public Tasks<BlockConsistencyGroupRestRep> restoreFullCopy(java.net.URI consistencyGroupId,
                                                           java.net.URI fullCopyId)

Restore consistency group full copy

API Call: POST /block/consistency-groups/{id}/protection/full-copies/{fcid}/restore

Parameters:

consistencyGroupId - the ID of the consistency group.

fullCopyId - the Id of the full copy

Returns:

An asychronous operation realized as a Tasks object

resynchronizeFullCopy

public Tasks<BlockConsistencyGroupRestRep> resynchronizeFullCopy(java.net.URI consistencyGroupId,
                                                                 java.net.URI fullCopyId)

Resynchronize consistency group full copy

API Call: POST /block/consistency-groups/{id}/protection/full-copies/{fcid}/resynchronize

Parameters:

consistencyGroupId - the ID of the consistency group.

fullCopyId - the Id of the full copy

Returns:

An asychronous operation realized as a Tasks object

deactivateFullCopy

public Tasks<BlockConsistencyGroupRestRep> deactivateFullCopy(java.net.URI consistencyGroupId,
                                                              java.net.URI fullCopyId)

Deactivate consistency group full copy

API Call: POST /block/consistency-groups/{id}/protection/full-copies/{fcid}/deactivate

Parameters:

consistencyGroupId - the ID of the consistency group.

fullCopyId - the Id of the full copy

Returns:

An asychronous operation realized as a Tasks object

getSnapshots

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

List snapshots in the consistency group

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

Parameters:

consistencyGroupId - the ID of the consistency group

Returns:

The list of snapshots in the consistency group

createSnapshot

public Tasks<BlockConsistencyGroupRestRep> createSnapshot(java.net.URI consistencyGroupId,
                                                          BlockConsistencyGroupSnapshotCreate input)

Create consistency group snapshot

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

Parameters:

consistencyGroupId - the ID of the consistency group

input - the create snapshot specification

Returns:

An asychronous operation realized as a Tasks object

activateSnapshot

public Task<BlockConsistencyGroupRestRep> activateSnapshot(java.net.URI consistencyGroupId,
                                                           java.net.URI snapshotId)

Activate consistency group snapshot

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

Parameters:

consistencyGroupId - the ID of the consistency group

snapshotId - the ID of the snapshot

Returns:

An asychronous operation realized as a Task object

deactivateSnapshot

public Tasks<BlockConsistencyGroupRestRep> deactivateSnapshot(java.net.URI consistencyGroupId,
                                                              java.net.URI snapshotId)

Deactivate consistency group snapshot

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

Parameters:

consistencyGroupId - the ID of the consistency group

snapshotId - the ID of the snapshot

Returns:

An asychronous operation realized as a Tasks object

restoreSnapshot

public Task<BlockConsistencyGroupRestRep> restoreSnapshot(java.net.URI consistencyGroupId,
                                                          java.net.URI snapshotId)

Restore consistency group snapshot

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

Parameters:

consistencyGroupId - the ID of the consistency group

snapshotId - the ID of the snapshot

Returns:

An asychronous operation realized as a Task object

resynchronizeSnapshot

public Task<BlockConsistencyGroupRestRep> resynchronizeSnapshot(java.net.URI consistencyGroupId,
                                                                java.net.URI snapshotId)

Resynchronize consistency group snapshot

API Call: POST /block/consistency-groups/{id}/protection/snapshot/{fcid}/resynchronize

Parameters:

consistencyGroupId - the ID of the consistency group.

snapshotId - the Id of the snapshot

Returns:

An asychronous operation realized as a Tasks object

failover

public Tasks<BlockConsistencyGroupRestRep> failover(java.net.URI consistencyGroupId,
                                                    CopiesParam input)

Begins initiating failover for a given consistency group.

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

Parameters:

consistencyGroupId - the ID of the consistency group.

input - the input configuration.

Returns:

a task for monitoring the progress of the operation.

failoverCancel

public Tasks<BlockConsistencyGroupRestRep> failoverCancel(java.net.URI consistencyGroupId,
                                                          CopiesParam input)

Begins initiating failover cancel for a given consistency group.

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

Parameters:

consistencyGroupId - the ID of the consistency group.

input - the input configuration.

Returns:

a task for monitoring the progress of the operation.

updateCopyAccessMode

public Tasks<BlockConsistencyGroupRestRep> updateCopyAccessMode(java.net.URI consistencyGroupId,
                                                                CopiesParam input)

Begins updating the access mode for a given consistency group copy.

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

Parameters:

consistencyGroupId - the ID of the consistency group.

input - the input configuration.

Returns:

a task for monitoring the progress of the operation.

swap

public Tasks<BlockConsistencyGroupRestRep> swap(java.net.URI consistencyGroupId,
                                                CopiesParam input)

Begins initiating swap for a given consistency group.

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

Parameters:

consistencyGroupId - the ID of the consistency group.

input - the input configuration.

Returns:

a task for monitoring the progress of the operation.

create

public BlockConsistencyGroupRestRep create(BlockConsistencyGroupCreate input)

Creates a block consistency group.

API Call: POST /block/consistency-groups

Parameters:

input - the create configuration.

Returns:

the created block consistency group.

update

public Task<BlockConsistencyGroupRestRep> update(java.net.URI id,
                                                 BlockConsistencyGroupUpdate input)

Begins updating a block consistency group.

API Call: PUT /block/consistency-groups/{id}

Parameters:

id - the ID of the block consistency group to update.

input - the update configuration.

Returns:

a task for monitoring the progress of the update operation.

deactivate

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

Begins deactivating a block consistency group.

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

Parameters:

id - the ID of the block consistency group to deactivate.

Returns:

a task for monitoring the progres of the deactivate operation.

See Also:

AbstractResources.doDeactivateWithTask(URI)

getSnapshotSessions

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

List snapshot sessions in the consistency group

API Call: GET /block/consistency-groups/{id}/protection/snapshot-sessions

Parameters:

consistencyGroupId - the ID of the consistency group

Returns:

The list of snapshot sessions in the consistency group

createSnapshotSession

public Tasks<BlockConsistencyGroupRestRep> createSnapshotSession(java.net.URI consistencyGroupId,
                                                                 SnapshotSessionCreateParam input)

Create consistency group snapshot session

API Call: POST /block/consistency-groups/{id}/protection/snapshot-sessions

Parameters:

consistencyGroupId - the ID of the consistency group

input - the create snapshot session specification

Returns:

An asychronous operation realized as a Tasks object

deactivateSnapshotSession

public Tasks<BlockConsistencyGroupRestRep> deactivateSnapshotSession(java.net.URI consistencyGroupId,
                                                                     java.net.URI snapshotSessionId)

Deactivate consistency group snapshot session

API Call: POST /block/consistency-groups/{id}/protection/snapshot-sessions/{sid}/deactivate

Parameters:

consistencyGroupId - the ID of the consistency group

snapshotSessionId - the ID of the snapshot session

Returns:

An asychronous operation realized as a Tasks object

restoreSnapshotSession

public Task<BlockConsistencyGroupRestRep> restoreSnapshotSession(java.net.URI consistencyGroupId,
                                                                 java.net.URI snapshotSessionId)

Restore consistency group snapshot session

API Call: POST /block/consistency-groups/{id}/protection/snapshot-sessions/{sid}/restore

Parameters:

consistencyGroupId - the ID of the consistency group

snapshotSessionId - the ID of the snapshot session

Returns:

An asychronous operation realized as a Task object