Package org.jclouds.cloudstack.options

Class ListVolumesOptions

java.lang.Object

org.jclouds.http.options.BaseHttpRequestOptions

org.jclouds.cloudstack.options.AccountInDomainOptions

org.jclouds.cloudstack.options.ListVolumesOptions

All Implemented Interfaces:

HttpRequestOptions

public class ListVolumesOptions
extends AccountInDomainOptions

Options used to control what volume

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListVolumesOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static ListVolumesOptions	NONE

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

formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor	Description
ListVolumesOptions()

Method Summary

Modifier and Type	Method	Description
ListVolumesOptions	accountInDomain(String account, String domain)
ListVolumesOptions	domainId(String domainId)
ListVolumesOptions	hostId(String hostId)	List volumes on specified host
ListVolumesOptions	id(String id)
ListVolumesOptions	isRecursive(boolean recursive)
ListVolumesOptions	keyword(String keyword)
ListVolumesOptions	name(String name)
ListVolumesOptions	podId(String podId)
ListVolumesOptions	projectId(String projectId)
ListVolumesOptions	tags(Map<String,String> tags)
ListVolumesOptions	type(Volume.Type type)
ListVolumesOptions	virtualMachineId(String virtualMachineId)
ListVolumesOptions	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 Detail

NONE

public static final ListVolumesOptions NONE

Constructor Detail

ListVolumesOptions

public ListVolumesOptions()

Method Detail

hostId

public ListVolumesOptions hostId(String hostId)

List volumes on specified host

Parameters:

hostId - hostId.

id

public ListVolumesOptions id(String id)

Parameters:

id - the ID of the volume

isRecursive

public ListVolumesOptions isRecursive(boolean recursive)

Parameters:

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

keyword

public ListVolumesOptions keyword(String keyword)

Parameters:

keyword - List by keyword

name

public ListVolumesOptions name(String name)

Parameters:

name - the name of the disk volume

podId

public ListVolumesOptions podId(String podId)

Parameters:

podId - the pod id the disk volume belongs to

type

public ListVolumesOptions type(Volume.Type type)

Parameters:

type - the type of the disk volume

virtualMachineId

public ListVolumesOptions virtualMachineId(String virtualMachineId)

Parameters:

virtualMachineId - list volumes by id virtual machine.

zoneId

public ListVolumesOptions zoneId(String zoneId)

Parameters:

zoneId - list volumes by zoneId.

projectId

public ListVolumesOptions projectId(String projectId)

Parameters:

projectId - list volumes by projectId.

tags

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

Parameters:

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

accountInDomain

public ListVolumesOptions accountInDomain(String account,
                                          String domain)

Overrides:

accountInDomain in class AccountInDomainOptions

Parameters:

account - an optional account for the resource

domain - domain id

domainId

public ListVolumesOptions domainId(String domainId)

Overrides:

domainId in class AccountInDomainOptions

Parameters:

domainId - The domain for the resource