com.emc.vipr.client.core

Class VirtualDataCenters

java.lang.Object

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

com.emc.vipr.client.core.AbstractCoreResources<VirtualDataCenterRestRep>

com.emc.vipr.client.core.VirtualDataCenters

All Implemented Interfaces:

Resources<VirtualDataCenterRestRep>, TopLevelResources<VirtualDataCenterRestRep>

public class VirtualDataCenters
extends AbstractCoreResources<VirtualDataCenterRestRep>
implements TopLevelResources<VirtualDataCenterRestRep>

VDC resources.

Base URL: /vdc

Constructor Summary

Constructors

Constructor and Description
VirtualDataCenters(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<VirtualDataCenterRestRep>	create(VirtualDataCenterAddParam input) Creates a vdc.
Task<VirtualDataCenterRestRep>	delete(java.net.URI id) Deletes the given vdc by ID.
Task<VirtualDataCenterRestRep>	disconnect(java.net.URI id) Disconnects the given vdc by ID.
java.util.List<VirtualDataCenterRestRep>	getAll() Gets all resources for this resource type.
java.util.List<VirtualDataCenterRestRep>	getAll(ResourceFilter<VirtualDataCenterRestRep> filter) Gets all resources for this resource type.
VirtualDataCenterSecretKeyRestRep	getSecretKey() gets the secret key.
Tasks<VirtualDataCenterRestRep>	getTasks(java.net.URI id)
boolean	isCompatibleVDCVersion(java.lang.String expectedVersion) A VDC compatibility check to see of all the VDCs in the federation are in the minimum expected version or not.
boolean	isGeoSetup() A check to see if the setup is geo-distributed multi-vdc setup.
java.util.List<NamedRelatedResourceRep>	list() Lists named resources (name + ID) for this resource type.
Task<VirtualDataCenterRestRep>	reconnect(java.net.URI id) Reconnects the given vdc by ID.
Task<VirtualDataCenterRestRep>	update(java.net.URI id, VirtualDataCenterModifyParam input) Updates a vdc.
VirtualDataCenters	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.

Methods inherited from class com.emc.vipr.client.core.AbstractResources

addTags, get, get, getByIds, getByIds, getByRefs, getByRefs, getTags, performSearch, performSearchBy, removeTags, search, updateTags, withInternal

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VirtualDataCenters

public VirtualDataCenters(ViPRCoreClient parent,
                          RestClient client)

Method Detail

withInactive

public VirtualDataCenters withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<VirtualDataCenterRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

list

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

Description copied from interface: TopLevelResources

Lists named resources (name + ID) for this resource type.

API Call: GET /RESOURCE_PATH

Specified by:

list in interface TopLevelResources<VirtualDataCenterRestRep>

Returns:

the named resources.

create

public Task<VirtualDataCenterRestRep> create(VirtualDataCenterAddParam input)

Creates a vdc.

API Call: POST /vdc/

Parameters:

input - the vdc configuration.

Returns:

Task VirtualDataCenterRestRep the task to create the vdc.

update

public Task<VirtualDataCenterRestRep> update(java.net.URI id,
                                             VirtualDataCenterModifyParam input)

Updates a vdc.

API Call: PUT /vdc/{id}

Parameters:

id - the ID of the vdc to update.

input - the vdc configuration.

Returns:

Task VirtualDataCenterRestRep the task to update the vdc.

delete

public Task<VirtualDataCenterRestRep> delete(java.net.URI id)

Deletes the given vdc by ID.

API Call: DELETE /vdc/{id}

Parameters:

id - the ID of the vdc to delete.

Returns:

Task VirtualDataCenterRestRep the task to delete the vdc.

reconnect

public Task<VirtualDataCenterRestRep> reconnect(java.net.URI id)

Reconnects the given vdc by ID.

API Call: POST /vdc/{id}/reconnect

Parameters:

id - the ID of the vdc to reconnect.

Returns:

Task VirtualDataCenterRestRep the task to reconnect the vdc.

disconnect

public Task<VirtualDataCenterRestRep> disconnect(java.net.URI id)

Disconnects the given vdc by ID.

API Call: POST /vdc/{id}/disconnect

Parameters:

id - the ID of the vdc to disconnect.

Returns:

Task VirtualDataCenterRestRep the task to disconnect the vdc.

getSecretKey

public VirtualDataCenterSecretKeyRestRep getSecretKey()

gets the secret key.

API Call: POST /vdc/secret-key

Returns:

VirtualDataCenterSecretKeyRestRep the vdc secret key response.

getAll

public java.util.List<VirtualDataCenterRestRep> 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<VirtualDataCenterRestRep>

Returns:

All resources of this type available to the user.

See Also:

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

getAll

public java.util.List<VirtualDataCenterRestRep> getAll(ResourceFilter<VirtualDataCenterRestRep> 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<VirtualDataCenterRestRep>

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)

getTasks

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

isCompatibleVDCVersion

public boolean isCompatibleVDCVersion(java.lang.String expectedVersion)

A VDC compatibility check to see of all the VDCs in the federation are in the minimum expected version or not. This can be used in the UI to restrict a view of a feature. * API Call: GET /vdc/check-compatibility?expect_version={expectedVersion}

Parameters:

expectedVersion - minimum expected version of all the VDCs in the federation.

Returns:

true if the all the VDCs are in equal or higher version of the expectedVersion otherwise false.

isGeoSetup

public boolean isGeoSetup()

A check to see if the setup is geo-distributed multi-vdc setup. This can be used in the UI to restrict a view of a feature. * API Call: GET /vdc/check-geo-distributed

Returns:

true if the setup is geo-distributed/multi-vdc setup otherwise false.