com.emc.vipr.client.core

Class Tenants

java.lang.Object

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

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

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

com.emc.vipr.client.core.Tenants

All Implemented Interfaces:

BulkResources<TenantOrgRestRep>, QuotaResources, Resources<TenantOrgRestRep>

public class Tenants
extends AbstractCoreBulkResources<TenantOrgRestRep>
implements QuotaResources

Tenants resources.

Base URL: /tenants

Constructor Summary

Constructors

Constructor and Description
Tenants(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
TenantOrgRestRep	create(TenantCreateParam input) Creates a sub-tenant within the current tenant.
TenantOrgRestRep	create(java.net.URI parentTenantId, TenantCreateParam input) Creates a sub-tenant within the given tenant.
Task<HostRestRep>	createHost(java.net.URI tenantId, HostCreateParam input) Creates a host within the given tenant.
Task<HostRestRep>	createHost(java.net.URI tenantId, HostCreateParam input, boolean validateConnection)
TenantResponse	current() Gets the tenant for the current user.
java.net.URI	currentId() Gets the ID of the tenant for the current user.
void	deactivate(java.net.URI id) Deactivates the given tenant by ID.
java.util.List<TenantOrgRestRep>	getAllSubtenants(java.net.URI parentId) Gets the list of all sub-tenants for the given tenant.
java.util.List<TenantOrgRestRep>	getAllSubtenants(java.net.URI parentId, ResourceFilter<TenantOrgRestRep> filter) Gets the list of all sub-tenants for the given tenant.
QuotaInfo	getQuota(java.net.URI id) Gets the quota information for a given resource by ID.
java.util.List<RoleAssignmentEntry>	getRoleAssignments(java.net.URI id) Get Role Assignments for the specified tenant.
SchedulePolicyList	getSchedulePoliciesByTenant(java.net.URI id) Gets the file policies for a given tenant.
java.util.List<NamedRelatedResourceRep>	listSubtenants(java.net.URI parentId) Lists the sub-tenants of the given tenant.
TenantOrgRestRep	update(java.net.URI id, TenantUpdateParam input) Updates the given tenant by ID.
QuotaInfo	updateQuota(java.net.URI id, QuotaUpdateParam quota) Updates the quota information for a given resource by ID.
java.util.List<RoleAssignmentEntry>	updateRoleAssignments(java.net.URI id, RoleAssignmentChanges roleChanges) Update Role Assignments for the specified tenant.
Tenants	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
Tenants	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

Tenants

public Tenants(ViPRCoreClient parent,
               RestClient client)

Method Detail

withInactive

public Tenants withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<TenantOrgRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public Tenants withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<TenantOrgRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

current

public TenantResponse current()

Gets the tenant for the current user.

API Call: GET /tenant

Returns:

the current tenant.

currentId

public java.net.URI currentId()

Gets the ID of the tenant for the current user.

Returns:

the current tenant ID.

create

public TenantOrgRestRep create(TenantCreateParam input)

Creates a sub-tenant within the current tenant.

Parameters:

input - the tenant configuration.

Returns:

the newly created tenant.

create

public TenantOrgRestRep create(java.net.URI parentTenantId,
                               TenantCreateParam input)

Creates a sub-tenant within the given tenant.

API Call: POST /tenants/{parentTenantId}/subtenants

Parameters:

parentTenantId - the ID of the parent tenant.

input - the tenant configuration.

Returns:

the newly created tenant.

createHost

public Task<HostRestRep> createHost(java.net.URI tenantId,
                                    HostCreateParam input)

Creates a host within the given tenant.

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

Parameters:

tenantId - the ID of the tenant.

input - the create configuration.

Returns:

a task for monitoring the progress of the operation.

createHost

public Task<HostRestRep> createHost(java.net.URI tenantId,
                                    HostCreateParam input,
                                    boolean validateConnection)

update

public TenantOrgRestRep update(java.net.URI id,
                               TenantUpdateParam input)

Updates the given tenant by ID.

API Call: PUT /tenants/{id}

Parameters:

id - the ID of the tenant to update.

input - the update configuration.

Returns:

the updated tenant configuration.

getQuota

public QuotaInfo getQuota(java.net.URI id)

Description copied from interface: QuotaResources

Gets the quota information for a given resource by ID.

API Call: GET baseUrl/{id}/quota

Specified by:

getQuota in interface QuotaResources

Parameters:

id - the resource ID.

Returns:

the quota information.

updateQuota

public QuotaInfo updateQuota(java.net.URI id,
                             QuotaUpdateParam quota)

Description copied from interface: QuotaResources

Updates the quota information for a given resource by ID.

API Call: PUT baseUrl/{id}/quota

Specified by:

updateQuota in interface QuotaResources

Parameters:

id - the resource ID.

quota - the update to the quota.

Returns:

the updated quota information after applying the update.

getRoleAssignments

public java.util.List<RoleAssignmentEntry> getRoleAssignments(java.net.URI id)

Get Role Assignments for the specified tenant.

API Call: GET /tenants/{id}/role-assignments

Parameters:

id - the ID of the tenant.

Returns:

the list of RoleAssignmentEntry

updateRoleAssignments

public java.util.List<RoleAssignmentEntry> updateRoleAssignments(java.net.URI id,
                                                                 RoleAssignmentChanges roleChanges)

Update Role Assignments for the specified tenant.

API Call: PUT /tenants/{id}/role-assignments

Parameters:

id - the ID of the tenant.

roleChanges - Role assignment changes

Returns:

the list of RoleAssignmentEntry

listSubtenants

public java.util.List<NamedRelatedResourceRep> listSubtenants(java.net.URI parentId)

Lists the sub-tenants of the given tenant.

API Call: GET /tenants/{parentId}/subtenants

Parameters:

parentId - the ID of the parent tenant.

Returns:

the list of sub-tenant references.

getAllSubtenants

public java.util.List<TenantOrgRestRep> getAllSubtenants(java.net.URI parentId)

Gets the list of all sub-tenants for the given tenant. This is a convenience method for: getByRefs(listSubtenants(parentId))

Parameters:

parentId - the ID of the parent tenant.

Returns:

the list of sub-tenants.

getAllSubtenants

public java.util.List<TenantOrgRestRep> getAllSubtenants(java.net.URI parentId,
                                                         ResourceFilter<TenantOrgRestRep> filter)

Gets the list of all sub-tenants for the given tenant. This is a convenience method for: getByRefs(listSubtenants(parentId))

Parameters:

parentId - the ID of the parent tenant.

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

Returns:

the list of sub-tenants.

deactivate

public void deactivate(java.net.URI id)

Deactivates the given tenant by ID.

API Call: POST /vdc/tenants/{id}/deactivate

Parameters:

id - the ID of the tenant to deactivate.

getSchedulePoliciesByTenant

public SchedulePolicyList getSchedulePoliciesByTenant(java.net.URI id)

Gets the file policies for a given tenant.

API Call: GET /tenants/{tenantId}/schedule-policies

Parameters:

id - the tenant id.

Returns:

a task for monitoring the progress of the operation.