com.emc.vipr.client.core

Class StorageProviders

java.lang.Object

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

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

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

com.emc.vipr.client.core.StorageProviders

All Implemented Interfaces:

BulkResources<StorageProviderRestRep>, Resources<StorageProviderRestRep>, TaskResources<StorageProviderRestRep>, TopLevelResources<StorageProviderRestRep>

public class StorageProviders
extends AbstractCoreBulkResources<StorageProviderRestRep>
implements TopLevelResources<StorageProviderRestRep>, TaskResources<StorageProviderRestRep>

SMI-S Providers resources.

Base URL: /vdc/storage-providers

Constructor Summary

Constructors

Constructor and Description
StorageProviders(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<StorageProviderRestRep>	create(StorageProviderCreateParam input) Begins creating a new storage provider.
void	deactivate(java.net.URI id) Deactivates the given storage provider by ID.
java.util.List<StorageProviderRestRep>	getAll() Gets a list of all SMI-S providers.
java.util.List<StorageProviderRestRep>	getAll(ResourceFilter<StorageProviderRestRep> filter) Gets a list of all SMI-S providers, optionally filtering the results.
Task<StorageProviderRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<StorageProviderRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
java.util.List<NamedRelatedResourceRep>	list() Lists all Storage providers.
java.util.List<DecommissionedResourceRep>	listDeactivatedSystems() Gets all deactivated systems.
Tasks<StorageProviderRestRep>	scanAll() Scans all storage providers.
StorageProviderRestRep	update(java.net.URI id, StorageProviderUpdateParam input) Updates the given storage provider by ID.
StorageProviders	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
StorageProviders	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

StorageProviders

public StorageProviders(ViPRCoreClient parent,
                        RestClient client)

Method Detail

withInactive

public StorageProviders withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<StorageProviderRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public StorageProviders withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<StorageProviderRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

public Tasks<StorageProviderRestRep> 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<StorageProviderRestRep>

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

public Task<StorageProviderRestRep> 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<StorageProviderRestRep>

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

list

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

Lists all Storage providers.

API Call: GET /vdc/storage-providers

Specified by:

list in interface TopLevelResources<StorageProviderRestRep>

Returns:

the list of Storage provider references.

getAll

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

Gets a list of all SMI-S providers. This is a convenience method for: getByRefs(list()).

Specified by:

getAll in interface TopLevelResources<StorageProviderRestRep>

Returns:

the list of SMI-S providers.

See Also:

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

getAll

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

Gets a list of all SMI-S providers, optionally filtering the results. This is a convenience method for: getByRefs(list(), filter).

Specified by:

getAll in interface TopLevelResources<StorageProviderRestRep>

Parameters:

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

Returns:

the list of SMI-S providers.

See Also:

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

create

public Task<StorageProviderRestRep> create(StorageProviderCreateParam input)

Begins creating a new storage provider.

API Call: POST /vdc/storage-providers

Parameters:

input - the create configuration.

Returns:

a task for monitoring the progress of the operation.

update

public StorageProviderRestRep update(java.net.URI id,
                                     StorageProviderUpdateParam input)

Updates the given storage provider by ID.

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

Parameters:

id - the ID of the SMI-S provider.

input - the update configuration.

Returns:

the updated SMI-S provider.

deactivate

public void deactivate(java.net.URI id)

Deactivates the given storage provider by ID.

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

Parameters:

id - the ID of the SMI-S provider.

scanAll

public Tasks<StorageProviderRestRep> scanAll()

Scans all storage providers.

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

Returns:

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

listDeactivatedSystems

public java.util.List<DecommissionedResourceRep> listDeactivatedSystems()

Gets all deactivated systems.

API Call: GET /vdc/storage-providers/deactivated-systems

Returns:

the list of deactivates systems.