Package 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:

org.jclouds.http.options.HttpRequestOptions

public class ListVirtualMachinesOptions
extends AccountInDomainOptions

Options used to control what virtual machines information is returned

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

ListVirtualMachinesOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final ListVirtualMachinesOptions	NONE

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

formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor	Description
ListVirtualMachinesOptions()

Method Summary

Modifier and Type	Method	Description
ListVirtualMachinesOptions	accountInDomain(String account, String domain)
ListVirtualMachinesOptions	domainId(String domainId)
ListVirtualMachinesOptions	groupId(String groupId)
ListVirtualMachinesOptions	hostId(String hostId)
ListVirtualMachinesOptions	id(String id)
ListVirtualMachinesOptions	name(String name)
ListVirtualMachinesOptions	networkId(String networkId)
ListVirtualMachinesOptions	podId(String podId)
ListVirtualMachinesOptions	projectId(String projectId)
ListVirtualMachinesOptions	state(String state)
ListVirtualMachinesOptions	tags(Map<String,String> tags)
ListVirtualMachinesOptions	usesVirtualNetwork(boolean usesVirtualNetwork)
ListVirtualMachinesOptions	zoneId(String zoneId)

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

Constructor Details

ListVirtualMachinesOptions

public ListVirtualMachinesOptions()

Method Details

id

public ListVirtualMachinesOptions id(String 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(String groupId)

Parameters:

groupId - list virtual machines by groupId.

hostId

public ListVirtualMachinesOptions hostId(String hostId)

Parameters:

hostId - list virtual machines by hostId.

networkId

public ListVirtualMachinesOptions networkId(String networkId)

Parameters:

networkId - list virtual machines by networkId.

podId

public ListVirtualMachinesOptions podId(String podId)

Parameters:

podId - list virtual machines by podId.

projectId

public ListVirtualMachinesOptions projectId(String projectId)

Parameters:

projectId - list virtual machines by projectId.

zoneId

public ListVirtualMachinesOptions zoneId(String 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

tags

public ListVirtualMachinesOptions tags(Map<String,String> tags)

Parameters:

tags - Key/value pairs for tags that need to be matched.

accountInDomain

public ListVirtualMachinesOptions accountInDomain(String account,
 String domain)

Overrides:

accountInDomain in class AccountInDomainOptions

Parameters:

account - an optional account for the resource

domain - domain id

domainId

public ListVirtualMachinesOptions domainId(String domainId)

Overrides:

domainId in class AccountInDomainOptions

Parameters:

domainId - The domain for the resource