org.jclouds.cloudstack.options
Class ListVirtualMachinesOptions

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

All Implemented Interfaces:

HttpRequestOptions

public class ListVirtualMachinesOptions
extends AccountInDomainOptions

Options used to control what virtual machines information is returned

Author:

Adrian Cole

See Also:

Nested Class Summary

static class

ListVirtualMachinesOptions.Builder

Field Summary

static ListVirtualMachinesOptions

NONE

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

formParameters, headers, matrixParameters, pathSuffix, payload, queryParameters

Constructor Summary

ListVirtualMachinesOptions()

Method Summary

ListVirtualMachinesOptions	accountInDomain(String account, long domain)
ListVirtualMachinesOptions	domainId(long domainId)
ListVirtualMachinesOptions	groupId(long groupId)
ListVirtualMachinesOptions	hostId(long hostId)
ListVirtualMachinesOptions	id(long id)
ListVirtualMachinesOptions	name(String name)
ListVirtualMachinesOptions	networkId(long networkId)
ListVirtualMachinesOptions	podId(long podId)
ListVirtualMachinesOptions	state(String state)
ListVirtualMachinesOptions	usesVirtualNetwork(boolean usesVirtualNetwork)
ListVirtualMachinesOptions	zoneId(long zoneId)

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 ListVirtualMachinesOptions NONE

Constructor Detail

ListVirtualMachinesOptions

public ListVirtualMachinesOptions()

Method Detail

id

public ListVirtualMachinesOptions id(long id)

Parameters:

id - the ID of the virtual machine

name

public ListVirtualMachinesOptions name(String name)

Parameters:

name - the virtual machine name

state

public ListVirtualMachinesOptions state(String state)

Parameters:

state - state of the virtual machine

groupId

public ListVirtualMachinesOptions groupId(long groupId)

Parameters:

groupId - list virtual machines by groupId.

hostId

public ListVirtualMachinesOptions hostId(long hostId)

Parameters:

hostId - list virtual machines by hostId.

networkId

public ListVirtualMachinesOptions networkId(long networkId)

Parameters:

networkId - list virtual machines by networkId.

podId

public ListVirtualMachinesOptions podId(long podId)

Parameters:

podId - list virtual machines by podId.

zoneId

public ListVirtualMachinesOptions zoneId(long zoneId)

Parameters:

zoneId - list virtual machines by zoneId.

usesVirtualNetwork

public ListVirtualMachinesOptions usesVirtualNetwork(boolean usesVirtualNetwork)

Parameters:

usesVirtualNetwork - list by network type; true if need to list vms using Virtual Network, false otherwise

accountInDomain

public ListVirtualMachinesOptions accountInDomain(String account,
                                                  long domain)

Overrides:

accountInDomain in class AccountInDomainOptions

Parameters:

account - an optional account for the resource

domain - domain id

domainId

public ListVirtualMachinesOptions domainId(long domainId)

Overrides:

domainId in class AccountInDomainOptions

Parameters:

domainId - The domain for the resource