com.emc.vipr.client.core

Class UserGroup

java.lang.Object

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

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

com.emc.vipr.client.core.UserGroup

All Implemented Interfaces:

Resources<UserGroupRestRep>, TopLevelResources<UserGroupRestRep>

public class UserGroup
extends AbstractCoreResources<UserGroupRestRep>
implements TopLevelResources<UserGroupRestRep>

Constructor Summary

Constructors

Constructor and Description
UserGroup(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
UserGroupRestRep	create(UserGroupCreateParam input) Creates an user group.
void	delete(java.net.URI id) Deletes an user group.
java.util.List<UserGroupRestRep>	getAll() Gets all resources for this resource type.
java.util.List<UserGroupRestRep>	getAll(ResourceFilter<UserGroupRestRep> filter) Gets all resources for this resource type.
java.util.List<NamedRelatedResourceRep>	list() Lists all user groups.
UserGroupRestRep	update(java.net.URI id, UserGroupUpdateParam input) Updates an user group.
UserGroup	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
UserGroup	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

UserGroup

public UserGroup(ViPRCoreClient parent,
                 RestClient client)

Method Detail

withInactive

public UserGroup withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<UserGroupRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public UserGroup withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<UserGroupRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

list

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

Lists all user groups.

API Call: GET /vdc/admin/user-groups

Specified by:

list in interface TopLevelResources<UserGroupRestRep>

Returns:

the list of user groups.

getAll

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

Returns:

All resources of this type available to the user.

See Also:

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

getAll

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

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)

create

public UserGroupRestRep create(UserGroupCreateParam input)

Creates an user group.

API Call: POST /vdc/admin/user-groups

Parameters:

input - the create configuration.

Returns:

the created user group.

update

public UserGroupRestRep update(java.net.URI id,
                               UserGroupUpdateParam input)

Updates an user group.

API Call: PUT /vdc/admin/user-groups

Parameters:

input - the update configuration.

Returns:

the updated user group.

delete

public void delete(java.net.URI id)

Deletes an user group.

API Call: DELETE /vdc/admin/user-groups/{id}

Parameters:

id - the user group ID.