com.emc.vipr.client.core

Interface BulkResources<T extends DataObjectRestRep>

All Superinterfaces:

Resources<T>

All Known Implementing Classes:

AbstractBulkResources, AbstractCatalogBulkResources, AbstractCoreBulkResources, Approvals2, AutoTieringPolicies, BlockConsistencyGroups, BlockExports, BlockFullCopies, BlockMigrations, BlockSnapshots, BlockSnapshotSessions, BlockVirtualPools, BlockVolumes, BulkExportResources, CatalogCategories, CatalogImages, CatalogServices, Clusters, ComputeElements, ComputeImages, ComputeImageServers, ComputeSystems, ComputeVirtualPools, CustomConfigs, Events, ExecutionWindows2, FileSnapshots, FileSystems, FileVirtualPools, Hosts, Initiators, IpInterfaces, Networks, NetworkSystems, ObjectBuckets, ObjectNamespaces, ObjectVirtualPools, Orders2, ProjectResources, Projects, ProtectionSystems, QuotaDirectories, SchedulePolicies, StoragePools, StoragePorts, StorageProviders, StorageSystems, StorageTiers, TasksResources, Tenants, UnManagedCGs, UnManagedExportMasks, UnManagedFileSystems, UnManagedVolumes, VcenterDataCenters, Vcenters, VirtualArrays, VirtualNasServers

public interface BulkResources<T extends DataObjectRestRep>
extends Resources<T>

Method Summary

Modifier and Type	Method and Description
java.util.List<T>	getByIds(java.util.Collection<java.net.URI> ids) Fetches the resource values for the given IDs (using the bulk API).
java.util.List<T>	getByIds(java.util.Collection<java.net.URI> ids, ResourceFilter<T> filter) Fetches the resource values for the given IDs (using the bulk API), optionally filtering the results as they are returned.
java.util.List<T>	getByRefs(java.util.Collection<? extends RelatedResourceRep> resources) Fetches the resource values for the given references.
java.util.List<T>	getByRefs(java.util.Collection<? extends RelatedResourceRep> resources, ResourceFilter<T> filter) Fetches the resource values for the given references, optionally filtering the results as they are returned.
java.util.List<java.net.URI>	listBulkIds() Lists all IDs for this resource type through the Bulk API.

Methods inherited from interface com.emc.vipr.client.core.Resources

addTags, get, get, getTags, removeTags, search, updateTags

Method Detail

listBulkIds

java.util.List<java.net.URI> listBulkIds()

Lists all IDs for this resource type through the Bulk API. May require specific roles.

API Call: GET /RESOURCE_PATH/bulk

Returns:

the list of all IDs for this type of resource.

getByRefs

java.util.List<T> getByRefs(java.util.Collection<? extends RelatedResourceRep> resources)

Fetches the resource values for the given references.

Convenience method for calling getByIds(*resources.id).

Specified by:

getByRefs in interface Resources<T extends DataObjectRestRep>

Parameters:

resources - the resource references.

Returns:

the resource values.

getByRefs

java.util.List<T> getByRefs(java.util.Collection<? extends RelatedResourceRep> resources,
                            ResourceFilter<T> filter)

Fetches the resource values for the given references, optionally filtering the results as they are returned.

Convenience method for calling getByIds(*resources.id, filter).

Specified by:

getByRefs in interface Resources<T extends DataObjectRestRep>

Parameters:

resources - the resource references.

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

Returns:

the resource values.

getByIds

java.util.List<T> getByIds(java.util.Collection<java.net.URI> ids)

Fetches the resource values for the given IDs (using the bulk API).

API Call: POST /RESOURCE_PATH/bulk

Specified by:

getByIds in interface Resources<T extends DataObjectRestRep>

Parameters:

ids - the resource IDs.

Returns:

the resource values.

getByIds

java.util.List<T> getByIds(java.util.Collection<java.net.URI> ids,
                           ResourceFilter<T> filter)

Fetches the resource values for the given IDs (using the bulk API), optionally filtering the results as they are returned.

API Call: POST /RESOURCE_PATH/bulk

Specified by:

getByIds in interface Resources<T extends DataObjectRestRep>

Parameters:

ids - the resource IDs.

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

Returns:

the resource values.