com.emc.vipr.client.core

Class ProtectionSystems

java.lang.Object

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

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

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

com.emc.vipr.client.core.ProtectionSystems

All Implemented Interfaces:

BulkResources<ProtectionSystemRestRep>, Resources<ProtectionSystemRestRep>, TaskResources<ProtectionSystemRestRep>, TopLevelResources<ProtectionSystemRestRep>

public class ProtectionSystems
extends AbstractCoreBulkResources<ProtectionSystemRestRep>
implements TopLevelResources<ProtectionSystemRestRep>, TaskResources<ProtectionSystemRestRep>

Protection Systems resources.

Base URL: /vdc/protection-systems

Constructor Summary

Constructors

Constructor and Description
ProtectionSystems(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<ProtectionSystemRestRep>	create(ProtectionSystemRequestParam input) Begins creating a protection system.
void	deactivate(java.net.URI id) Deactivates a protection system.
Task<ProtectionSystemRestRep>	discover(java.net.URI id) Begins discovery on the given protection system by ID.
Task<ProtectionSystemRestRep>	discover(java.net.URI id, java.lang.String type) Begins discovery on the given protection system
Tasks<ProtectionSystemRestRep>	discoverAll() Begins discovery on all protection systems.
java.util.List<ProtectionSystemRestRep>	getAll() Get all protection systems.
java.util.List<ProtectionSystemRestRep>	getAll(ResourceFilter<ProtectionSystemRestRep> filter) Get all protection systems, optionally filtering the results..
ProtectionSystemConnectivityRestRep	getConnectivity(java.net.URI id) Gets the protection system connectivity for the given protection system.
Task<ProtectionSystemRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<ProtectionSystemRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
java.util.List<NamedRelatedResourceRep>	list() Lists all protection systems.
Task<ProtectionSystemRestRep>	update(java.net.URI id, ProtectionSystemUpdateRequestParam input) Begins updating a protection system by ID.
ProtectionSystems	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
ProtectionSystems	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

ProtectionSystems

public ProtectionSystems(ViPRCoreClient parent,
                         RestClient client)

Method Detail

withInactive

public ProtectionSystems withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<ProtectionSystemRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public ProtectionSystems withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<ProtectionSystemRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

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

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

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

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

list

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

Lists all protection systems.

API Call: GET /vdc/protection-systems

Specified by:

list in interface TopLevelResources<ProtectionSystemRestRep>

Returns:

the list of protection system references.

getAll

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

Get all protection systems. Convenience method for: getByRefs(list())

Specified by:

getAll in interface TopLevelResources<ProtectionSystemRestRep>

Returns:

the list of protection systems.

See Also:

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

getAll

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

Get all protection systems, optionally filtering the results.. Convenience method for: getByRefs(list(), filter)

Specified by:

getAll in interface TopLevelResources<ProtectionSystemRestRep>

Parameters:

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

Returns:

the list of protection systems.

See Also:

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

create

public Task<ProtectionSystemRestRep> create(ProtectionSystemRequestParam input)

Begins creating a protection system.

API Call: POST /vdc/protection-systems

Parameters:

input - the create configuration.

Returns:

a task for monitoring the progress of the operation.

update

public Task<ProtectionSystemRestRep> update(java.net.URI id,
                                            ProtectionSystemUpdateRequestParam input)

Begins updating a protection system by ID.

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

Parameters:

id - the ID of the protection system.

input - the update configuration.

Returns:

a task for monitoring the progress of the operation.

deactivate

public void deactivate(java.net.URI id)

Deactivates a protection system.

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

Parameters:

id - the ID of the protection system.

discoverAll

public Tasks<ProtectionSystemRestRep> discoverAll()

Begins discovery on all protection systems.

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

Returns:

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

discover

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

Begins discovery on the given protection system by ID.

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

Parameters:

id - the ID of the protection system.

Returns:

a task for monitoring the progress of the operation.

discover

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

Begins discovery on the given protection system

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

Parameters:

id - the ID of the protection system.

type - the type of discovery to perform.

Returns:

a task for monitoring the progress of the operation.

getConnectivity

public ProtectionSystemConnectivityRestRep getConnectivity(java.net.URI id)

Gets the protection system connectivity for the given protection system.

API Call: POST /vdc/protection-systems/{id}/connectivity

Parameters:

id - the ID of the protection system.

Returns:

the connectivity of the protection system.