com.emc.vipr.client.core

Class Vcenters

java.lang.Object

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

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

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

com.emc.vipr.client.core.Vcenters

All Implemented Interfaces:

BulkResources<VcenterRestRep>, Resources<VcenterRestRep>, TaskResources<VcenterRestRep>, TenantResources<VcenterRestRep>

public class Vcenters
extends AbstractCoreBulkResources<VcenterRestRep>
implements TenantResources<VcenterRestRep>, TaskResources<VcenterRestRep>

Vcenters resources.

Base URL: /compute/vcenters

Constructor Summary

Constructors

Constructor and Description
Vcenters(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<VcenterRestRep>	create(java.net.URI tenantId, VcenterCreateParam input) Begins creating a vCenter for the given tenant by ID.
Task<VcenterRestRep>	create(java.net.URI tenantId, VcenterCreateParam input, java.lang.Boolean validateConnection)
Task<VcenterRestRep>	create(VcenterCreateParam input, java.lang.Boolean validateConnection, java.lang.Boolean discoverVcenter) Creates the vCenter.
Task<VcenterRestRep>	deactivate(java.net.URI id) Deactivates the given vCenter by ID.
Task<VcenterRestRep>	deactivate(java.net.URI id, boolean detachStorage) Deactivates a vCenter.
Task<VcenterRestRep>	detachStorage(java.net.URI id) Detaches storage from a vCenter.
Task<VcenterRestRep>	discover(java.net.URI id) Begins discovery of the given vCenter by ID.
java.util.List<ACLEntry>	getAcls(java.net.URI vCenterId) Get the ACLs of the vCenter by ID.
java.util.List<VcenterRestRep>	getByTenant(java.net.URI tenantId) Gets the resources associated with a given tenant.
java.util.List<VcenterRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<VcenterRestRep> filter) Gets the resources associated with a given tenant, optionally filtering the results as they are returned.
java.util.List<VcenterRestRep>	getByUserTenant() Convenience method for retrieving by user's current tenant.
java.util.List<VcenterRestRep>	getByUserTenant(ResourceFilter<VcenterRestRep> filter) Convenience method for retrieving by user's current tenant.
Task<VcenterRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<VcenterRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
java.util.List<VcenterRestRep>	getVcenters(java.net.URI tenantId) Get the list of vCenter by tenantId.
java.util.List<NamedRelatedResourceRep>	listByTenant(java.net.URI tenantId) Lists the vCenters for the given tenant by ID.
java.util.List<NamedRelatedResourceRep>	listByUserTenant() Convenience method for listing by the user's current tenant.
java.util.List<NamedRelatedResourceRep>	listVcenters(java.net.URI tenantId) Get the list of vCenter by tenantId.
Task<VcenterRestRep>	update(java.net.URI id, VcenterUpdateParam input) Begins updating the given vCenter by ID.
Task<VcenterRestRep>	update(java.net.URI id, VcenterUpdateParam input, boolean validateConnection)
Task<VcenterRestRep>	update(java.net.URI id, VcenterUpdateParam input, boolean validateConnection, boolean discoverVcenter)
Task<VcenterRestRep>	updateAcls(java.net.URI id, ACLAssignmentChanges input) Upates the acls of the vCenter by ID.
Vcenters	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
Vcenters	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

Vcenters

public Vcenters(ViPRCoreClient parent,
                RestClient client)

Method Detail

withInactive

public Vcenters withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<VcenterRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public Vcenters withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<VcenterRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

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

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

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

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

listByTenant

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

Lists the vCenters for the given tenant by ID.

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

Specified by:

listByTenant in interface TenantResources<VcenterRestRep>

Parameters:

tenantId - the ID of the tenant.

Returns:

the list of vCenter references.

getByTenant

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

Description copied from interface: TenantResources

Gets the resources associated with a given tenant.

Specified by:

getByTenant in interface TenantResources<VcenterRestRep>

Parameters:

tenantId - the tenant ID.

Returns:

the list of resources for this tenant.

See Also:

Resources.getByRefs(java.util.Collection)

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<VcenterRestRep>

See Also:

TenantResources.listByTenant(URI)

getByUserTenant

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

See Also:

TenantResources.getByTenant(URI)

getByUserTenant

public java.util.List<VcenterRestRep> getByUserTenant(ResourceFilter<VcenterRestRep> 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<VcenterRestRep>

See Also:

TenantResources.getByTenant(URI, ResourceFilter)

getByTenant

public java.util.List<VcenterRestRep> getByTenant(java.net.URI tenantId,
                                                  ResourceFilter<VcenterRestRep> 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<VcenterRestRep>

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)

create

public Task<VcenterRestRep> create(java.net.URI tenantId,
                                   VcenterCreateParam input)

Begins creating a vCenter for the given tenant by ID.

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

Parameters:

tenantId - the ID of the tenant.

input - the create configuration.

Returns:

a task for monitoring the progress of the operation.

create

public Task<VcenterRestRep> create(java.net.URI tenantId,
                                   VcenterCreateParam input,
                                   java.lang.Boolean validateConnection)

update

public Task<VcenterRestRep> update(java.net.URI id,
                                   VcenterUpdateParam input)

Begins updating the given vCenter by ID.

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

Parameters:

id - the ID of the vCenter.

input - the update configuration.

Returns:

a task for monitoring the progress of the operation.

update

public Task<VcenterRestRep> update(java.net.URI id,
                                   VcenterUpdateParam input,
                                   boolean validateConnection)

update

public Task<VcenterRestRep> update(java.net.URI id,
                                   VcenterUpdateParam input,
                                   boolean validateConnection,
                                   boolean discoverVcenter)

deactivate

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

Deactivates the given vCenter by ID.

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

Parameters:

id - the ID of the vCenter to deactivate.

Returns:

a task for monitoring the progress of the operation.

deactivate

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

Deactivates a vCenter.

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

Parameters:

id - the ID of the vCenter to deactivate.

detachStorage - if true, will first detach storage.

Returns:

a task for monitoring the progress of the operation.

detachStorage

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

Detaches storage from a vCenter.

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

Parameters:

id - the ID of the host.

Returns:

a task for monitoring the progress of the operation.

discover

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

Begins discovery of the given vCenter by ID.

API Call: POST /compute/vcenters/{id}/discover

Parameters:

id - the ID of the vCenter to discover.

Returns:

a task for monitoring the progress of the operation.

getAcls

public java.util.List<ACLEntry> getAcls(java.net.URI vCenterId)

Get the ACLs of the vCenter by ID.

API Call: GET /compute/vcenters/{id}/acl

Parameters:

vCenterId - vCenter ID.

Returns:

the ACL list of vCenter.

create

public Task<VcenterRestRep> create(VcenterCreateParam input,
                                   java.lang.Boolean validateConnection,
                                   java.lang.Boolean discoverVcenter)

Creates the vCenter.

API Call: POST /compute/vcenters/

Parameters:

input - vCenter create payload.

validateConnection - flag to indicate whether to validate the vCenter connection or not.

Returns:

the vCenter discovery async task.

updateAcls

public Task<VcenterRestRep> updateAcls(java.net.URI id,
                                       ACLAssignmentChanges input)

Upates the acls of the vCenter by ID.

API Call: PUT /compute/vcenters/{id}/acl

Parameters:

input - vCenter create payload.

input - acl assignment changes to update in the vCenter.

Returns:

the vCenter discovery async task.

getVcenters

public java.util.List<VcenterRestRep> getVcenters(java.net.URI tenantId)

Get the list of vCenter by tenantId.

API Call: PUT /compute/vcenters?tenant={tenantId}

Parameters:

tenantId - the tenant id to filter the vCenters.

Returns:

the list of vCenters filtered by the tenant.

listVcenters

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

Get the list of vCenter by tenantId.

API Call: PUT /compute/vcenters?tenant={tenantId}

Parameters:

tenantId - the tenant id to filter the vCenters.

Returns:

the list of vCenters filtered by the tenant.