org.jclouds.ec2.util

Class SubnetFilterBuilder

java.lang.Object

com.google.common.collect.ImmutableMultimap.Builder<String,String>

org.jclouds.ec2.util.SubnetFilterBuilder

public class SubnetFilterBuilder
extends com.google.common.collect.ImmutableMultimap.Builder<String,String>

You can specify filters so that the response includes information for only certain subnets. For example, you can use a filter to specify that you're interested in the subnets in the available state. You can specify multiple values for a filter. The response includes information for a subnet only if it matches at least one of the filter values that you specified. You can specify multiple filters; for example, specify subnets that are in a specific VPC and are in the available state. The response includes information for a subnet only if it matches all the filters that you specified. If there's no match, no special message is returned, the response is simply empty.

Wildcards

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?\.

Author:

Adrian Cole, Andrew Bayer

See Also:

SubnetApi

Constructor Summary

Constructors

Constructor and Description
SubnetFilterBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
SubnetFilterBuilder	anyAvailabilityZone()
SubnetFilterBuilder	anyAvailableIpAddressCount()
SubnetFilterBuilder	anyCidr()
SubnetFilterBuilder	anyState()
SubnetFilterBuilder	anySubnetId()
SubnetFilterBuilder	anyTagKey()
SubnetFilterBuilder	anyTagValue()
SubnetFilterBuilder	anyVpcId()
SubnetFilterBuilder	arbitraryTag(String arbitraryTagKey, Iterable<String> arbitraryTagValues)
SubnetFilterBuilder	arbitraryTag(String arbitraryTagKey, String... arbitraryTagValues)
SubnetFilterBuilder	arbitraryTag(String arbitraryTagKey, String arbitraryTagValue)
SubnetFilterBuilder	availabilityZone(String availabilityZone)
SubnetFilterBuilder	availabilityZones(Iterable<String> availabilityZones)
SubnetFilterBuilder	availabilityZones(String... availabilityZones)
SubnetFilterBuilder	available()
SubnetFilterBuilder	availableIpAddressCount(String availableIpAddressCount)
SubnetFilterBuilder	availableIpAddressCounts(Iterable<String> availableIpAddressCounts)
SubnetFilterBuilder	availableIpAddressCounts(String... availableIpAddressCounts)
SubnetFilterBuilder	cidr(String cidr)
SubnetFilterBuilder	cidrs(Iterable<String> cidrs)
SubnetFilterBuilder	cidrs(String... cidrs)
SubnetFilterBuilder	orderKeysBy(Comparator<? super String> keyComparator)
SubnetFilterBuilder	orderValuesBy(Comparator<? super String> valueComparator)
SubnetFilterBuilder	pending()
SubnetFilterBuilder	put(Map.Entry<? extends String,? extends String> entry)
SubnetFilterBuilder	put(String key, String value)
SubnetFilterBuilder	putAll(com.google.common.collect.Multimap<? extends String,? extends String> multimap)
SubnetFilterBuilder	putAll(String key, Iterable<? extends String> values)
SubnetFilterBuilder	putAll(String key, String... values)
SubnetFilterBuilder	state(String state)
SubnetFilterBuilder	states(Iterable<String> states)
SubnetFilterBuilder	states(String... states)
SubnetFilterBuilder	subnetId(String subnetId)
SubnetFilterBuilder	subnetIds(Iterable<String> subnetIds)
SubnetFilterBuilder	subnetIds(String... subnetIds)
SubnetFilterBuilder	tagKey(String tagKey)
SubnetFilterBuilder	tagKeys(Iterable<String> tagKeys)
SubnetFilterBuilder	tagKeys(String... tagKeys)
SubnetFilterBuilder	tagValue(String tagValue)
SubnetFilterBuilder	tagValues(Iterable<String> tagValues)
SubnetFilterBuilder	tagValues(String... tagValues)
SubnetFilterBuilder	vpcId(String vpcId)
SubnetFilterBuilder	vpcIds(Iterable<String> vpcIds)
SubnetFilterBuilder	vpcIds(String... vpcIds)

Methods inherited from class com.google.common.collect.ImmutableMultimap.Builder

build

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubnetFilterBuilder

public SubnetFilterBuilder()

Method Detail

availabilityZone

public SubnetFilterBuilder availabilityZone(String availabilityZone)

availabilityZones

public SubnetFilterBuilder availabilityZones(String... availabilityZones)

availabilityZones

public SubnetFilterBuilder availabilityZones(Iterable<String> availabilityZones)

anyAvailabilityZone

public SubnetFilterBuilder anyAvailabilityZone()

availableIpAddressCount

public SubnetFilterBuilder availableIpAddressCount(String availableIpAddressCount)

availableIpAddressCounts

public SubnetFilterBuilder availableIpAddressCounts(String... availableIpAddressCounts)

availableIpAddressCounts

public SubnetFilterBuilder availableIpAddressCounts(Iterable<String> availableIpAddressCounts)

anyAvailableIpAddressCount

public SubnetFilterBuilder anyAvailableIpAddressCount()

cidr

public SubnetFilterBuilder cidr(String cidr)

cidrs

public SubnetFilterBuilder cidrs(String... cidrs)

cidrs

public SubnetFilterBuilder cidrs(Iterable<String> cidrs)

anyCidr

public SubnetFilterBuilder anyCidr()

state

public SubnetFilterBuilder state(String state)

states

public SubnetFilterBuilder states(String... states)

states

public SubnetFilterBuilder states(Iterable<String> states)

anyState

public SubnetFilterBuilder anyState()

available

public SubnetFilterBuilder available()

pending

public SubnetFilterBuilder pending()

subnetId

public SubnetFilterBuilder subnetId(String subnetId)

subnetIds

public SubnetFilterBuilder subnetIds(String... subnetIds)

subnetIds

public SubnetFilterBuilder subnetIds(Iterable<String> subnetIds)

anySubnetId

public SubnetFilterBuilder anySubnetId()

tagKey

public SubnetFilterBuilder tagKey(String tagKey)

tagKeys

public SubnetFilterBuilder tagKeys(String... tagKeys)

tagKeys

public SubnetFilterBuilder tagKeys(Iterable<String> tagKeys)

anyTagKey

public SubnetFilterBuilder anyTagKey()

tagValue

public SubnetFilterBuilder tagValue(String tagValue)

tagValues

public SubnetFilterBuilder tagValues(String... tagValues)

tagValues

public SubnetFilterBuilder tagValues(Iterable<String> tagValues)

anyTagValue

public SubnetFilterBuilder anyTagValue()

vpcId

public SubnetFilterBuilder vpcId(String vpcId)

vpcIds

public SubnetFilterBuilder vpcIds(String... vpcIds)

vpcIds

public SubnetFilterBuilder vpcIds(Iterable<String> vpcIds)

anyVpcId

public SubnetFilterBuilder anyVpcId()

arbitraryTag

public SubnetFilterBuilder arbitraryTag(String arbitraryTagKey,
                               String arbitraryTagValue)

arbitraryTag

public SubnetFilterBuilder arbitraryTag(String arbitraryTagKey,
                               String... arbitraryTagValues)

arbitraryTag

public SubnetFilterBuilder arbitraryTag(String arbitraryTagKey,
                               Iterable<String> arbitraryTagValues)

put

public SubnetFilterBuilder put(String key,
                      String value)

Overrides:

put in class com.google.common.collect.ImmutableMultimap.Builder<String,String>

put

public SubnetFilterBuilder put(Map.Entry<? extends String,? extends String> entry)

Overrides:

put in class com.google.common.collect.ImmutableMultimap.Builder<String,String>

putAll

public SubnetFilterBuilder putAll(String key,
                         Iterable<? extends String> values)

Overrides:

putAll in class com.google.common.collect.ImmutableMultimap.Builder<String,String>

putAll

public SubnetFilterBuilder putAll(String key,
                         String... values)

Overrides:

putAll in class com.google.common.collect.ImmutableMultimap.Builder<String,String>

putAll

public SubnetFilterBuilder putAll(com.google.common.collect.Multimap<? extends String,? extends String> multimap)

Overrides:

putAll in class com.google.common.collect.ImmutableMultimap.Builder<String,String>

orderKeysBy

@Beta
public SubnetFilterBuilder orderKeysBy(Comparator<? super String> keyComparator)

Overrides:

orderKeysBy in class com.google.common.collect.ImmutableMultimap.Builder<String,String>

orderValuesBy

@Beta
public SubnetFilterBuilder orderValuesBy(Comparator<? super String> valueComparator)

Overrides:

orderValuesBy in class com.google.common.collect.ImmutableMultimap.Builder<String,String>