public class BlockSnapshots extends ProjectResources<BlockSnapshotRestRep> implements TaskResources<BlockSnapshotRestRep>
Base URL: /block/snapshots
Constructor and Description |
---|
BlockSnapshots(ViPRCoreClient parent,
RestClient client) |
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.
|
findByProject, findByProject, findByProject, findByProject, search
getByIds, getByRefs, listBulkIds
addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, updateTags
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getByIds, getByRefs
addTags, get, get, getTags, removeTags, updateTags
public BlockSnapshots(ViPRCoreClient parent, RestClient client)
public BlockSnapshots withInactive(boolean inactive)
AbstractResources
withInactive
in class AbstractResources<BlockSnapshotRestRep>
inactive
- whether to include inactive resources.public BlockSnapshots withInternal(boolean internal)
AbstractResources
withInternal
in class AbstractResources<BlockSnapshotRestRep>
internal
- whether to include internal resources.public Tasks<BlockSnapshotRestRep> getTasks(java.net.URI id)
TaskResources
API Call: GET baseUrl/{id}/tasks
getTasks
in interface TaskResources<BlockSnapshotRestRep>
id
- the resource ID.public Task<BlockSnapshotRestRep> getTask(java.net.URI id, java.net.URI taskId)
TaskResources
API Call: GET baseUrl/{id}/tasks/{taskId}
getTask
in interface TaskResources<BlockSnapshotRestRep>
id
- the resource ID.taskId
- the task ID.public Task<BlockSnapshotRestRep> activate(java.net.URI id)
API Call: POST /block/snapshots/{id}/activate
id
- the ID of the snapshot to activate.public Task<BlockSnapshotRestRep> restore(java.net.URI id)
API Call: POST /block/snapshots/{id}/restore
id
- the ID of the snapshot to restore.public Task<BlockSnapshotRestRep> start(java.net.URI id)
API Call: POST /block/snapshots/{id}/start
id
- the ID of the snapshot.public Tasks<BlockSnapshotRestRep> deactivate(java.net.URI id)
API Call: POST /block/snapshots/{id}/deactivate
id
- the ID of the snapshot to deactivate.public Tasks<BlockSnapshotRestRep> deactivate(java.net.URI id, VolumeDeleteTypeEnum type)
API Call: POST /block/snapshots/{id}/deactivate
id
- the ID of the snapshot to deactivate.type
- FULL
or VIPR_ONLY
public java.util.List<ITLRestRep> listExports(java.net.URI id)
API Call: GET /block/snapshots/{id}/exports
id
- the ID of the snapshot.public java.util.List<NamedRelatedResourceRep> listByVolume(java.net.URI volumeId)
API Call: GET /block/volumes/{volumeId}/protection/snapshots
volumeId
- the ID of the block volume.public java.util.List<BlockSnapshotRestRep> getByVolume(java.net.URI volumeId)
volumeId
- the ID of the block volume.listByVolume(URI)
,
AbstractResources.getByRefs(java.util.Collection)
public java.util.List<BlockSnapshotRestRep> getByVolume(java.net.URI volumeId, ResourceFilter<BlockSnapshotRestRep> filter)
volumeId
- the ID of the block volume.filter
- the filter to apply (may be null, for no filtering).listByVolume(URI)
,
AbstractBulkResources.getByRefs(java.util.Collection, ResourceFilter)
public Tasks<BlockSnapshotRestRep> createForVolume(java.net.URI volumeId, VolumeSnapshotParam input)
API Call: POST /block/volumes/{volumeId}/protection/snapshots
volumeId
- the ID of the block volume to snapshot.input
- the snapshot configuration.public java.util.List<NamedRelatedResourceRep> listByConsistencyGroup(java.net.URI consistencyGroupId)
API Call: GET /block/consistency-groups/{consistencyGroupId}/protection/snapshots
consistencyGroupId
- the ID of the consistency group.public java.util.List<BlockSnapshotRestRep> getByConsistencyGroup(java.net.URI consistencyGroupId)
consistencyGroupId
- the ID of the consistency group.listByConsistencyGroup(URI)
,
AbstractResources.getByRefs(java.util.Collection)
public java.util.List<BlockSnapshotRestRep> getByConsistencyGroup(java.net.URI consistencyGroupId, ResourceFilter<BlockSnapshotRestRep> filter)
consistencyGroupId
- the ID of the consistency group.filter
- the filter to apply (may be null, for no filtering).listByConsistencyGroup(URI)
,
AbstractBulkResources.getByRefs(java.util.Collection, ResourceFilter)
public Tasks<BlockSnapshotRestRep> createForConsistencyGroup(java.net.URI consistencyGroupId, BlockConsistencyGroupSnapshotCreate input)
API Call: POST /block/consistency-groups/{consistencyGroupId}/protection/snapshots
consistencyGroupId
- the ID of the consistency group.input
- the create configuration.public BlockSnapshotRestRep getForConsistencyGroup(java.net.URI consistencyGroupId, java.net.URI id)
API Call: GET /block/consistency-groups/{consistencyGroupId}/protection/snapshots/{id}
consistencyGroupId
- the ID of the consistency group.id
- the ID of the block snapshot.public Task<BlockSnapshotRestRep> activateForConsistencyGroup(java.net.URI consistencyGroupId, java.net.URI id)
API Call: POST /block/consistency-groups/{consistencyGroupId}/protection/snapshots/{id}/activate
consistencyGroupId
- the ID of the consistency group.id
- the ID of the block snapshot to activate.public Tasks<BlockSnapshotRestRep> deactivateForConsistencyGroup(java.net.URI consistencyGroupId, java.net.URI id)
API Call: POST /block/consistency-groups/{consistencyGroupId}/protection/snapshots/{id}/deactivate
consistencyGroupId
- the ID of the consistency group.id
- the ID of the block snapshot to deactivate.public Task<BlockSnapshotRestRep> restoreForConsistencyGroup(java.net.URI consistencyGroupId, java.net.URI id)
API Call: POST /block/consistency-groups/{consistencyGroupId}/protection/snapshots/{id}/restore
consistencyGroupId
- the ID of the consistency group.id
- the ID of the block snapshot to restore.public Task<BlockSnapshotRestRep> expose(java.net.URI id)
API Call: POST /block/snapshots/{id}/expose
id
- the URI of the block snapshotpublic Tasks<BlockSnapshotRestRep> createFullCopy(java.net.URI id, VolumeFullCopyCreateParam input)
public Task<BlockSnapshotRestRep> resynchronizeBlockSnapshot(java.net.URI snapshotId)
API Call: POST /block/snapshots/{id}/resynchronize
snapshotId
- the ID of the block snapshot to resynchronize.