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>

Contains the parameters for DescribeDhcpOptions.

See Also:
  • Constructor Details

    • DescribeDhcpOptionsRequest

      public DescribeDhcpOptionsRequest()
  • Method Details

    • 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.

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

      Default: Describes all your DHCP options sets.

      Returns:
      Returns a reference to this 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.

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

      Default: Describes all your DHCP options sets.

      Returns:
      Returns a reference to this 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.

      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:
      Returns a reference to this 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.

      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:
      Returns a reference to this 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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: