org.jclouds.cloudstack.options
Class ListAccountsOptions

java.lang.Object
  org.jclouds.http.options.BaseHttpRequestOptions
      org.jclouds.cloudstack.options.AccountInDomainOptions
          org.jclouds.cloudstack.options.ListAccountsOptions

All Implemented Interfaces:

HttpRequestOptions

public class ListAccountsOptions
extends AccountInDomainOptions

Options used to control what account information is returned

Author:

Adrian Cole

See Also:

Nested Class Summary

static class

ListAccountsOptions.Builder

Field Summary

static ListAccountsOptions

NONE

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

formParameters, headers, matrixParameters, pathSuffix, payload, queryParameters

Constructor Summary

ListAccountsOptions()

Method Summary

ListAccountsOptions	accountInDomain(String account, long domain)
ListAccountsOptions	cleanupRequired(boolean cleanupRequired)
ListAccountsOptions	domainId(long domainId)
ListAccountsOptions	id(long id)
ListAccountsOptions	name(String name)
ListAccountsOptions	recursive(boolean recursive)
ListAccountsOptions	state(String state)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final ListAccountsOptions NONE

Constructor Detail

ListAccountsOptions

public ListAccountsOptions()

Method Detail

id

public ListAccountsOptions id(long id)

Parameters:

id - list account by account ID

name

public ListAccountsOptions name(String name)

Parameters:

name - list account by account name

state

public ListAccountsOptions state(String state)

Parameters:

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

cleanupRequired

public ListAccountsOptions cleanupRequired(boolean cleanupRequired)

Parameters:

cleanupRequired - list accounts by cleanuprequred attribute

recursive

public ListAccountsOptions recursive(boolean recursive)

Parameters:

recursive - defaults to false, but if true, lists all accounts from the parent specified by the domain id till leaves.

accountInDomain

public ListAccountsOptions accountInDomain(String account,
                                           long domain)

Overrides:

accountInDomain in class AccountInDomainOptions

Parameters:

account - an optional account for the resource

domain - domain id

domainId

public ListAccountsOptions domainId(long domainId)

Overrides:

domainId in class AccountInDomainOptions

Parameters:

domainId - The domain for the resource