com.emc.vipr.client.catalog

Class CatalogImages

java.lang.Object

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

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

com.emc.vipr.client.catalog.AbstractCatalogBulkResources<CatalogImageRestRep>

com.emc.vipr.client.catalog.CatalogImages

All Implemented Interfaces:

BulkResources<CatalogImageRestRep>, Resources<CatalogImageRestRep>, TenantResources<CatalogImageRestRep>

public class CatalogImages
extends AbstractCatalogBulkResources<CatalogImageRestRep>
implements TenantResources<CatalogImageRestRep>

Constructor Summary

Constructors

Constructor and Description
CatalogImages(ViPRCatalogClient2 parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
CatalogImageRestRep	create(CatalogImageCreateParam input) Creates a catalog image
void	deactivate(java.net.URI id) Deactivates the given catalog image by ID.
java.util.List<CatalogImageRestRep>	getByTenant(java.net.URI tenantId) Gets the resources associated with a given tenant.
java.util.List<CatalogImageRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<CatalogImageRestRep> filter) Gets the resources associated with a given tenant, optionally filtering the results as they are returned.
java.util.List<CatalogImageRestRep>	getByUserTenant() Convenience method for retrieving by user's current tenant.
java.util.List<CatalogImageRestRep>	getByUserTenant(ResourceFilter<CatalogImageRestRep> filter) Convenience method for retrieving by user's current tenant.
java.util.List<NamedRelatedResourceRep>	listByTenant(java.net.URI tenantId) Lists resources associated with a given tenant.
java.util.List<NamedRelatedResourceRep>	listByUserTenant() Convenience method for listing by the user's current tenant.
CatalogImageRestRep	update(java.net.URI id, CatalogImageUpdateParam input) Updates the given catalog image by ID.

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, search, updateTags, withInactive, withInternal

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, search, updateTags

Constructor Detail

CatalogImages

public CatalogImages(ViPRCatalogClient2 parent,
                     RestClient client)

Method Detail

listByUserTenant

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

Description copied from interface: TenantResources

Convenience method for listing by the user's current tenant.

Equivalent to: listByTenant(client.getUserTenant())

Specified by:

listByUserTenant in interface TenantResources<CatalogImageRestRep>

See Also:

TenantResources.listByTenant(URI)

getByUserTenant

public java.util.List<CatalogImageRestRep> getByUserTenant()

Description copied from interface: TenantResources

Convenience method for retrieving by user's current tenant.

Equivalent to: getByTenant(client.getUserTenant())

Specified by:

getByUserTenant in interface TenantResources<CatalogImageRestRep>

See Also:

TenantResources.getByTenant(URI)

getByUserTenant

public java.util.List<CatalogImageRestRep> getByUserTenant(ResourceFilter<CatalogImageRestRep> filter)

Description copied from interface: TenantResources

Convenience method for retrieving by user's current tenant.

Equivalent to: getByTenant(client.getUserTenant(), filter)

Specified by:

getByUserTenant in interface TenantResources<CatalogImageRestRep>

See Also:

TenantResources.getByTenant(URI, ResourceFilter)

listByTenant

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

Description copied from interface: TenantResources

Lists resources associated with a given tenant.

Specified by:

listByTenant in interface TenantResources<CatalogImageRestRep>

Parameters:

tenantId - the tenant ID.

Returns:

the list of resource references.

getByTenant

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

Description copied from interface: TenantResources

Gets the resources associated with a given tenant.

Specified by:

getByTenant in interface TenantResources<CatalogImageRestRep>

Parameters:

tenantId - the tenant ID.

Returns:

the list of resources for this tenant.

See Also:

Resources.getByRefs(java.util.Collection)

getByTenant

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

Description copied from interface: TenantResources

Gets the resources associated with a given tenant, optionally filtering the results as they are returned.

Specified by:

getByTenant in interface TenantResources<CatalogImageRestRep>

Parameters:

tenantId - the tenant ID.

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

Returns:

the list of resources for the tenant.

See Also:

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

create

public CatalogImageRestRep create(CatalogImageCreateParam input)

Creates a catalog image

API Call: POST /catalog/images

Parameters:

input - the catalog image configuration.

Returns:

the newly created catalog image.

update

public CatalogImageRestRep update(java.net.URI id,
                                  CatalogImageUpdateParam input)

Updates the given catalog image by ID.

API Call: PUT /catalog/images/{id}

Parameters:

id - the ID of the catalog image to update.

input - the update configuration.

Returns:

the updated catalog image.

deactivate

public void deactivate(java.net.URI id)

Deactivates the given catalog image by ID.

API Call: POST /catalog/images/{id}/deactivate

Parameters:

id - the ID of catalog image to deactivate.