com.emc.vipr.client.core

Class BlockMigrations

java.lang.Object

com.emc.vipr.client.core.AbstractResources<T>

com.emc.vipr.client.core.AbstractBulkResources<T>

com.emc.vipr.client.core.AbstractCoreBulkResources<MigrationRestRep>

com.emc.vipr.client.core.BlockMigrations

All Implemented Interfaces:

BulkResources<MigrationRestRep>, Resources<MigrationRestRep>, TaskResources<MigrationRestRep>, TopLevelResources<MigrationRestRep>

public class BlockMigrations
extends AbstractCoreBulkResources<MigrationRestRep>
implements TopLevelResources<MigrationRestRep>, TaskResources<MigrationRestRep>

Block Volume Migration resources.

Base URL: /block/migrations

See Also:

MigrationRestRep

Constructor Summary

Constructors

Constructor and Description
BlockMigrations(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<MigrationRestRep>	cancel(java.net.URI id) Begins canceling a block volume migration.
Task<MigrationRestRep>	commit(java.net.URI id) Begins committing a block volume migration.
java.util.List<MigrationRestRep>	getAll() Gets all resources for this resource type.
java.util.List<MigrationRestRep>	getAll(ResourceFilter<MigrationRestRep> filter) Gets all resources for this resource type.
Task<MigrationRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<MigrationRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
java.util.List<NamedRelatedResourceRep>	list() Lists all block volume migrations.
Task<MigrationRestRep>	pause(java.net.URI id) Begins pausing a block volume migration.
Task<MigrationRestRep>	resume(java.net.URI id) Begins resuming a block volume migration.
BlockMigrations	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
BlockMigrations	withInternal(boolean internal) Configures the fetch operations to include internal resources.

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, search, 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, search, updateTags

Constructor Detail

BlockMigrations

public BlockMigrations(ViPRCoreClient parent,
                       RestClient client)

Method Detail

withInactive

public BlockMigrations withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<MigrationRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public BlockMigrations withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<MigrationRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

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

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

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

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

list

public java.util.List<NamedRelatedResourceRep> list()

Lists all block volume migrations.

API Call: GET /block/migrations

Specified by:

list in interface TopLevelResources<MigrationRestRep>

Returns:

the list of block volume migration references.

getAll

public java.util.List<MigrationRestRep> getAll()

Description copied from interface: TopLevelResources

Gets all resources for this resource type. This is combination of the list() call combined with a bulk query to retrieve the resources.

API Call: GET /RESOURCE_PATH

Specified by:

getAll in interface TopLevelResources<MigrationRestRep>

Returns:

All resources of this type available to the user.

See Also:

TopLevelResources.list(), Resources.getByRefs(java.util.Collection)

getAll

public java.util.List<MigrationRestRep> getAll(ResourceFilter<MigrationRestRep> filter)

Description copied from interface: TopLevelResources

Gets all resources for this resource type. This is combination of the list() call combined with a bulk query to retrieve the resources. This optionally filters the results by the filter specified.

API Call: GET /RESOURCE_PATH

Specified by:

getAll in interface TopLevelResources<MigrationRestRep>

Parameters:

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

Filtered list of resources of this type available to the user.

See Also:

TopLevelResources.list(), Resources.getByRefs(java.util.Collection, ResourceFilter)

pause

public Task<MigrationRestRep> pause(java.net.URI id)

Begins pausing a block volume migration.

API Call: POST /block/migrations/{id}/pause

Parameters:

id - the ID of the block volume migration.

Returns:

a task for monitoring the progress of the operation.

resume

public Task<MigrationRestRep> resume(java.net.URI id)

Begins resuming a block volume migration.

API Call: POST /block/migrations/{id}/resume

Parameters:

id - the ID of the block volume migration.

Returns:

a task for monitoring the progress of the operation.

commit

public Task<MigrationRestRep> commit(java.net.URI id)

Begins committing a block volume migration.

API Call: POST /block/migrations/{id}/commit

Parameters:

id - the ID of the block volume migration.

Returns:

a task for monitoring the progress of the operation.

cancel

public Task<MigrationRestRep> cancel(java.net.URI id)

Begins canceling a block volume migration.

API Call: POST /block/migrations/{id}/cancel

Parameters:

id - the ID of the block volume migration.

Returns:

a task for monitoring the progress of the operation.