com.amazonaws.services.ec2.model

Class DescribeDhcpOptionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeDhcpOptionsRequest

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<DescribeDhcpOptionsRequest>, Serializable, Cloneable

public class DescribeDhcpOptionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeDhcpOptionsRequest>

Container for the parameters to the DescribeDhcpOptions operation.

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide .

See Also:

AmazonEC2.describeDhcpOptions(DescribeDhcpOptionsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeDhcpOptionsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeDhcpOptionsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getDhcpOptionsIds() The IDs of one or more DHCP options sets.
Request<DescribeDhcpOptionsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() One or more filters.
int	hashCode()
void	setDhcpOptionsIds(Collection<String> dhcpOptionsIds) The IDs of one or more DHCP options sets.
void	setFilters(Collection<Filter> filters) One or more filters.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeDhcpOptionsRequest	withDhcpOptionsIds(Collection<String> dhcpOptionsIds) The IDs of one or more DHCP options sets.
DescribeDhcpOptionsRequest	withDhcpOptionsIds(String... dhcpOptionsIds) The IDs of one or more DHCP options sets.
DescribeDhcpOptionsRequest	withFilters(Collection<Filter> filters) One or more filters.
DescribeDhcpOptionsRequest	withFilters(Filter... filters) One or more filters.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeDhcpOptionsRequest

public DescribeDhcpOptionsRequest()

Method Detail

getDhcpOptionsIds

public List<String> getDhcpOptionsIds()

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Returns:

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

setDhcpOptionsIds

public void setDhcpOptionsIds(Collection<String> dhcpOptionsIds)

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Parameters:

dhcpOptionsIds - The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

withDhcpOptionsIds

public DescribeDhcpOptionsRequest withDhcpOptionsIds(String... dhcpOptionsIds)

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

NOTE: This method appends the values to the existing list (if any). Use setDhcpOptionsIds(java.util.Collection) or withDhcpOptionsIds(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dhcpOptionsIds - The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Returns:

A reference to this updated object so that method calls can be chained together.

withDhcpOptionsIds

public DescribeDhcpOptionsRequest withDhcpOptionsIds(Collection<String> dhcpOptionsIds)

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dhcpOptionsIds - The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public List<Filter> getFilters()

One or more filters.

• dhcp-options-id - The ID of a set of DHCP options.

• key - The key for one of the options (for example, domain-name).

• value - The value for one of the options.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Returns:

One or more filters.

• dhcp-options-id - The ID of a set of DHCP options.

• key - The key for one of the options (for example, domain-name).

• value - The value for one of the options.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

setFilters

public void setFilters(Collection<Filter> filters)

One or more filters.

• dhcp-options-id - The ID of a set of DHCP options.

• key - The key for one of the options (for example, domain-name).

• value - The value for one of the options.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Parameters:

filters - One or more filters.

• dhcp-options-id - The ID of a set of DHCP options.

• key - The key for one of the options (for example, domain-name).

• value - The value for one of the options.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

withFilters

public DescribeDhcpOptionsRequest withFilters(Filter... filters)

One or more filters.

• dhcp-options-id - The ID of a set of DHCP options.

• key - The key for one of the options (for example, domain-name).

• value - The value for one of the options.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - One or more filters.

• dhcp-options-id - The ID of a set of DHCP options.

• key - The key for one of the options (for example, domain-name).

• value - The value for one of the options.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeDhcpOptionsRequest withFilters(Collection<Filter> filters)

One or more filters.

• dhcp-options-id - The ID of a set of DHCP options.

• key - The key for one of the options (for example, domain-name).

• value - The value for one of the options.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - One or more filters.

• dhcp-options-id - The ID of a set of DHCP options.

• key - The key for one of the options (for example, domain-name).

• value - The value for one of the options.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Returns:

A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<DescribeDhcpOptionsRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeDhcpOptionsRequest>

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeDhcpOptionsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()