com.amazonaws.services.ec2.model

Class DescribeHostReservationsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeHostReservationsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribeHostReservationsRequest>, Serializable, Cloneable

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeHostReservationsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeHostReservationsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Request<DescribeHostReservationsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilter() One or more filters.
List<String>	getHostReservationIdSet() One or more host reservation IDs.
Integer	getMaxResults() The maximum number of results to return for the request in a single page.
String	getNextToken() The token to use to retrieve the next page of results.
int	hashCode()
void	setFilter(Collection<Filter> filter) One or more filters.
void	setHostReservationIdSet(Collection<String> hostReservationIdSet) One or more host reservation IDs.
void	setMaxResults(Integer maxResults) The maximum number of results to return for the request in a single page.
void	setNextToken(String nextToken) The token to use to retrieve the next page of results.
String	toString() Returns a string representation of this object.
DescribeHostReservationsRequest	withFilter(Collection<Filter> filter) One or more filters.
DescribeHostReservationsRequest	withFilter(Filter... filter) One or more filters.
DescribeHostReservationsRequest	withHostReservationIdSet(Collection<String> hostReservationIdSet) One or more host reservation IDs.
DescribeHostReservationsRequest	withHostReservationIdSet(String... hostReservationIdSet) One or more host reservation IDs.
DescribeHostReservationsRequest	withMaxResults(Integer maxResults) The maximum number of results to return for the request in a single page.
DescribeHostReservationsRequest	withNextToken(String nextToken) The token to use to retrieve the next page of results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeHostReservationsRequest

public DescribeHostReservationsRequest()

Method Detail

getFilter

public List<Filter> getFilter()

One or more filters.

• instance-family - The instance family (for example, m4).

• payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

• state - The state of the reservation (payment-pending | payment-failed | active | retired).

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

• instance-family - The instance family (for example, m4).

• payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

• state - The state of the reservation (payment-pending | payment-failed | active | retired).

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

setFilter

public void setFilter(Collection<Filter> filter)

One or more filters.

• instance-family - The instance family (for example, m4).

• payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

• state - The state of the reservation (payment-pending | payment-failed | active | retired).

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

filter - One or more filters.

• instance-family - The instance family (for example, m4).

• payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

• state - The state of the reservation (payment-pending | payment-failed | active | retired).

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

withFilter

public DescribeHostReservationsRequest withFilter(Filter... filter)

One or more filters.

• instance-family - The instance family (for example, m4).

• payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

• state - The state of the reservation (payment-pending | payment-failed | active | retired).

• 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 setFilter(java.util.Collection) or withFilter(java.util.Collection) if you want to override the existing values.

Parameters:

filter - One or more filters.

• instance-family - The instance family (for example, m4).

• payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

• state - The state of the reservation (payment-pending | payment-failed | active | retired).

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

withFilter

public DescribeHostReservationsRequest withFilter(Collection<Filter> filter)

One or more filters.

• instance-family - The instance family (for example, m4).

• payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

• state - The state of the reservation (payment-pending | payment-failed | active | retired).

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

filter - One or more filters.

• instance-family - The instance family (for example, m4).

• payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

• state - The state of the reservation (payment-pending | payment-failed | active | retired).

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

getHostReservationIdSet

public List<String> getHostReservationIdSet()

One or more host reservation IDs.

Returns:

One or more host reservation IDs.

setHostReservationIdSet

public void setHostReservationIdSet(Collection<String> hostReservationIdSet)

One or more host reservation IDs.

Parameters:

hostReservationIdSet - One or more host reservation IDs.

withHostReservationIdSet

public DescribeHostReservationsRequest withHostReservationIdSet(String... hostReservationIdSet)

One or more host reservation IDs.

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

Parameters:

hostReservationIdSet - One or more host reservation IDs.

Returns:

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

withHostReservationIdSet

public DescribeHostReservationsRequest withHostReservationIdSet(Collection<String> hostReservationIdSet)

One or more host reservation IDs.

Parameters:

hostReservationIdSet - One or more host reservation IDs.

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 for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

Parameters:

maxResults - The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

Returns:

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

withMaxResults

public DescribeHostReservationsRequest withMaxResults(Integer maxResults)

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

Parameters:

maxResults - The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The token to use to retrieve the next page of results.

Parameters:

nextToken - The token to use to retrieve the next page of results.

getNextToken

public String getNextToken()

The token to use to retrieve the next page of results.

Returns:

The token to use to retrieve the next page of results.

withNextToken

public DescribeHostReservationsRequest withNextToken(String nextToken)

The token to use to retrieve the next page of results.

Parameters:

nextToken - The token to use to retrieve the next page of results.

Returns:

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

getDryRunRequest

public Request<DescribeHostReservationsRequest> 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<DescribeHostReservationsRequest>

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 DescribeHostReservationsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()