com.emc.vipr.client.core

Class AutoTieringPolicies

java.lang.Object

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

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

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

com.emc.vipr.client.core.AutoTieringPolicies

All Implemented Interfaces:

BulkResources<AutoTieringPolicyRestRep>, Resources<AutoTieringPolicyRestRep>, TopLevelResources<AutoTieringPolicyRestRep>

public class AutoTieringPolicies
extends AbstractCoreBulkResources<AutoTieringPolicyRestRep>
implements TopLevelResources<AutoTieringPolicyRestRep>

Auto tier policy resources.

Base URL: /vdc/auto-tier-policies

See Also:

AutoTieringPolicyRestRep

Constructor Summary

Constructors

Constructor and Description
AutoTieringPolicies(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
java.util.List<AutoTieringPolicyRestRep>	getAll() Gets all resources for this resource type.
java.util.List<AutoTieringPolicyRestRep>	getAll(ResourceFilter<AutoTieringPolicyRestRep> filter) Gets all resources for this resource type.
java.util.List<AutoTieringPolicyRestRep>	getByStorageSystem(java.net.URI storageSystemId) Gets all auto tier policies for a given storage system.
java.util.List<AutoTieringPolicyRestRep>	getByVirtualArray(java.net.URI virtualArrayId) Gets all auto tier policies for a given virtual array.
java.util.List<AutoTieringPolicyRestRep>	getByVirtualArray(java.net.URI virtualArrayId, java.lang.String provisioningType, java.lang.Boolean uniqueNames) Gets all auto tier policies for a given virtual array.
java.util.List<AutoTieringPolicyRestRep>	getByVirtualArray(java.net.URI virtualArrayId, java.lang.String provisioningType, java.lang.Boolean uniqueNames, ResourceFilter<AutoTieringPolicyRestRep> filter) Gets all auto tier policies for a given virtual array.
java.util.List<AutoTieringPolicyRestRep>	getByVirtualArrays(java.util.Collection<java.net.URI> virtualArrayIds, java.lang.String provisioningType, java.lang.Boolean uniqueNames, ResourceFilter<AutoTieringPolicyRestRep> filter) Gets all auto tier policies for all virtual arrays.
java.util.List<NamedRelatedResourceRep>	list() Lists all auto tier policies.
java.util.List<NamedRelatedResourceRep>	list(java.lang.String provisioningType, java.lang.Boolean uniqueNames) Lists the auto tier policies, with the ability to limit by provisioning type or unique policy name.
java.util.List<NamedRelatedResourceRep>	listByStorageSystem(java.net.URI storageSystemId) Lists all auto tier policies for a given storage system.
java.util.List<NamedRelatedResourceRep>	listByStorageSystem(java.net.URI storageSystemId, java.lang.Boolean uniqueNames) Lists all auto tier policies for a given storage system.
java.util.List<NamedRelatedResourceRep>	listByVirtualArray(java.net.URI virtualArrayId) Lists all auto tier policies for a given virtual array.
java.util.List<NamedRelatedResourceRep>	listByVirtualArray(java.net.URI virtualArrayId, java.lang.String provisioningType, java.lang.Boolean uniqueNames) Lists all auto tier policies for a given virtual array.
AutoTieringPolicies	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
AutoTieringPolicies	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, search, 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, search, updateTags

Constructor Detail

AutoTieringPolicies

public AutoTieringPolicies(ViPRCoreClient parent,
                           RestClient client)

Method Detail

withInactive

public AutoTieringPolicies withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<AutoTieringPolicyRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public AutoTieringPolicies withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<AutoTieringPolicyRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

list

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

Lists all auto tier policies.

API Call: GET /vdc/auto-tier-policies

Specified by:

list in interface TopLevelResources<AutoTieringPolicyRestRep>

Returns:

the list of auto tier policy references.

list

public java.util.List<NamedRelatedResourceRep> list(java.lang.String provisioningType,
                                                    java.lang.Boolean uniqueNames)

Lists the auto tier policies, with the ability to limit by provisioning type or unique policy name.

API Call: GET /vdc/auto-tier-policies?provisioning_type={provisioningType} unique_auto_tier_policy_names={uniqueNames}

Parameters:

provisioningType - the provisioning type, if null matches any provisioning type.

uniqueNames - when true duplicate named policies will be ignored.

Returns:

the list of auto tier policy references.

getAll

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

Description copied from interface: TopLevelResources

Gets all resources for this resource type. This is combination of the list() call combined with a bulk query to retrieve the resources.

API Call: GET /RESOURCE_PATH

Specified by:

getAll in interface TopLevelResources<AutoTieringPolicyRestRep>

Returns:

All resources of this type available to the user.

See Also:

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

getAll

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

Description copied from interface: TopLevelResources

Gets all resources for this resource type. This is combination of the list() call combined with a bulk query to retrieve the resources. This optionally filters the results by the filter specified.

API Call: GET /RESOURCE_PATH

Specified by:

getAll in interface TopLevelResources<AutoTieringPolicyRestRep>

Parameters:

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

Returns:

Filtered list of resources of this type available to the user.

See Also:

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

listByStorageSystem

public java.util.List<NamedRelatedResourceRep> listByStorageSystem(java.net.URI storageSystemId)

Lists all auto tier policies for a given storage system.

API Call: GET /vdc/storage-systems/{storageSystemId}/auto-tier-policies

Parameters:

storageSystemId - the ID of the storage system.

Returns:

the list of auto tier policy references.

See Also:

StorageSystems

listByStorageSystem

public java.util.List<NamedRelatedResourceRep> listByStorageSystem(java.net.URI storageSystemId,
                                                                   java.lang.Boolean uniqueNames)

Lists all auto tier policies for a given storage system.

API Call: GET /vdc/storage-systems/{storageSystemId}/auto-tier-policies?unique_policy_names={uniqueNames}

Parameters:

storageSystemId - the ID of the storage system.

uniqueNames - when true duplicate named policies will be ignored.

Returns:

the list of auto tier policy references.

See Also:

StorageSystems

getByStorageSystem

public java.util.List<AutoTieringPolicyRestRep> getByStorageSystem(java.net.URI storageSystemId)

Gets all auto tier policies for a given storage system.

Parameters:

storageSystemId - the ID of the storage system.

Returns:

the list of auto tier policies.

See Also:

listByStorageSystem(URI), AbstractResources.getByRefs(java.util.Collection), StorageSystems

listByVirtualArray

public java.util.List<NamedRelatedResourceRep> listByVirtualArray(java.net.URI virtualArrayId)

Lists all auto tier policies for a given virtual array.

API Call: GET /vdc/varrays/{virtualArrayId}/auto-tier-policies

Parameters:

virtualArrayId - the ID of the virtual array.

Returns:

the list of auto tier policy references.

See Also:

VirtualArrays

listByVirtualArray

public java.util.List<NamedRelatedResourceRep> listByVirtualArray(java.net.URI virtualArrayId,
                                                                  java.lang.String provisioningType,
                                                                  java.lang.Boolean uniqueNames)

Lists all auto tier policies for a given virtual array.

API Call: GET /vdc/varrays/{virtualArrayId}/auto-tier-policies?provisioning_type={provisioningType} unique_auto_tier_policy_names={uniqueNames}

Parameters:

virtualArrayId - the ID of the virtual array.

provisioningType - the provisioning type, if null matches any provisioning type.

uniqueNames - when true duplicate named policies will be ignored.

Returns:

the list of auto tier policy references.

See Also:

VirtualArrays

getByVirtualArray

public java.util.List<AutoTieringPolicyRestRep> getByVirtualArray(java.net.URI virtualArrayId,
                                                                  java.lang.String provisioningType,
                                                                  java.lang.Boolean uniqueNames,
                                                                  ResourceFilter<AutoTieringPolicyRestRep> filter)

Gets all auto tier policies for a given virtual array.

Parameters:

virtualArrayId - the ID of the virtual array.

provisioningType - the provisioning type, if null matches any provisioning type.

uniqueNames - when true duplicate named policies will be ignored.

filter - filter used to filter results

Returns:

the list of auto tier policies.

See Also:

listByVirtualArray(URI, String, Boolean), AbstractResources.getByRefs(java.util.Collection), VirtualArrays

getByVirtualArrays

public java.util.List<AutoTieringPolicyRestRep> getByVirtualArrays(java.util.Collection<java.net.URI> virtualArrayIds,
                                                                   java.lang.String provisioningType,
                                                                   java.lang.Boolean uniqueNames,
                                                                   ResourceFilter<AutoTieringPolicyRestRep> filter)

Gets all auto tier policies for all virtual arrays.

Parameters:

virtualArrayIds - the ID of the virtual array.

provisioningType - the provisioning type, if null matches any provisioning type.

uniqueNames - when true duplicate named policies will be ignored.

filter -

Returns:

the list of auto tier policies.

See Also:

AbstractResources.getByRefs(java.util.Collection), VirtualArrays

getByVirtualArray

public java.util.List<AutoTieringPolicyRestRep> getByVirtualArray(java.net.URI virtualArrayId,
                                                                  java.lang.String provisioningType,
                                                                  java.lang.Boolean uniqueNames)

Gets all auto tier policies for a given virtual array. This is a convenience method for: getByRefs(list()).

Parameters:

virtualArrayId - the ID of the virtual array.

provisioningType - the provisioning type, if null matches any provisioning type.

uniqueNames - when true duplicate named policies will be ignored.

Returns:

the list of auto tier policies.

See Also:

getByVirtualArray(URI, String, Boolean, ResourceFilter), VirtualArrays

getByVirtualArray

public java.util.List<AutoTieringPolicyRestRep> getByVirtualArray(java.net.URI virtualArrayId)

Gets all auto tier policies for a given virtual array.

Parameters:

virtualArrayId - the ID of the virtual array.

Returns:

the list of auto tier policies.

See Also:

listByVirtualArray(URI), AbstractResources.getByRefs(java.util.Collection), VirtualArrays