com.emc.vipr.client.core

Class StorageSystems

java.lang.Object

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

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

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

com.emc.vipr.client.core.StorageSystems

All Implemented Interfaces:

BulkResources<StorageSystemRestRep>, Resources<StorageSystemRestRep>, TaskResources<StorageSystemRestRep>, TopLevelResources<StorageSystemRestRep>

public class StorageSystems
extends AbstractCoreBulkResources<StorageSystemRestRep>
implements TopLevelResources<StorageSystemRestRep>, TaskResources<StorageSystemRestRep>

Storage Systems resources.

Base URL: /vdc/storage-systems

Constructor Summary

Constructors

Constructor and Description
StorageSystems(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<StorageSystemRestRep>	add(StorageSystemSMISCreateParam input) Adds an SMI-S storage system.
Task<StorageSystemRestRep>	create(StorageSystemRequestParam input) Begins creating a storage system.
Task<StorageSystemRestRep>	deactivate(java.net.URI id) Begins deactivating the given storage system by ID.
StorageSystemRestRep	deregister(java.net.URI id) De-registers the given storage system by ID.
Task<StorageSystemRestRep>	discover(java.net.URI id) Begins discovery on the given storage system.
Task<StorageSystemRestRep>	discover(java.net.URI id, java.lang.String type) Begins discovery on the given storage system.
Tasks<StorageSystemRestRep>	discoverAll() Begins discovery on all storage systems.
java.util.List<StorageSystemRestRep>	getAll() Gets the list of all storage systems.
java.util.List<StorageSystemRestRep>	getAll(ResourceFilter<StorageSystemRestRep> filter) Gets the list of all storage systems, optionally filering the results.
java.util.List<StorageSystemRestRep>	getBySmisProvider(java.net.URI smisProviderId) Gets the list of storage systems for the given SMI-S provider by ID.
java.util.List<StorageSystemConnectivityRestRep>	getConnectivity(java.net.URI id) Gets the connectivity information for the given storage system by ID.
Task<StorageSystemRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<StorageSystemRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
java.util.List<NamedRelatedResourceRep>	list() Lists all storage systems.
java.util.List<NamedRelatedResourceRep>	listBySmisProvider(java.net.URI smisProviderId) Lists the storage systems for the given SMI-S provider by ID.
StorageSystemRestRep	register(java.net.URI id) Registers the given storage system by ID.
Task<StorageSystemRestRep>	update(java.net.URI id, StorageSystemUpdateRequestParam input) Begins updating the given storage system by ID.
StorageSystems	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
StorageSystems	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

StorageSystems

public StorageSystems(ViPRCoreClient parent,
                      RestClient client)

Method Detail

withInactive

public StorageSystems withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<StorageSystemRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public StorageSystems withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<StorageSystemRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

public Tasks<StorageSystemRestRep> getTasks(java.net.URI id)

Description copied from interface: TaskResources

Gets the tasks associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks

Specified by:

getTasks in interface TaskResources<StorageSystemRestRep>

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

public Task<StorageSystemRestRep> getTask(java.net.URI id,
                                          java.net.URI taskId)

Description copied from interface: TaskResources

Gets a single task associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks/{taskId}

Specified by:

getTask in interface TaskResources<StorageSystemRestRep>

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

list

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

Lists all storage systems.

API Call: GET /vdc/storage-systems

Specified by:

list in interface TopLevelResources<StorageSystemRestRep>

Returns:

the list of storage system references.

getAll

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

Gets the list of all storage systems. This is a convenience method for: getByRefs(list()).

Specified by:

getAll in interface TopLevelResources<StorageSystemRestRep>

Returns:

the list of all storage systems.

See Also:

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

getAll

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

Gets the list of all storage systems, optionally filering the results. This is a convenience method for: getByRefs(list(), filter).

Specified by:

getAll in interface TopLevelResources<StorageSystemRestRep>

Parameters:

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

Returns:

the list of all storage systems.

See Also:

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

create

public Task<StorageSystemRestRep> create(StorageSystemRequestParam input)

Begins creating a storage system.

API Call: POST /vdc/storage-systems

Parameters:

input - the create configuration.

Returns:

a task for monitoring the progress of the operation.

update

public Task<StorageSystemRestRep> update(java.net.URI id,
                                         StorageSystemUpdateRequestParam input)

Begins updating the given storage system by ID.

API Call: PUT /vdc/storage-systems/{id}

Parameters:

id - the ID of the storage system.

input - the update configuration.

Returns:

a task for monitoring the progress of the operation.

deactivate

public Task<StorageSystemRestRep> deactivate(java.net.URI id)

Begins deactivating the given storage system by ID.

API Call: POST /vdc/storage-systems/{id}/deactivate

Parameters:

id - the ID of the storage system.

Returns:

a task for monitoring the progress of the operation.

add

public Task<StorageSystemRestRep> add(StorageSystemSMISCreateParam input)

Adds an SMI-S storage system.

API Call: POST /vdc/storage-providers/storage-systems

Parameters:

input - the SMI-S storage system configuration.

Returns:

a task for monitoring the progress of the operation.

discoverAll

public Tasks<StorageSystemRestRep> discoverAll()

Begins discovery on all storage systems.

API Call: POST /vdc/storage-systems/discover

Returns:

tasks for monitoring the progress of the operation(s).

discover

public Task<StorageSystemRestRep> discover(java.net.URI id)

Begins discovery on the given storage system.

API Call: POST /vdc/storage-systems/{id}/discover

Parameters:

id - the ID of the storage system.

Returns:

a task for monitoring the progress of the operation.

discover

public Task<StorageSystemRestRep> discover(java.net.URI id,
                                           java.lang.String type)

Begins discovery on the given storage system.

API Call: POST /vdc/storage-systems/{id}/discover

Parameters:

id - the ID of the storage system.

type - the type of discovery to perform.

Returns:

a task for monitoring the progress of the operation.

register

public StorageSystemRestRep register(java.net.URI id)

Registers the given storage system by ID.

API Call: POST /vdc/storage-systems/{id}/register

Parameters:

id - the ID of the storage system.

Returns:

the updated storage system.

deregister

public StorageSystemRestRep deregister(java.net.URI id)

De-registers the given storage system by ID.

API Call: POST /vdc/storage-systems/{id}/deregister

Parameters:

id - the ID of the storage system.

Returns:

the updated storage system.

getConnectivity

public java.util.List<StorageSystemConnectivityRestRep> getConnectivity(java.net.URI id)

Gets the connectivity information for the given storage system by ID.

API Call: GET /vdc/storage-systems/{id}/connectivity

Parameters:

id - the ID of the storage system.

Returns:

the list of storage system connectivity.

listBySmisProvider

public java.util.List<NamedRelatedResourceRep> listBySmisProvider(java.net.URI smisProviderId)

Lists the storage systems for the given SMI-S provider by ID.

API Call: GET /vdc/storage-providers/{smisProviderId}/storage-systems

Parameters:

smisProviderId - the ID of the SMI-S provider.

Returns:

the list of storage system references.

getBySmisProvider

public java.util.List<StorageSystemRestRep> getBySmisProvider(java.net.URI smisProviderId)

Gets the list of storage systems for the given SMI-S provider by ID. This is a convenience method for getByRefs(listBySmisProvider(smisProviderId))

Parameters:

smisProviderId - the ID of the SMI-S provider.

Returns:

the list of storage systems.

See Also:

AbstractResources.getByRefs(java.util.Collection), listBySmisProvider(URI)