com.emc.vipr.client.core

Class OpenStackTenants

java.lang.Object

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

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

com.emc.vipr.client.core.OpenStackTenants

All Implemented Interfaces:

Resources<OpenStackTenantParam>, TopLevelResources<OpenStackTenantParam>

public class OpenStackTenants
extends AbstractCoreResources<OpenStackTenantParam>
implements TopLevelResources<OpenStackTenantParam>

OpenStack tenants resources.

Base URL: "/v2/keystone"

Constructor Summary

Constructors

Constructor and Description
OpenStackTenants(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
OpenStackTenantParam	get(java.lang.String id) Gets OpenStack tenant with given ID.
java.util.List<OpenStackTenantParam>	getAll() Gets all OpenStack tenants.
java.util.List<OpenStackTenantParam>	getAll(ResourceFilter<OpenStackTenantParam> filter) Gets all resources for this resource type.
OSTenantListRestRep	getOpenStackTenants() Lists all OpenStack tenants.
java.util.List<NamedRelatedResourceRep>	list() Lists all OpenStack tenants.
OSTenantListRestRep	registerOpenStackTenants(OpenStackTenantListParam list) Creates representation of OpenStack Tenants in CoprHD.
void	synchronizeOpenStackTenants()
OSTenantListRestRep	updateOpenStackTenants(OSTenantListRestRep list) Updates OpenStack tenants.
OpenStackTenants	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
OpenStackTenants	withInternal(boolean internal) Configures the fetch operations to include internal resources.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenStackTenants

public OpenStackTenants(ViPRCoreClient parent,
                        RestClient client)

Method Detail

withInactive

public OpenStackTenants withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<OpenStackTenantParam>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public OpenStackTenants withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<OpenStackTenantParam>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

list

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

Lists all OpenStack tenants.

API Call: GET /v2/keystone/tenants

Specified by:

list in interface TopLevelResources<OpenStackTenantParam>

Returns:

the list of all OpenStack tenants references.

getAll

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

Gets all OpenStack tenants.

Specified by:

getAll in interface TopLevelResources<OpenStackTenantParam>

Returns:

the list of all OpenStack tenants.

See Also:

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

getOpenStackTenants

public OSTenantListRestRep getOpenStackTenants()

Lists all OpenStack tenants.

API Call: GET /v2/keystone/ostenants

Returns:

list of OpenStack tenants.

updateOpenStackTenants

public OSTenantListRestRep updateOpenStackTenants(OSTenantListRestRep list)

Updates OpenStack tenants.

API Call: PUT /v2/keystone/ostenants

Parameters:

list - list of OpenStack tenants to update.

Returns:

list of updated OpenStack tenants.

getAll

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

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)

get

public OpenStackTenantParam get(java.lang.String id)

Gets OpenStack tenant with given ID.

API Call: PUT /v2/keystone/tenants/{id}

Parameters:

id - the OpenStack tenant ID.

Returns:

single OpenStack tenant.

registerOpenStackTenants

public OSTenantListRestRep registerOpenStackTenants(OpenStackTenantListParam list)

Creates representation of OpenStack Tenants in CoprHD.

API Call: PUT /v2/keystone/tenants

Returns:

list of saved OpenStack tenants.

synchronizeOpenStackTenants

public void synchronizeOpenStackTenants()