Package com.amazonaws.services.ec2.model

Class DescribeVolumeStatusRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeVolumeStatusRequest

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<DescribeVolumeStatusRequest>, Serializable, Cloneable

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

Contains the parameters for DescribeVolumeStatus.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
DescribeVolumeStatusRequest()

Method Summary

Modifier and Type	Method	Description
DescribeVolumeStatusRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
Request<DescribeVolumeStatusRequest>	getDryRunRequest()	This method is intended for internal use only.
List<Filter>	getFilters()	One or more filters.
Integer	getMaxResults()	The maximum number of volume results returned by DescribeVolumeStatus in paginated output.
String	getNextToken()	The NextToken value to include in a future DescribeVolumeStatus request.
List<String>	getVolumeIds()	One or more volume IDs.
int	hashCode()
void	setFilters(Collection<Filter> filters)	One or more filters.
void	setMaxResults(Integer maxResults)	The maximum number of volume results returned by DescribeVolumeStatus in paginated output.
void	setNextToken(String nextToken)	The NextToken value to include in a future DescribeVolumeStatus request.
void	setVolumeIds(Collection<String> volumeIds)	One or more volume IDs.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
DescribeVolumeStatusRequest	withFilters(Filter... filters)	One or more filters.
DescribeVolumeStatusRequest	withFilters(Collection<Filter> filters)	One or more filters.
DescribeVolumeStatusRequest	withMaxResults(Integer maxResults)	The maximum number of volume results returned by DescribeVolumeStatus in paginated output.
DescribeVolumeStatusRequest	withNextToken(String nextToken)	The NextToken value to include in a future DescribeVolumeStatus request.
DescribeVolumeStatusRequest	withVolumeIds(String... volumeIds)	One or more volume IDs.
DescribeVolumeStatusRequest	withVolumeIds(Collection<String> volumeIds)	One or more volume IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeVolumeStatusRequest

public DescribeVolumeStatusRequest()

Method Detail

getVolumeIds

public List<String> getVolumeIds()

One or more volume IDs.

Default: Describes all your volumes.

Returns:

One or more volume IDs.

Default: Describes all your volumes.

setVolumeIds

public void setVolumeIds(Collection<String> volumeIds)

One or more volume IDs.

Default: Describes all your volumes.

Parameters:

volumeIds - One or more volume IDs.

Default: Describes all your volumes.

withVolumeIds

public DescribeVolumeStatusRequest withVolumeIds(String... volumeIds)

One or more volume IDs.

Default: Describes all your volumes.

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

Parameters:

volumeIds - One or more volume IDs.

Default: Describes all your volumes.

Returns:

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

withVolumeIds

public DescribeVolumeStatusRequest withVolumeIds(Collection<String> volumeIds)

One or more volume IDs.

Default: Describes all your volumes.

Parameters:

volumeIds - One or more volume IDs.

Default: Describes all your volumes.

Returns:

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

getFilters

public List<Filter> getFilters()

One or more filters.

• action.code - The action code for the event (for example, enable-volume-io).

• action.description - A description of the action.

• action.event-id - The event ID associated with the action.

• availability-zone - The Availability Zone of the instance.

• event.description - A description of the event.

• event.event-id - The event ID.

• event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

• event.not-after - The latest end time for the event.

• event.not-before - The earliest start time for the event.

• volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

• volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

• volume-status.status - The status of the volume ( ok | impaired | warning | insufficient-data).

Returns:

One or more filters.

• action.code - The action code for the event (for example, enable-volume-io).

• action.description - A description of the action.

• action.event-id - The event ID associated with the action.

• availability-zone - The Availability Zone of the instance.

• event.description - A description of the event.

• event.event-id - The event ID.

• event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

• event.not-after - The latest end time for the event.

• event.not-before - The earliest start time for the event.

• volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

• volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

• volume-status.status - The status of the volume ( ok | impaired | warning | insufficient-data).

setFilters

public void setFilters(Collection<Filter> filters)

One or more filters.

• action.code - The action code for the event (for example, enable-volume-io).

• action.description - A description of the action.

• action.event-id - The event ID associated with the action.

• availability-zone - The Availability Zone of the instance.

• event.description - A description of the event.

• event.event-id - The event ID.

• event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

• event.not-after - The latest end time for the event.

• event.not-before - The earliest start time for the event.

• volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

• volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

• volume-status.status - The status of the volume ( ok | impaired | warning | insufficient-data).

Parameters:

filters - One or more filters.

• action.code - The action code for the event (for example, enable-volume-io).

• action.description - A description of the action.

• action.event-id - The event ID associated with the action.

• availability-zone - The Availability Zone of the instance.

• event.description - A description of the event.

• event.event-id - The event ID.

• event.event-type - The event type (for io-enabled: passed | failed ; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

• event.not-after - The latest end time for the event.

• event.not-before - The earliest start time for the event.

• volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

• volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed ; for io-performance: normal | degraded | severely-degraded | stalled).

• volume-status.status - The status of the volume ( ok | impaired | warning | insufficient-data).

withFilters

public DescribeVolumeStatusRequest withFilters(Filter... filters)

One or more filters.

• action.code - The action code for the event (for example, enable-volume-io).

• action.description - A description of the action.

• action.event-id - The event ID associated with the action.

• availability-zone - The Availability Zone of the instance.

• event.description - A description of the event.

• event.event-id - The event ID.

• event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

• event.not-after - The latest end time for the event.

• event.not-before - The earliest start time for the event.

• volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

• volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

• volume-status.status - The status of the volume ( ok | impaired | warning | insufficient-data).

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.

• action.code - The action code for the event (for example, enable-volume-io).

• action.description - A description of the action.

• action.event-id - The event ID associated with the action.

• availability-zone - The Availability Zone of the instance.

• event.description - A description of the event.

• event.event-id - The event ID.

• event.event-type - The event type (for io-enabled: passed | failed ; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

• event.not-after - The latest end time for the event.

• event.not-before - The earliest start time for the event.

• volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

• volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed ; for io-performance: normal | degraded | severely-degraded | stalled).

• volume-status.status - The status of the volume ( ok | impaired | warning | insufficient-data).

Returns:

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

withFilters

public DescribeVolumeStatusRequest withFilters(Collection<Filter> filters)

One or more filters.

• action.code - The action code for the event (for example, enable-volume-io).

• action.description - A description of the action.

• action.event-id - The event ID associated with the action.

• availability-zone - The Availability Zone of the instance.

• event.description - A description of the event.

• event.event-id - The event ID.

• event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

• event.not-after - The latest end time for the event.

• event.not-before - The earliest start time for the event.

• volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

• volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

• volume-status.status - The status of the volume ( ok | impaired | warning | insufficient-data).

Parameters:

filters - One or more filters.

• action.code - The action code for the event (for example, enable-volume-io).

• action.description - A description of the action.

• action.event-id - The event ID associated with the action.

• availability-zone - The Availability Zone of the instance.

• event.description - A description of the event.

• event.event-id - The event ID.

• event.event-type - The event type (for io-enabled: passed | failed ; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

• event.not-after - The latest end time for the event.

• event.not-before - The earliest start time for the event.

• volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

• volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed ; for io-performance: normal | degraded | severely-degraded | stalled).

• volume-status.status - The status of the volume ( ok | impaired | warning | insufficient-data).

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Parameters:

nextToken - The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

getNextToken

public String getNextToken()

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

withNextToken

public DescribeVolumeStatusRequest withNextToken(String nextToken)

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Parameters:

nextToken - The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

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 volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

Parameters:

maxResults - The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

getMaxResults

public Integer getMaxResults()

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

Returns:

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

withMaxResults

public DescribeVolumeStatusRequest withMaxResults(Integer maxResults)

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

Parameters:

maxResults - The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

Returns:

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

getDryRunRequest

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

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeVolumeStatusRequest 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()