com.emc.vipr.client.core

Class VirtualArrays

java.lang.Object

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

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

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

com.emc.vipr.client.core.VirtualArrays

All Implemented Interfaces:

ACLResources, BulkResources<VirtualArrayRestRep>, Resources<VirtualArrayRestRep>, TopLevelResources<VirtualArrayRestRep>

public class VirtualArrays
extends AbstractCoreBulkResources<VirtualArrayRestRep>
implements TopLevelResources<VirtualArrayRestRep>, ACLResources

Virtual Arrays resources.

Base URL: /vdc/varrays

Constructor Summary

Constructors

Constructor and Description
VirtualArrays(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
VirtualArrayRestRep	create(VirtualArrayCreateParam input) Creates a virtual array.
void	deactivate(java.net.URI id) Deactivates the given virtual array by ID.
void	deactivate(VirtualArrayRestRep virtualArray)
java.util.List<VirtualArrayRestRep>	findByConnectedCluster(java.net.URI clusterId) Finds the list of virtual arrays connected to the given cluster by ID.
java.util.List<VirtualArrayRestRep>	findByConnectedCluster(java.net.URI clusterId, ResourceFilter<VirtualArrayRestRep> filter) Finds the list of virtual arrays connected to the given cluster by ID, optionally filtering the results.
java.util.List<VirtualArrayRestRep>	findByConnectedHost(HostRestRep host) Finds the list of virtual arrays connected to the given host.
java.util.List<VirtualArrayRestRep>	findByConnectedHost(HostRestRep host, ResourceFilter<VirtualArrayRestRep> filter) Finds the list of virtual arrays connected to the given host, optionally filtering the results.
java.util.List<VirtualArrayRestRep>	findByConnectedHost(java.net.URI hostId) Finds the list of virtual arrays connected to the given host by ID.
java.util.List<VirtualArrayRestRep>	findByConnectedHost(java.net.URI hostId, ResourceFilter<VirtualArrayRestRep> filter) Finds the list of virtual arrays connected to the given host by ID, optionally filtering the results.
java.util.List<VirtualArrayRestRep>	findByInitiatorPort(java.lang.String initiatorPort) Finds the list of virtual arrays connected to the given initiator port.
java.util.List<VirtualArrayRestRep>	findByInitiatorPort(java.lang.String initiatorPort, ResourceFilter<VirtualArrayRestRep> filter) Finds the list of virtual arrays connected to the given initiator port, optionally filtering the results.
java.util.List<VirtualArrayRestRep>	findByInitiators(java.util.Collection<InitiatorRestRep> initiators) Finds the list of virtual arrays connected to any of the given initiators.
java.util.List<VirtualArrayRestRep>	findByInitiators(java.util.Collection<InitiatorRestRep> initiators, ResourceFilter<VirtualArrayRestRep> filter) Finds the list of virtual arrays connected to any of the given initiators, optionally filtering the results.
java.util.List<ACLEntry>	getACLs(java.net.URI id) Gets the ACL entries for a given resource by ID.
java.util.List<VirtualArrayRestRep>	getAll() Gets the list of all virtual arrays.
java.util.List<VirtualArrayRestRep>	getAll(ResourceFilter<VirtualArrayRestRep> filter) Gets the list of all virtual arrays, optionally filtering the results.
java.util.Map<java.net.URI,java.util.List<VirtualPoolAvailableAttributesResourceRep>>	getAvailableAttributes(java.util.Collection<java.net.URI> virtualArrayIds) Gets the available attributes for the given virtual arrays.
java.util.List<VirtualPoolAvailableAttributesResourceRep>	getAvailableAttributes(java.net.URI id) Gets the available attributes for the given virtual array.
java.util.List<VirtualArrayRestRep>	getByTenant(java.net.URI tenantId)
java.util.List<VirtualArrayRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<VirtualArrayRestRep> filter)
java.util.List<VirtualArrayVirtualPoolCapacity>	getCapacities() Gets the list of virtual pool capacities on all virtual arrays.
java.util.List<ComputeSystemRestRep>	getComputeSystems(java.net.URI id) Gets the list of Compute Systems that are visible in this vArray
java.util.List<VirtualArrayConnectivityRestRep>	getConnectivity(java.net.URI id) Gets the connectivity information for the given virtual array by ID.
java.util.List<NamedRelatedResourceRep>	list() Lists all virtual arrays.
java.util.List<NamedRelatedResourceRep>	listByTenant(java.net.URI tenantId) Lists all virtual arrays of a specific tenant
java.util.List<NamedRelatedResourceRep>	listByVDC(java.lang.String shortVdcId) Lists all virtual arrays in a virtual data center
VirtualArraySearchBuilder	search() Creates a search builder specific for building virtual array searches.
VirtualArrayRestRep	update(java.net.URI id, VirtualArrayUpdateParam input) Updated the given virtual array by ID.
java.util.List<ACLEntry>	updateACLs(java.net.URI id, ACLAssignmentChanges aclChanges) Updates the ACL entries for a given resource by ID.
VirtualArrays	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
VirtualArrays	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, 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

VirtualArrays

public VirtualArrays(ViPRCoreClient parent,
                     RestClient client)

Method Detail

withInactive

public VirtualArrays withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<VirtualArrayRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public VirtualArrays withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<VirtualArrayRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

list

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

Lists all virtual arrays.

API Call: GET /vdc/varrays

Specified by:

list in interface TopLevelResources<VirtualArrayRestRep>

Returns:

the list of virtual array references.

listByVDC

public java.util.List<NamedRelatedResourceRep> listByVDC(java.lang.String shortVdcId)

Lists all virtual arrays in a virtual data center

API Call: GET /vdc/varrays

Returns:

the list of virtual array references in a virtual data centers

listByTenant

public java.util.List<NamedRelatedResourceRep> listByTenant(java.net.URI tenantId)

Lists all virtual arrays of a specific tenant

API Call: GET /vdc/varrays

Returns:

the list of virtual array references of specific tenant

getByTenant

public java.util.List<VirtualArrayRestRep> getByTenant(java.net.URI tenantId)

getByTenant

public java.util.List<VirtualArrayRestRep> getByTenant(java.net.URI tenantId,
                                                       ResourceFilter<VirtualArrayRestRep> filter)

getAll

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

Gets the list of all virtual arrays. This is a convenience method for: getByRefs(list()).

Specified by:

getAll in interface TopLevelResources<VirtualArrayRestRep>

Returns:

the list of virtual arrays.

See Also:

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

getAll

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

Gets the list of all virtual arrays, optionally filtering the results. This is a convenience method for: getByRefs(list(), filter).

Specified by:

getAll in interface TopLevelResources<VirtualArrayRestRep>

Parameters:

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

Returns:

the list of virtual arrays.

See Also:

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

create

public VirtualArrayRestRep create(VirtualArrayCreateParam input)

Creates a virtual array.

API Call: POST /vdc/varrays

Parameters:

input - the create configuration.

Returns:

the newly create virtual array.

update

public VirtualArrayRestRep update(java.net.URI id,
                                  VirtualArrayUpdateParam input)

Updated the given virtual array by ID.

API Call: PUT /vdc/varrays/{id}

Parameters:

id - the ID of the virtual array to update.

input - the update configuration.

Returns:

the updated virtual array.

deactivate

public void deactivate(java.net.URI id)

Deactivates the given virtual array by ID.

API Call: POST /vdc/varrays/{id}/deactivate

Parameters:

id - the ID of the virtual array to deactivate.

deactivate

public void deactivate(VirtualArrayRestRep virtualArray)

getAvailableAttributes

public java.util.List<VirtualPoolAvailableAttributesResourceRep> getAvailableAttributes(java.net.URI id)

Gets the available attributes for the given virtual array.

API Call: GET /vdc/varrays/{id}/available-attributes

Parameters:

id - the ID of the virtual array.

Returns:

the list of available attributes.

getAvailableAttributes

public java.util.Map<java.net.URI,java.util.List<VirtualPoolAvailableAttributesResourceRep>> getAvailableAttributes(java.util.Collection<java.net.URI> virtualArrayIds)

Gets the available attributes for the given virtual arrays.

API Call: GET /vdc/varrays/available-attributes

Parameters:

virtualArrayIds - the IDs of the virtual arrays.

Returns:

the list of available attributes.

getConnectivity

public java.util.List<VirtualArrayConnectivityRestRep> getConnectivity(java.net.URI id)

Gets the connectivity information for the given virtual array by ID.

API Call: GET /vdc/varrays/{id}/connectivity

Parameters:

id - the ID of the virtual array.

Returns:

the list of connectivity information.

getACLs

public java.util.List<ACLEntry> getACLs(java.net.URI id)

Description copied from interface: ACLResources

Gets the ACL entries for a given resource by ID.

API Call: GET baseUrl/{id}/acl

Specified by:

getACLs in interface ACLResources

Parameters:

id - the resource ID.

Returns:

the list of ACL entries.

updateACLs

public java.util.List<ACLEntry> updateACLs(java.net.URI id,
                                           ACLAssignmentChanges aclChanges)

Description copied from interface: ACLResources

Updates the ACL entries for a given resource by ID.

API Call: PUT baseUrl/{id}/acl

Specified by:

updateACLs in interface ACLResources

Parameters:

id - the resource ID.

aclChanges - the ACL changes to perform (ACL entries to add/remove).

Returns:

the resulting list of ACL entries after performing the update.

search

public VirtualArraySearchBuilder search()

Creates a search builder specific for building virtual array searches.

Specified by:

search in interface Resources<VirtualArrayRestRep>

Overrides:

search in class AbstractResources<VirtualArrayRestRep>

Returns:

the virtual array seach builder.

findByInitiatorPort

public java.util.List<VirtualArrayRestRep> findByInitiatorPort(java.lang.String initiatorPort)

Finds the list of virtual arrays connected to the given initiator port. This is a convenience method for: search().byInitiatorPort(initiatorPort).run()

Parameters:

initiatorPort - the initiator port.

Returns:

the list of connected virtual arrays.

findByInitiatorPort

public java.util.List<VirtualArrayRestRep> findByInitiatorPort(java.lang.String initiatorPort,
                                                               ResourceFilter<VirtualArrayRestRep> filter)

Finds the list of virtual arrays connected to the given initiator port, optionally filtering the results. This is a convenience method for search().byInitiatorPort(initiatorPort).filter(filter).run()

Parameters:

initiatorPort - the initiator port.

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

Returns:

the list of connected virtual arrays.

findByInitiators

public java.util.List<VirtualArrayRestRep> findByInitiators(java.util.Collection<InitiatorRestRep> initiators)

Finds the list of virtual arrays connected to any of the given initiators.

Parameters:

initiators - the initiators.

Returns:

the list of connected virtual arrays.

findByInitiators

public java.util.List<VirtualArrayRestRep> findByInitiators(java.util.Collection<InitiatorRestRep> initiators,
                                                            ResourceFilter<VirtualArrayRestRep> filter)

Finds the list of virtual arrays connected to any of the given initiators, optionally filtering the results.

Parameters:

initiators - the initiators.

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

Returns:

the list of connected virtual arrays.

findByConnectedHost

public java.util.List<VirtualArrayRestRep> findByConnectedHost(HostRestRep host)

Finds the list of virtual arrays connected to the given host.

Parameters:

host - the host.

Returns:

the list of connected virtual arrays.

findByConnectedHost

public java.util.List<VirtualArrayRestRep> findByConnectedHost(HostRestRep host,
                                                               ResourceFilter<VirtualArrayRestRep> filter)

Finds the list of virtual arrays connected to the given host, optionally filtering the results.

Parameters:

host - the host.

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

Returns:

the list of connected virtual arrays.

findByConnectedHost

public java.util.List<VirtualArrayRestRep> findByConnectedHost(java.net.URI hostId)

Finds the list of virtual arrays connected to the given host by ID. This is a convenience method for: search().byHost(hostId).run()

Parameters:

hostId - the ID of the host.

Returns:

the list of connected virtual arrays.

findByConnectedHost

public java.util.List<VirtualArrayRestRep> findByConnectedHost(java.net.URI hostId,
                                                               ResourceFilter<VirtualArrayRestRep> filter)

Finds the list of virtual arrays connected to the given host by ID, optionally filtering the results. This is a convenience method for search().byHost(hostId).filter(filter).run()

Parameters:

hostId - the ID of the host.

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

Returns:

the list of connected virtual arrays.

findByConnectedCluster

public java.util.List<VirtualArrayRestRep> findByConnectedCluster(java.net.URI clusterId)

Finds the list of virtual arrays connected to the given cluster by ID. This is a convenience method for: search().byCluster(clusterId).run()

Parameters:

clusterId - the ID of the cluster.

Returns:

the list of connected virtual arrays.

findByConnectedCluster

public java.util.List<VirtualArrayRestRep> findByConnectedCluster(java.net.URI clusterId,
                                                                  ResourceFilter<VirtualArrayRestRep> filter)

Finds the list of virtual arrays connected to the given cluster by ID, optionally filtering the results. This is a convenience method for search().byCluster(clusterId).filter(filter).run()

Parameters:

clusterId - the ID of the cluster.

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

Returns:

the list of connected virtual arrays.

getCapacities

public java.util.List<VirtualArrayVirtualPoolCapacity> getCapacities()

Gets the list of virtual pool capacities on all virtual arrays.

API Call: GET /vdc/capacities

Returns:

the list of virtual pool capacities.

getComputeSystems

public java.util.List<ComputeSystemRestRep> getComputeSystems(java.net.URI id)

Gets the list of Compute Systems that are visible in this vArray

Parameters:

id - the ID of the virtual array

Returns:

List of Compute Systems that belong to the vArray