public class VirtualArrays extends AbstractCoreBulkResources<VirtualArrayRestRep> implements TopLevelResources<VirtualArrayRestRep>, ACLResources
Base URL: /vdc/varrays
Constructor and Description |
---|
VirtualArrays(ViPRCoreClient parent,
RestClient client) |
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.
|
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 VirtualArrays(ViPRCoreClient parent, RestClient client)
public VirtualArrays withInactive(boolean inactive)
AbstractResources
withInactive
in class AbstractResources<VirtualArrayRestRep>
inactive
- whether to include inactive resources.public VirtualArrays withInternal(boolean internal)
AbstractResources
withInternal
in class AbstractResources<VirtualArrayRestRep>
internal
- whether to include internal resources.public java.util.List<NamedRelatedResourceRep> list()
API Call: GET /vdc/varrays
list
in interface TopLevelResources<VirtualArrayRestRep>
public java.util.List<NamedRelatedResourceRep> listByVDC(java.lang.String shortVdcId)
API Call: GET /vdc/varrays
public java.util.List<NamedRelatedResourceRep> listByTenant(java.net.URI tenantId)
API Call: GET /vdc/varrays
public java.util.List<VirtualArrayRestRep> getByTenant(java.net.URI tenantId)
public java.util.List<VirtualArrayRestRep> getByTenant(java.net.URI tenantId, ResourceFilter<VirtualArrayRestRep> filter)
public java.util.List<VirtualArrayRestRep> getAll()
getAll
in interface TopLevelResources<VirtualArrayRestRep>
TopLevelResources.list()
,
Resources.getByRefs(java.util.Collection)
public java.util.List<VirtualArrayRestRep> getAll(ResourceFilter<VirtualArrayRestRep> filter)
getAll
in interface TopLevelResources<VirtualArrayRestRep>
filter
- the resource filter to apply to the results as they are returned (optional).TopLevelResources.list()
,
Resources.getByRefs(java.util.Collection, ResourceFilter)
public VirtualArrayRestRep create(VirtualArrayCreateParam input)
API Call: POST /vdc/varrays
input
- the create configuration.public VirtualArrayRestRep update(java.net.URI id, VirtualArrayUpdateParam input)
API Call: PUT /vdc/varrays/{id}
id
- the ID of the virtual array to update.input
- the update configuration.public void deactivate(java.net.URI id)
API Call: POST /vdc/varrays/{id}/deactivate
id
- the ID of the virtual array to deactivate.public void deactivate(VirtualArrayRestRep virtualArray)
public java.util.List<VirtualPoolAvailableAttributesResourceRep> getAvailableAttributes(java.net.URI id)
API Call: GET /vdc/varrays/{id}/available-attributes
id
- the ID of the virtual array.public java.util.Map<java.net.URI,java.util.List<VirtualPoolAvailableAttributesResourceRep>> getAvailableAttributes(java.util.Collection<java.net.URI> virtualArrayIds)
API Call: GET /vdc/varrays/available-attributes
virtualArrayIds
- the IDs of the virtual arrays.public java.util.List<VirtualArrayConnectivityRestRep> getConnectivity(java.net.URI id)
API Call: GET /vdc/varrays/{id}/connectivity
id
- the ID of the virtual array.public java.util.List<ACLEntry> getACLs(java.net.URI id)
ACLResources
API Call: GET baseUrl/{id}/acl
getACLs
in interface ACLResources
id
- the resource ID.public java.util.List<ACLEntry> updateACLs(java.net.URI id, ACLAssignmentChanges aclChanges)
ACLResources
API Call: PUT baseUrl/{id}/acl
updateACLs
in interface ACLResources
id
- the resource ID.aclChanges
- the ACL changes to perform (ACL entries to add/remove).public VirtualArraySearchBuilder search()
search
in interface Resources<VirtualArrayRestRep>
search
in class AbstractResources<VirtualArrayRestRep>
public java.util.List<VirtualArrayRestRep> findByInitiatorPort(java.lang.String initiatorPort)
initiatorPort
- the initiator port.public java.util.List<VirtualArrayRestRep> findByInitiatorPort(java.lang.String initiatorPort, ResourceFilter<VirtualArrayRestRep> filter)
initiatorPort
- the initiator port.filter
- the resource filter to apply to the results as they are returned (optional).public java.util.List<VirtualArrayRestRep> findByInitiators(java.util.Collection<InitiatorRestRep> initiators)
initiators
- the initiators.public java.util.List<VirtualArrayRestRep> findByInitiators(java.util.Collection<InitiatorRestRep> initiators, ResourceFilter<VirtualArrayRestRep> filter)
initiators
- the initiators.filter
- the resource filter to apply to the results as they are returned (optional).public java.util.List<VirtualArrayRestRep> findByConnectedHost(HostRestRep host)
host
- the host.public java.util.List<VirtualArrayRestRep> findByConnectedHost(HostRestRep host, ResourceFilter<VirtualArrayRestRep> filter)
host
- the host.filter
- the resource filter to apply to the results as they are returned (optional).public java.util.List<VirtualArrayRestRep> findByConnectedHost(java.net.URI hostId)
hostId
- the ID of the host.public java.util.List<VirtualArrayRestRep> findByConnectedHost(java.net.URI hostId, ResourceFilter<VirtualArrayRestRep> filter)
hostId
- the ID of the host.filter
- the resource filter to apply to the results as they are returned (optional).public java.util.List<VirtualArrayRestRep> findByConnectedCluster(java.net.URI clusterId)
clusterId
- the ID of the cluster.public java.util.List<VirtualArrayRestRep> findByConnectedCluster(java.net.URI clusterId, ResourceFilter<VirtualArrayRestRep> filter)
clusterId
- the ID of the cluster.filter
- the resource filter to apply to the results as they are returned (optional).public java.util.List<VirtualArrayVirtualPoolCapacity> getCapacities()
API Call: GET /vdc/capacities
public java.util.List<ComputeSystemRestRep> getComputeSystems(java.net.URI id)
id
- the ID of the virtual array