com.emc.vipr.client.core

Class Clusters

java.lang.Object

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

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

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

com.emc.vipr.client.core.Clusters

All Implemented Interfaces:

BulkResources<ClusterRestRep>, Resources<ClusterRestRep>, TenantResources<ClusterRestRep>

public class Clusters
extends AbstractCoreBulkResources<ClusterRestRep>
implements TenantResources<ClusterRestRep>

Cluster resources.

Base URL: /compute/clusters

Constructor Summary

Constructors

Constructor and Description
Clusters(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
ClusterRestRep	create(java.net.URI tenantId, ClusterCreateParam input) Creates a cluster for the given tenant.
Task<ClusterRestRep>	deactivate(java.net.URI id) Deactivates a cluster by ID if cluster hosts do not have block or file exports.
Task<ClusterRestRep>	deactivate(java.net.URI id, boolean detachStorage) Deactivates a cluster.
Task<ClusterRestRep>	detachStorage(java.net.URI id) Detaches storage from a cluster.
java.util.List<ClusterRestRep>	getByDataCenter(java.net.URI dataCenterId) Gets the list of clusters for the given datacenter by ID.
java.util.List<ClusterRestRep>	getByTenant(java.net.URI tenantId) Gets the resources associated with a given tenant.
java.util.List<ClusterRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<ClusterRestRep> filter) Gets the resources associated with a given tenant, optionally filtering the results as they are returned.
java.util.List<ClusterRestRep>	getByUserTenant() Convenience method for retrieving by user's current tenant.
java.util.List<ClusterRestRep>	getByUserTenant(ResourceFilter<ClusterRestRep> filter) Convenience method for retrieving by user's current tenant.
java.util.List<ClusterRestRep>	getByVCenter(java.net.URI vCenterId) Gets the list of clusters for the given vCenter by ID.
java.util.List<NamedRelatedResourceRep>	listByDataCenter(java.net.URI dataCenterId) Lists the clusters for the given datacenter by ID.
java.util.List<NamedRelatedResourceRep>	listByTenant(java.net.URI tenantId) Lists the clusters for the given tenant.
java.util.List<NamedRelatedResourceRep>	listByUserTenant() Convenience method for listing by the user's current tenant.
java.util.List<NamedRelatedResourceRep>	listByVCenter(java.net.URI vCenterId) Lists the clusters for the given vCenter by ID.
ClusterSearchBuilder	search() Creates a search builder specifically for creating cluster search queries.
java.util.List<ClusterRestRep>	searchByName(java.lang.String clusterName) Lists the clusters for the given name.
ClusterRestRep	update(java.net.URI id, ClusterUpdateParam input) Updates a cluster by ID.
ClusterRestRep	update(java.net.URI id, ClusterUpdateParam input, boolean updateExports) Updates a cluster by ID.
Clusters	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
Clusters	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, 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, updateTags

Constructor Detail

Clusters

public Clusters(ViPRCoreClient parent,
                RestClient client)

Method Detail

withInactive

public Clusters withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<ClusterRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public Clusters withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<ClusterRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

listByTenant

public java.util.List<NamedRelatedResourceRep> listByTenant(java.net.URI tenantId)

Lists the clusters for the given tenant.

API Call: GET /tenants/{tenantId}/clusters

Specified by:

listByTenant in interface TenantResources<ClusterRestRep>

Parameters:

tenantId - the ID of the tenant.

Returns:

the list of cluster references.

listByUserTenant

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

Description copied from interface: TenantResources

Convenience method for listing by the user's current tenant.

Equivalent to: listByTenant(client.getUserTenant())

Specified by:

listByUserTenant in interface TenantResources<ClusterRestRep>

See Also:

TenantResources.listByTenant(URI)

getByUserTenant

public java.util.List<ClusterRestRep> getByUserTenant()

Description copied from interface: TenantResources

Convenience method for retrieving by user's current tenant.

Equivalent to: getByTenant(client.getUserTenant())

Specified by:

getByUserTenant in interface TenantResources<ClusterRestRep>

See Also:

TenantResources.getByTenant(URI)

getByUserTenant

public java.util.List<ClusterRestRep> getByUserTenant(ResourceFilter<ClusterRestRep> filter)

Description copied from interface: TenantResources

Convenience method for retrieving by user's current tenant.

Equivalent to: getByTenant(client.getUserTenant(), filter)

Specified by:

getByUserTenant in interface TenantResources<ClusterRestRep>

See Also:

TenantResources.getByTenant(URI, ResourceFilter)

getByTenant

public java.util.List<ClusterRestRep> getByTenant(java.net.URI tenantId)

Description copied from interface: TenantResources

Gets the resources associated with a given tenant.

Specified by:

getByTenant in interface TenantResources<ClusterRestRep>

Parameters:

tenantId - the tenant ID.

Returns:

the list of resources for this tenant.

See Also:

Resources.getByRefs(java.util.Collection)

getByTenant

public java.util.List<ClusterRestRep> getByTenant(java.net.URI tenantId,
                                                  ResourceFilter<ClusterRestRep> filter)

Description copied from interface: TenantResources

Gets the resources associated with a given tenant, optionally filtering the results as they are returned.

Specified by:

getByTenant in interface TenantResources<ClusterRestRep>

Parameters:

tenantId - the tenant ID.

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

Returns:

the list of resources for the tenant.

See Also:

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

listByDataCenter

public java.util.List<NamedRelatedResourceRep> listByDataCenter(java.net.URI dataCenterId)

Lists the clusters for the given datacenter by ID.

API Call: GET /compute/vcenter-data-centers/{dataCenterId}/clusters

Parameters:

dataCenterId - the ID of the datacenter.

Returns:

the list of cluster references.

getByDataCenter

public java.util.List<ClusterRestRep> getByDataCenter(java.net.URI dataCenterId)

Gets the list of clusters for the given datacenter by ID.

Convenience method for getByRefs(listByDataCenter(dataCenterId)).

Parameters:

dataCenterId - the ID of the datacenter.

Returns:

the list of clusters.

See Also:

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

listByVCenter

public java.util.List<NamedRelatedResourceRep> listByVCenter(java.net.URI vCenterId)

Lists the clusters for the given vCenter by ID.

API Call: GET /compute/vcenters/{vCenterId}/clusters

Parameters:

vCenterId - the ID of the vCenter.

Returns:

the list of cluster references.

getByVCenter

public java.util.List<ClusterRestRep> getByVCenter(java.net.URI vCenterId)

Gets the list of clusters for the given vCenter by ID.

Convenience method for getByRefs(listByVCenter(vCenterId)).

Parameters:

vCenterId - the ID of the vCenter.

Returns:

the list of clusters.

See Also:

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

create

public ClusterRestRep create(java.net.URI tenantId,
                             ClusterCreateParam input)

Creates a cluster for the given tenant.

API Call: POST /tenants/{tenantId}/clusters

Parameters:

tenantId - the ID of the tenant.

input - the create configuration.

Returns:

the newly created cluster.

update

public ClusterRestRep update(java.net.URI id,
                             ClusterUpdateParam input)

Updates a cluster by ID.

API Call: PUT /compute/clusters/{id}

Parameters:

id - the ID of the cluster to update.

input - the update configuration.

Returns:

the updated cluster.

update

public ClusterRestRep update(java.net.URI id,
                             ClusterUpdateParam input,
                             boolean updateExports)

Updates a cluster by ID.

API Call: PUT /compute/clusters/{id}?update-exports={updateExports}

Parameters:

id - the ID of the cluster to update.

input - the update configuration.

updateExports - if true, will also update cluster exports.

deactivate

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

Deactivates a cluster by ID if cluster hosts do not have block or file exports.

API Call: POST /compute/clusters/{id}/deactivate

Parameters:

id - the ID of the cluster to deactivate. The cluster hosts must not have block or file exports

deactivate

public Task<ClusterRestRep> deactivate(java.net.URI id,
                                       boolean detachStorage)

Deactivates a cluster.

API Call: POST /compute/clusters/{id}/deactivate?detach-storage={detachStorage}

Parameters:

id - the ID of the cluster to deactivate.

detachStorage - if true, will first detach storage.

detachStorage

public Task<ClusterRestRep> detachStorage(java.net.URI id)

Detaches storage from a cluster.

API Call: POST /compute/clusters/{id}/detach-storage

Parameters:

id - the ID of the cluster.

searchByName

public java.util.List<ClusterRestRep> searchByName(java.lang.String clusterName)

Lists the clusters for the given name.

API Call: GET /compute/clusters/search?name={name}

Parameters:

clusterName - the name of the cluster.

Returns:

the list of cluster references.

search

public ClusterSearchBuilder search()

Creates a search builder specifically for creating cluster search queries.

Specified by:

search in interface Resources<ClusterRestRep>

Overrides:

search in class AbstractResources<ClusterRestRep>

Returns:

a cluster search builder.