org.jclouds.ec2.options

Class DescribeImagesOptions

java.lang.Object

org.jclouds.http.options.BaseHttpRequestOptions

org.jclouds.ec2.options.internal.BaseEC2RequestOptions

org.jclouds.ec2.options.DescribeImagesOptions

All Implemented Interfaces:

HttpRequestOptions

Direct Known Subclasses:

AWSDescribeImagesOptions

public class DescribeImagesOptions
extends BaseEC2RequestOptions

Contains options supported in the Form API for the DescribeImages operation.

Usage

The recommended way to instantiate a DescribeImagesOptions object is to statically import DescribeImagesOptions.Builder.* and invoke a static creation method followed by an instance mutator (if needed):

import static org.jclouds.ec2.options.DescribeImagesOptions.Builder.*

EC2Api connection = // get connection Future> images = connection.getAMIApi().get().describeImages(executableBy("123125").imageIds(1000, 1004));

See Also:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DescribeImagesOptions.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static DescribeImagesOptions	NONE

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

formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor and Description
DescribeImagesOptions()

Method Summary

Modifier and Type	Method and Description
DescribeImagesOptions	executableBy(String identityId) AMIs for which the specified user has explicit launch permissions.
String	getExecutableBy()
Set<String>	getImageIds()
Set<String>	getOwners()
DescribeImagesOptions	imageIds(Iterable<String> imageIds)
DescribeImagesOptions	imageIds(String... imageIds) AMI IDs to describe.
DescribeImagesOptions	ownedBy(String... owners) Returns AMIs owned by the specified owner.

Methods inherited from class org.jclouds.ec2.options.internal.BaseEC2RequestOptions

getFormValuesWithKeysPrefixedBy, indexFormValuesWithPrefix, indexFormValuesWithPrefix, toString

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final DescribeImagesOptions NONE

Constructor Detail

DescribeImagesOptions

public DescribeImagesOptions()

Method Detail

executableBy

public DescribeImagesOptions executableBy(String identityId)

AMIs for which the specified user has explicit launch permissions.

getExecutableBy

public String getExecutableBy()

imageIds

public DescribeImagesOptions imageIds(String... imageIds)

AMI IDs to describe.

imageIds

public DescribeImagesOptions imageIds(Iterable<String> imageIds)

getImageIds

public Set<String> getImageIds()

ownedBy

public DescribeImagesOptions ownedBy(String... owners)

Returns AMIs owned by the specified owner. Multiple owners can be specified.

getOwners

public Set<String> getOwners()