Package org.jclouds.cloudstack.options

Class ListUsersOptions

java.lang.Object

org.jclouds.http.options.BaseHttpRequestOptions

org.jclouds.cloudstack.options.AccountInDomainOptions

org.jclouds.cloudstack.options.ListUsersOptions

All Implemented Interfaces:

org.jclouds.http.options.HttpRequestOptions

public class ListUsersOptions
extends AccountInDomainOptions

Options used to control what user information is returned

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

ListUsersOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final ListUsersOptions	NONE

Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions

formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor	Description
ListUsersOptions()

Method Summary

Modifier and Type	Method	Description
ListUsersOptions	accountInDomain(String account, String domain)
ListUsersOptions	accountType(String accountType)
ListUsersOptions	domainId(String domainId)
ListUsersOptions	id(String id)
ListUsersOptions	keyword(String keyword)
ListUsersOptions	page(long page)
ListUsersOptions	pageSize(long pageSize)
ListUsersOptions	state(User.State state)
ListUsersOptions	userName(String userName)

Methods inherited from class org.jclouds.http.options.BaseHttpRequestOptions

buildFormParameters, buildPathSuffix, buildQueryParameters, buildRequestHeaders, buildStringPayload, equals, getFirstFormOrNull, getFirstHeaderOrNull, getFirstQueryOrNull, hashCode, replaceHeader, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NONE

public static final ListUsersOptions NONE

Constructor Details

ListUsersOptions

public ListUsersOptions()

Method Details

id

public ListUsersOptions id(String id)

Parameters:

id - list account by account ID

userName

public ListUsersOptions userName(String userName)

Parameters:

userName - retrieve user by name

state

public ListUsersOptions state(User.State state)

Parameters:

state - list accounts by state. Valid states are enabled, disabled, and locked.

accountType

public ListUsersOptions accountType(String accountType)

Parameters:

accountType - List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.

keyword

public ListUsersOptions keyword(String keyword)

Parameters:

keyword -

page

public ListUsersOptions page(long page)

Parameters:

page - the page number

pageSize

public ListUsersOptions pageSize(long pageSize)

Parameters:

pageSize - the number of items per page

accountInDomain

public ListUsersOptions accountInDomain(String account,
 String domain)

Overrides:

accountInDomain in class AccountInDomainOptions

Parameters:

account - an optional account for the resource

domain - domain id

domainId

public ListUsersOptions domainId(String domainId)

Overrides:

domainId in class AccountInDomainOptions

Parameters:

domainId - The domain for the resource