com.emc.vipr.client.core

Class BlockFullCopies

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

com.emc.vipr.client.core.BlockFullCopies

All Implemented Interfaces:

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

public class BlockFullCopies
extends ProjectResources<VolumeRestRep>
implements TaskResources<VolumeRestRep>

Constructor Summary

Constructors

Constructor and Description
BlockFullCopies(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Tasks<VolumeRestRep>	activateFullCopy(java.net.URI copyId) Begins activating a full copy of the given block volume.
VolumeRestRep	checkFullCopyProgress(java.net.URI copyId) Gets the full copy volume with an updated value of the progress of the operation.
Tasks<VolumeRestRep>	detachFullCopy(java.net.URI copyId) Begins detach a full copy of 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.
Tasks<VolumeRestRep>	restoreFromFullCopy(java.net.URI copyId) Begins restore from a full copy of the given block volume.
Tasks<VolumeRestRep>	resynchronizeFullCopy(java.net.URI copyId) Begins resynchronizing a full copy of the given block volume.
Tasks<VolumeRestRep>	startFullCopy(java.net.URI copyId) Begins creating group synchronization between volume group and full copy group.
BlockFullCopies	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
BlockFullCopies	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

BlockFullCopies

public BlockFullCopies(ViPRCoreClient parent,
                       RestClient client)

Method Detail

withInactive

public BlockFullCopies 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 BlockFullCopies 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.

activateFullCopy

public Tasks<VolumeRestRep> activateFullCopy(java.net.URI copyId)

Begins activating a full copy of the given block volume.

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

Parameters:

copyId - the ID of the full copy to activate.

Returns:

a task for monitoring the progress of the operation.

restoreFromFullCopy

public Tasks<VolumeRestRep> restoreFromFullCopy(java.net.URI copyId)

Begins restore from a full copy of the given block volume.

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

Parameters:

copyId - the ID of the full copy to restore from.

Returns:

a task for monitoring the progress of the operation.

resynchronizeFullCopy

public Tasks<VolumeRestRep> resynchronizeFullCopy(java.net.URI copyId)

Begins resynchronizing a full copy of the given block volume.

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

Parameters:

copyId - the ID of the full copy to resynchronize.

Returns:

a task for monitoring the progress of the operation.

detachFullCopy

public Tasks<VolumeRestRep> detachFullCopy(java.net.URI copyId)

Begins detach a full copy of the given block volume.

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

Parameters:

copyId - the ID of the full copy to detach.

Returns:

a task for monitoring the progress of the operation.

startFullCopy

public Tasks<VolumeRestRep> startFullCopy(java.net.URI copyId)

Begins creating group synchronization between volume group and full copy group.

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

Parameters:

copyId - the ID of the full copy.

Returns:

a task for monitoring the progress of the operation.

checkFullCopyProgress

public VolumeRestRep checkFullCopyProgress(java.net.URI copyId)

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/full-copies/{id}/check-progress

Parameters:

copyId - the ID of the full copy.

Returns:

the full copy volume.

See Also:

VolumeRestRep.FullCopyRestRep#getPercentSynced()