org.jclouds.aws.ec2.options

Class AWSDescribeImagesOptions

java.lang.Object

org.jclouds.http.options.BaseHttpRequestOptions

org.jclouds.ec2.options.internal.BaseEC2RequestOptions

org.jclouds.ec2.options.DescribeImagesOptions

org.jclouds.aws.ec2.options.AWSDescribeImagesOptions

All Implemented Interfaces:

HttpRequestOptions

public class AWSDescribeImagesOptions
extends DescribeImagesOptions

Extra options only available in Amazon's implementation

Author:

Adrian Cole

See Also:

DescribeImagesOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AWSDescribeImagesOptions.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static AWSDescribeImagesOptions	NONE

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

formParameters, headers, matrixParameters, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor and Description
AWSDescribeImagesOptions()

Method Summary

Methods

Modifier and Type	Method and Description
AWSDescribeImagesOptions	executableBy(String identityId) AMIs for which the specified user has explicit launch permissions.
AWSDescribeImagesOptions	filters(Map<String,String> filters)
AWSDescribeImagesOptions	filters(com.google.common.collect.Multimap<String,String> filters) You can filter the results to return information only about images that match criteria you specify.
AWSDescribeImagesOptions	imageIds(Iterable<String> imageIds)
AWSDescribeImagesOptions	imageIds(String... imageIds) AMI IDs to describe.
AWSDescribeImagesOptions	ownedBy(String... owners) Returns AMIs owned by the specified owner.

Methods inherited from class org.jclouds.ec2.options.DescribeImagesOptions

getExecutableBy, getImageIds, getOwners

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

getFormValuesWithKeysPrefixedBy, indexFormValuesWithPrefix, indexFormValuesWithPrefix, toString

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final AWSDescribeImagesOptions NONE

Constructor Detail

AWSDescribeImagesOptions

public AWSDescribeImagesOptions()

Method Detail

executableBy

public AWSDescribeImagesOptions executableBy(String identityId)

AMIs for which the specified user has explicit launch permissions.

Overrides:

executableBy in class DescribeImagesOptions

imageIds

public AWSDescribeImagesOptions imageIds(String... imageIds)

AMI IDs to describe.

Overrides:

imageIds in class DescribeImagesOptions

imageIds

public AWSDescribeImagesOptions imageIds(Iterable<String> imageIds)

Overrides:

imageIds in class DescribeImagesOptions

ownedBy

public AWSDescribeImagesOptions ownedBy(String... owners)

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

Overrides:

ownedBy in class DescribeImagesOptions

filters

public AWSDescribeImagesOptions filters(com.google.common.collect.Multimap<String,String> filters)

You can filter the results to return information only about images that match criteria you specify. For example, you could get information only about images that use a certain kernel. You can specify multiple values for a filter (e.g., the image uses either kernel aki-1a2b3c4d or kernel aki-9b8c7d6f). An image must match at least one of the specified values for it to be included in the results.

You can specify multiple filters (e.g., the image uses a certain kernel, and uses an Amazon EBS volume as the root device). The result includes information for a particular image only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty.

You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.

filters

public AWSDescribeImagesOptions filters(Map<String,String> filters)

See Also:

filters(Multimap)