com.emc.vipr.client.core

Class BlockExports

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

com.emc.vipr.client.core.BlockExports

All Implemented Interfaces:

BulkResources<ExportGroupRestRep>, Resources<ExportGroupRestRep>, TaskResources<ExportGroupRestRep>

public class BlockExports
extends ProjectResources<ExportGroupRestRep>
implements TaskResources<ExportGroupRestRep>

Block export resources.

Base URL: /block/exports

See Also:

ExportGroupRestRep

Constructor Summary

Constructors

Constructor and Description
BlockExports(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<ExportGroupRestRep>	create(ExportCreateParam input) Begins creating a block export.
Task<ExportGroupRestRep>	deactivate(java.net.URI id) Begins deactivating a block export by ID.
java.util.List<ExportGroupRestRep>	findByCluster(java.net.URI clusterId, java.net.URI projectId, java.net.URI varrayId) Finds the exports associated with a cluster.
java.util.List<ExportGroupRestRep>	findByHost(java.net.URI hostId, java.net.URI projectId, java.net.URI varrayId) Finds the exports associated with a host.
java.util.List<ExportGroupRestRep>	findByHostOrCluster(java.net.URI hostId, java.net.URI projectId) Deprecated. This was a convenience method to a deprecated method.
java.util.List<ExportGroupRestRep>	findByHostOrCluster(java.net.URI hostId, java.net.URI projectId, java.net.URI virtualArrayId) Deprecated. This method was only used in one test class ViPRClientApp which doesn't use this method anymore.
java.util.List<ExportGroupRestRep>	findByName(java.lang.String name, java.net.URI projectId, java.net.URI varrayId) Finds the exports by name.
java.util.List<ExportGroupRestRep>	findContainingCluster(java.net.URI clusterId) Finds the exports associated with a cluster.
java.util.List<ExportGroupRestRep>	findContainingHost(java.net.URI hostId) Finds any exports (HOST, CLUSTER or EXCLUSIVE) that contain the host.
java.util.List<ExportGroupRestRep>	findContainingHost(java.net.URI hostId, java.net.URI projectId, java.net.URI varrayId) Finds any exports (HOST, CLUSTER or EXCLUSIVE) that contain the host.
java.util.List<ExportGroupRestRep>	getExports(java.util.List<java.net.URI> exportIds)
java.util.List<ITLRestRep>	getExportsForInitiatorPorts(java.util.Collection<java.lang.String> initiatorPorts) Gets the exports (initiator-target-lun) for the given initiator ports.
java.util.List<ITLRestRep>	getExportsForInitiators(java.util.Collection<InitiatorRestRep> initiators) Gets the exports (initiator-target-lun) for the given initiators.
Task<ExportGroupRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<ExportGroupRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
ExportGroupSearchBuilder	search() Creates a search builder specifically for creating export group search queries.
Task<ExportGroupRestRep>	update(java.net.URI id, ExportUpdateParam input) Begins updating a block export.
BlockExports	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
BlockExports	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

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

BlockExports

public BlockExports(ViPRCoreClient parent,
                    RestClient client)

Method Detail

withInactive

public BlockExports withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<ExportGroupRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public BlockExports withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<ExportGroupRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getExports

public java.util.List<ExportGroupRestRep> getExports(java.util.List<java.net.URI> exportIds)

getTasks

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

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

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

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

create

public Task<ExportGroupRestRep> create(ExportCreateParam input)

Begins creating a block export.

API Call: POST /block/exports

Parameters:

input - the create configuration.

Returns:

a task for monitoring the progress of the export creation.

update

public Task<ExportGroupRestRep> update(java.net.URI id,
                                       ExportUpdateParam input)

Begins updating a block export.

API Call: PUT /block/exports/{id}

Parameters:

id - the ID of the block export to update.

input - the update configuration.

Returns:

a task for monitoring the progress of the export update.

deactivate

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

Begins deactivating a block export by ID.

API Call: POST /block/exports/{id}/deactivate

Parameters:

id - the ID of the block export to deactivate.

Returns:

a task for monitoring the progress of the export deactivate.

findByCluster

public java.util.List<ExportGroupRestRep> findByCluster(java.net.URI clusterId,
                                                        java.net.URI projectId,
                                                        java.net.URI varrayId)

Finds the exports associated with a cluster.

Parameters:

clusterId - the ID of the cluster.

projectId - the ID of the project to restrict exports to, or null for no restriction*

varrayId - the ID of the varray to restrict exports to, or null for no restriction*

Returns:

the list of export groups associated with the cluster.

findByHost

public java.util.List<ExportGroupRestRep> findByHost(java.net.URI hostId,
                                                     java.net.URI projectId,
                                                     java.net.URI varrayId)

Finds the exports associated with a host.

Parameters:

hostId - the ID of the host.

projectId - the ID of the project to restrict exports to, or null for no restriction

varrayId - the ID of the varray to restrict exports to, or null for no restriction* *

Returns:

the list of export groups associated with the host.

findByName

public java.util.List<ExportGroupRestRep> findByName(java.lang.String name,
                                                     java.net.URI projectId,
                                                     java.net.URI varrayId)

Finds the exports by name.

Parameters:

name - Name to search for.

projectId - the ID of the project to restrict exports to, or null for no restriction

varrayId - the ID of the varray to restrict exports to, or null for no restriction* *

Returns:

the list of export groups associated with the host.

findContainingHost

public java.util.List<ExportGroupRestRep> findContainingHost(java.net.URI hostId,
                                                             java.net.URI projectId,
                                                             java.net.URI varrayId)

Finds any exports (HOST, CLUSTER or EXCLUSIVE) that contain the host.

Parameters:

hostId - the ID of the host.

projectId - the ID of the project to restrict exports to, or null for no restriction

varrayId - the ID of the varray to restrict exports to, or null for no restriction *

Returns:

the list of export groups associated with the host.

findContainingHost

public java.util.List<ExportGroupRestRep> findContainingHost(java.net.URI hostId)

Finds any exports (HOST, CLUSTER or EXCLUSIVE) that contain the host.

Parameters:

hostId - the ID of the host.

Returns:

the list of export groups associated with the host.

findContainingCluster

public java.util.List<ExportGroupRestRep> findContainingCluster(java.net.URI clusterId)

Finds the exports associated with a cluster.

Parameters:

clusterId - the ID of the cluster.

Returns:

the list of export groups associated with the cluster.

findByHostOrCluster

@Deprecated
public java.util.List<ExportGroupRestRep> findByHostOrCluster(java.net.URI hostId,
                                                                           java.net.URI projectId,
                                                                           java.net.URI virtualArrayId)

Deprecated. This method was only used in one test class ViPRClientApp which doesn't use this method anymore.

Finds the exports associated with a host (or that host's cluster) that are for the given project. If a virtual array ID is specified, only exports associated with that virtual array are returned.

Parameters:

hostId - the ID of the host.

projectId - the ID of the project.

virtualArrayId - the ID of the virtual array to restrict the exports to, or null for no restriction.

Returns:

the list of export groups associated with the host or any host in the same cluster.

findByHostOrCluster

@Deprecated
public java.util.List<ExportGroupRestRep> findByHostOrCluster(java.net.URI hostId,
                                                                           java.net.URI projectId)

Deprecated. This was a convenience method to a deprecated method.

Finds the exports associated with a host (or that host's cluster) that are for the given project.

Parameters:

hostId - the ID of the host.

projectId - the ID of the project.

Returns:

the list of export groups associated with the host or any host in the same cluster.

getExportsForInitiators

public java.util.List<ITLRestRep> getExportsForInitiators(java.util.Collection<InitiatorRestRep> initiators)

Gets the exports (initiator-target-lun) for the given initiators. This is a convenience method that collects the provided initiators' ports and calls getExportsForInitiatorPorts(Collection).

Parameters:

initiators - the initiators.

Returns:

the list of exports.

getExportsForInitiatorPorts

public java.util.List<ITLRestRep> getExportsForInitiatorPorts(java.util.Collection<java.lang.String> initiatorPorts)

Gets the exports (initiator-target-lun) for the given initiator ports.

API Call: GET /block/exports?initiators={initiatorPort1},{initiatorPort2},...

Parameters:

initiatorPorts - the initiator ports.

Returns:

the list of exports.

search

public ExportGroupSearchBuilder search()

Creates a search builder specifically for creating export group search queries.

Specified by:

search in interface Resources<ExportGroupRestRep>

Overrides:

search in class ProjectResources<ExportGroupRestRep>

Returns:

a export group search builder.