Package org.jclouds.cloudstack.options

Class ListSnapshotsOptions

java.lang.Object

org.jclouds.http.options.BaseHttpRequestOptions

org.jclouds.cloudstack.options.AccountInDomainOptions

org.jclouds.cloudstack.options.ListSnapshotsOptions

All Implemented Interfaces:

HttpRequestOptions

public class ListSnapshotsOptions
extends AccountInDomainOptions

Options for the Snapshot listSnapshots method.

See Also:

• SnapshotApi.listSnapshots(org.jclouds.cloudstack.options.ListSnapshotsOptions...)
• SnapshotApi.listSnapshots(org.jclouds.cloudstack.options.ListSnapshotsOptions...)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListSnapshotsOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final ListSnapshotsOptions	NONE

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

formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor	Description
ListSnapshotsOptions()

Method Summary

Modifier and Type	Method	Description
ListSnapshotsOptions	id(String id)
ListSnapshotsOptions	interval(Snapshot.Interval interval)
ListSnapshotsOptions	isRecursive(boolean isRecursive)
ListSnapshotsOptions	keyword(String keyword)
ListSnapshotsOptions	name(String name)
ListSnapshotsOptions	projectId(String projectId)
ListSnapshotsOptions	snapshotType(Snapshot.Type snapshotType)
ListSnapshotsOptions	tags(Map<String,String> tags)
ListSnapshotsOptions	volumeId(String volumeId)

Methods inherited from class org.jclouds.cloudstack.options.AccountInDomainOptions

accountInDomain, domainId

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

Constructor Details

ListSnapshotsOptions

public ListSnapshotsOptions()

Method Details

id

public ListSnapshotsOptions id(String id)

Parameters:

id - lists snapshot by snapshot ID

interval

public ListSnapshotsOptions interval(Snapshot.Interval interval)

Parameters:

interval - valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.

isRecursive

public ListSnapshotsOptions isRecursive(boolean isRecursive)

Parameters:

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

keyword

public ListSnapshotsOptions keyword(String keyword)

Parameters:

keyword - List by keyword

name

public ListSnapshotsOptions name(String name)

Parameters:

name - lists snapshot by snapshot name

snapshotType

public ListSnapshotsOptions snapshotType(Snapshot.Type snapshotType)

Parameters:

snapshotType - valid values are MANUAL or RECURRING.

volumeId

public ListSnapshotsOptions volumeId(String volumeId)

Parameters:

volumeId - the ID of the disk volume

projectId

public ListSnapshotsOptions projectId(String projectId)

Parameters:

projectId - the project to list in

tags

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

Parameters:

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