DescribeDhcpOptionsRequest (AWS Java SDK for Amazon EC2 1.12.128 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.DescribeDhcpOptionsRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribeDhcpOptionsRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDhcpOptionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeDhcpOptionsRequest>

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

DescribeDhcpOptionsRequest()

Constructors
Constructor and Description
`DescribeDhcpOptionsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeDhcpOptionsRequest`	`clone()`
`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.
`Integer`	`getMaxResults()` The maximum number of results to return with a single call.
`String`	`getNextToken()` The token for the next page of results.
`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.
`void`	`setMaxResults(Integer maxResults)` The maximum number of results to return with a single call.
`void`	`setNextToken(String nextToken)` The token for the next page of results.
`String`	`toString()` Returns a string representation of this object.
`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.
`DescribeDhcpOptionsRequest`	`withMaxResults(Integer maxResults)` The maximum number of results to return with a single call.
`DescribeDhcpOptionsRequest`	`withNextToken(String nextToken)` The token for the next page of results.

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.
    
    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 DHCP options set.
    - key - The key for one of the options (for example, domain-name).
    - value - The value for one of the options.
    - owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
    - tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    - tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    Returns:
    One or more filters.
    
    dhcp-options-id - The ID of a DHCP options set.
    
    key - The key for one of the options (for example, domain-name).
    
    value - The value for one of the options.
    
    owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
    
    tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    
    tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
  - setFilters
```
public void setFilters(Collection<Filter> filters)
```
    One or more filters.
    - dhcp-options-id - The ID of a DHCP options set.
    - key - The key for one of the options (for example, domain-name).
    - value - The value for one of the options.
    - owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
    - tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    - tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    Parameters:
    filters - One or more filters.
    
    dhcp-options-id - The ID of a DHCP options set.
    
    key - The key for one of the options (for example, domain-name).
    
    value - The value for one of the options.
    
    owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
    
    tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    
    tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
  - withFilters
```
public DescribeDhcpOptionsRequest withFilters(Filter... filters)
```
    One or more filters.
    - dhcp-options-id - The ID of a DHCP options set.
    - key - The key for one of the options (for example, domain-name).
    - value - The value for one of the options.
    - owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
    - tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    - tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    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 DHCP options set.
    
    key - The key for one of the options (for example, domain-name).
    
    value - The value for one of the options.
    
    owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
    
    tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    
    tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    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 DHCP options set.
    - key - The key for one of the options (for example, domain-name).
    - value - The value for one of the options.
    - owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
    - tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    - tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    Parameters:
    filters - One or more filters.
    
    dhcp-options-id - The ID of a DHCP options set.
    
    key - The key for one of the options (for example, domain-name).
    
    value - The value for one of the options.
    
    owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
    
    tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    
    tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNextToken
```
public void setNextToken(String nextToken)
```
    The token for the next page of results.
    
    Parameters:
    
    nextToken - The token for the next page of results.
  - getNextToken
```
public String getNextToken()
```
    The token for the next page of results.
    
    Returns:
    
    The token for the next page of results.
  - withNextToken
```
public DescribeDhcpOptionsRequest withNextToken(String nextToken)
```
    The token for the next page of results.
    
    Parameters:
    
    nextToken - The token for the next page of results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
    
    Parameters:
    
    maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
    
    Returns:
    
    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  - withMaxResults
```
public DescribeDhcpOptionsRequest withMaxResults(Integer maxResults)
```
    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
    
    Parameters:
    
    maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeDhcpOptionsRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class DescribeDhcpOptionsRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeDhcpOptionsRequest

Method Detail

getDhcpOptionsIds

setDhcpOptionsIds

withDhcpOptionsIds

withDhcpOptionsIds

getFilters

setFilters

withFilters

withFilters

setNextToken

getNextToken

withNextToken

setMaxResults

getMaxResults

withMaxResults

getDryRunRequest

toString

equals

hashCode

clone