com.emc.vipr.client.core

Interface Resources<T extends DataObjectRestRep>

All Known Subinterfaces:

BulkResources<T>

All Known Implementing Classes:

AbstractBulkResources, AbstractCatalogBulkResources, AbstractCatalogResources, AbstractCoreBulkResources, AbstractCoreResources, AbstractResources, ApplicationSupport, Approvals2, AuthnProviders, 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, OpenStackTenants, Orders2, ProjectResources, Projects, ProtectionSystems, QuotaDirectories, SchedulePolicies, StoragePools, StoragePorts, StorageProviders, StorageSystems, StorageTiers, TasksResources, Tenants, UnManagedCGs, UnManagedExportMasks, UnManagedFileSystems, UnManagedVolumes, UserGroup, VcenterDataCenters, Vcenters, VirtualArrays, VirtualDataCenters, VirtualNasServers, Workflows

public interface Resources<T extends DataObjectRestRep>

Method Summary

Modifier and Type	Method and Description
void	addTags(java.net.URI id, java.util.Set<java.lang.String> add) Adds a set of tags to the tags for a given resource.
T	get(RelatedResourceRep ref) Gets a resource by a reference.
T	get(java.net.URI id) Gets a resource by ID.
java.util.List<T>	getByIds(java.util.Collection<java.net.URI> ids) Fetches the resource values for the given IDs.
java.util.List<T>	getByIds(java.util.Collection<java.net.URI> ids, ResourceFilter<T> filter) Fetches the resource values for the given IDs, optionally filtering the results as they are returned.
java.util.List<T>	getByRefs(java.util.Collection<? extends RelatedResourceRep> refs) Fetches the resource values for the given references.
java.util.List<T>	getByRefs(java.util.Collection<? extends RelatedResourceRep> refs, ResourceFilter<T> filter) Fetches the resource values for the given references, optionally filtering the results as they are returned.
java.util.Set<java.lang.String>	getTags(java.net.URI id) Gets the set of all tags assigned to the given resource.
void	removeTags(java.net.URI id, java.util.Set<java.lang.String> remove) Removes a set of tags to the tags for a given resource.
SearchBuilder<T>	search() Creates a builder for building up search queries.
void	updateTags(java.net.URI id, TagAssignment tags) Updates the tags for a given resource.

Method Detail

get

T get(java.net.URI id)

Gets a resource by ID.

API Call: GET /RESOURCE_PATH/{id}

Parameters:

id - the resource ID.

Returns:

the resource.

get

T get(RelatedResourceRep ref)

Gets a resource by a reference.

Convenience method for calling get(ref.getId()).

Parameters:

ref - the resource reference.

Returns:

the resource.

getByRefs

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

Fetches the resource values for the given references.

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

Parameters:

refs - the resource references.

Returns:

the resource values.

getByRefs

java.util.List<T> getByRefs(java.util.Collection<? extends RelatedResourceRep> refs,
                            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).

Parameters:

refs - 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.

API Call: GET /RESOURCE_PATH/{id}

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, optionally filtering the results as they are returned.

API Call: GET /RESOURCE_PATH/{id}

Parameters:

ids - the resource IDs.

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

Returns:

the resource values.

getTags

java.util.Set<java.lang.String> getTags(java.net.URI id)

Gets the set of all tags assigned to the given resource.

Parameters:

id - the ID of the resource.

Returns:

the set of tags assigned to the given resource.

updateTags

void updateTags(java.net.URI id,
                TagAssignment tags)

Updates the tags for a given resource.

Parameters:

id - the ID of the resource.

tags - the tags to add/remove.

addTags

void addTags(java.net.URI id,
             java.util.Set<java.lang.String> add)

Adds a set of tags to the tags for a given resource.

Parameters:

id - the ID of the resource.

add - the tags to add.

removeTags

void removeTags(java.net.URI id,
                java.util.Set<java.lang.String> remove)

Removes a set of tags to the tags for a given resource.

Parameters:

id - the ID of the resource.

remove - the tags to remove.

search

SearchBuilder<T> search()

Creates a builder for building up search queries.

Returns:

Returns a search builder.