com.emc.vipr.client.core

Class UnManagedVolumes

java.lang.Object

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

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

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

com.emc.vipr.client.core.UnManagedVolumes

All Implemented Interfaces:

BulkResources<UnManagedVolumeRestRep>, Resources<UnManagedVolumeRestRep>

public class UnManagedVolumes
extends AbstractCoreBulkResources<UnManagedVolumeRestRep>

Unmanaged Volumes resources.

Base URL: /vdc/unmanaged/volumes

Constructor Summary

Constructors

Constructor and Description
UnManagedVolumes(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
java.util.List<UnManagedVolumeRestRep>	getByCluster(java.net.URI clusterId) Gets the list of unmanaged volumes for the given cluster by ID.
java.util.List<UnManagedVolumeRestRep>	getByCluster(java.net.URI clusterId, ResourceFilter<UnManagedVolumeRestRep> filter) Gets the list of unmanaged volumes for the given cluster by ID.
java.util.List<UnManagedVolumeRestRep>	getByHost(java.net.URI hostId) Gets the list of unmanaged volumes for the given host by ID.
java.util.List<UnManagedVolumeRestRep>	getByHost(java.net.URI hostId, ResourceFilter<UnManagedVolumeRestRep> filter) Gets the list of unmanaged volumes for the given host by ID.
java.util.List<UnManagedVolumeRestRep>	getByStorageSystem(java.net.URI storageSystemId) Gets the list of unmanaged volumes for the given storage system by ID.
java.util.List<UnManagedVolumeRestRep>	getByStorageSystem(java.net.URI storageSystemId, ResourceFilter<UnManagedVolumeRestRep> filter) Gets the list of unmanaged volumes for the given storage system by ID.
java.util.List<UnManagedVolumeRestRep>	getByStorageSystemVirtualPool(java.net.URI storageSystemId, java.net.URI virtualPoolId) Gets the list of unmanaged volumes for the given storage system and virtual pool by ID.
java.util.List<UnManagedVolumeRestRep>	getByStorageSystemVirtualPool(java.net.URI storageSystemId, java.net.URI virtualPoolId, ResourceFilter<UnManagedVolumeRestRep> filter) Gets the list of unmanaged volumes for the given storage system and virtual pool by ID.
Tasks<UnManagedVolumeRestRep>	ingest(VolumeIngest input) Ingests unmanaged volumes.
Tasks<UnManagedVolumeRestRep>	ingestExported(VolumeExportIngestParam input) Ingests unmanaged volumes.
java.util.List<RelatedResourceRep>	listByCluster(java.net.URI clusterId) Gets the list of unmanaged volumes for the given cluster by ID.
java.util.List<RelatedResourceRep>	listByHost(java.net.URI hostId) Gets the list of unmanaged volumes for the given host by ID.
java.util.List<RelatedResourceRep>	listByStorageSystem(java.net.URI storageSystemId) Gets the list of unmanaged volumes for the given storage system by ID.
java.util.List<NamedRelatedResourceRep>	listByStorageSystemVirtualPool(java.net.URI storageSystemId, java.net.URI virtualPoolId) Gets the list of unmanaged volumes for the given storage system and virtual pool by ID.
UnManagedVolumes	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
UnManagedVolumes	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

UnManagedVolumes

public UnManagedVolumes(ViPRCoreClient parent,
                        RestClient client)

Method Detail

withInactive

public UnManagedVolumes withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<UnManagedVolumeRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public UnManagedVolumes withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<UnManagedVolumeRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

listByStorageSystem

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

Gets the list of unmanaged volumes for the given storage system by ID.

API Call: GET /vdc/storage-systems/{storageSystemId}/unmanaged/volumes

Parameters:

storageSystemId - the ID of the storage system.

Returns:

the list of unmanaged volume references.

listByStorageSystemVirtualPool

public java.util.List<NamedRelatedResourceRep> listByStorageSystemVirtualPool(java.net.URI storageSystemId,
                                                                              java.net.URI virtualPoolId)

Gets the list of unmanaged volumes for the given storage system and virtual pool by ID.

API Call: GET /vdc/storage-systems/{storageSystemId}/unmanaged/{virtualPoolId}/volumes

Parameters:

storageSystemId - the ID of the storage system.

virtualPoolId - the ID of the virtual pool.

Returns:

the list of unmanaged volume references.

getByStorageSystemVirtualPool

public java.util.List<UnManagedVolumeRestRep> getByStorageSystemVirtualPool(java.net.URI storageSystemId,
                                                                            java.net.URI virtualPoolId)

Gets the list of unmanaged volumes for the given storage system and virtual pool by ID. This is a convenience method for: getByRefs(listByStorageSystemVirtualPool(storageSystemId, virtualPoolId))

Parameters:

storageSystemId - the ID of the storage system.

virtualPoolId - the ID of the virtual pool.

Returns:

the list of unmanaged volumes.

getByStorageSystem

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

Gets the list of unmanaged volumes for the given storage system by ID. This is a convenience method for: getByRefs(listByStorageSystem(storageSystemId))

Parameters:

storageSystemId - the ID of the storage system.

Returns:

the list of unmanaged volumes.

getByStorageSystemVirtualPool

public java.util.List<UnManagedVolumeRestRep> getByStorageSystemVirtualPool(java.net.URI storageSystemId,
                                                                            java.net.URI virtualPoolId,
                                                                            ResourceFilter<UnManagedVolumeRestRep> filter)

Gets the list of unmanaged volumes for the given storage system and virtual pool by ID. This is a convenience method for: getByRefs(listByStorageSystemVirtualPool(storageSystemId, virtualPoolId), filter)

Parameters:

storageSystemId - the ID of the storage system.

virtualPoolId - the ID of the virtual pool.

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

Returns:

the list of unmanaged volumes.

getByStorageSystem

public java.util.List<UnManagedVolumeRestRep> getByStorageSystem(java.net.URI storageSystemId,
                                                                 ResourceFilter<UnManagedVolumeRestRep> filter)

Gets the list of unmanaged volumes for the given storage system by ID. This is a convenience method for: getByRefs(listByStorageSystem(storageSystemId), filter)

Parameters:

storageSystemId - the ID of the storage system.

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

Returns:

the list of unmanaged volumes.

listByHost

public java.util.List<RelatedResourceRep> listByHost(java.net.URI hostId)

Gets the list of unmanaged volumes for the given host by ID.

API Call: GET /compute/hosts/{hostId}/unmanaged-volumes

Parameters:

hostId - the ID of the host.

Returns:

the list of unmanaged volume references.

getByHost

public java.util.List<UnManagedVolumeRestRep> getByHost(java.net.URI hostId)

Gets the list of unmanaged volumes for the given host by ID. This is a convenience method for: getByRefs(listByHost(hostId))

Parameters:

hostId - the ID of the host.

Returns:

the list of unmanaged volumes.

getByHost

public java.util.List<UnManagedVolumeRestRep> getByHost(java.net.URI hostId,
                                                        ResourceFilter<UnManagedVolumeRestRep> filter)

Gets the list of unmanaged volumes for the given host by ID. This is a convenience method for: getByRefs(listByHost(hostId), filter)

Parameters:

hostId - the ID of the host.

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

Returns:

the list of unmanaged volumes.

listByCluster

public java.util.List<RelatedResourceRep> listByCluster(java.net.URI clusterId)

Gets the list of unmanaged volumes for the given cluster by ID.

API Call: GET /compute/clusters/{clusterId}/unmanaged-volumes

Parameters:

clusterId - the ID of the cluster.

Returns:

the list of unmanaged volume references.

getByCluster

public java.util.List<UnManagedVolumeRestRep> getByCluster(java.net.URI clusterId)

Gets the list of unmanaged volumes for the given cluster by ID. This is a convenience method for: getByRefs(listByCluster(clusterId))

Parameters:

clusterId - the ID of the cluster.

Returns:

the list of unmanaged volumes.

getByCluster

public java.util.List<UnManagedVolumeRestRep> getByCluster(java.net.URI clusterId,
                                                           ResourceFilter<UnManagedVolumeRestRep> filter)

Gets the list of unmanaged volumes for the given cluster by ID. This is a convenience method for: getByRefs(listByCluster(hostId), filter)

Parameters:

clusterId - the ID of the cluster.

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

Returns:

the list of unmanaged volumes.

ingest

public Tasks<UnManagedVolumeRestRep> ingest(VolumeIngest input)

Ingests unmanaged volumes.

API Call: POST /vdc/unmanaged/volumes/ingest

Parameters:

input - the ingest configuration.

Returns:

the list of ingested volumes.

ingestExported

public Tasks<UnManagedVolumeRestRep> ingestExported(VolumeExportIngestParam input)

Ingests unmanaged volumes.

API Call: POST /vdc/unmanaged/volumes/ingest-exported

Parameters:

input - the ingest configuration.

Returns:

the list of ingested volumes.