Cloneable
, ReadLimitInfo
, ToCopyableBuilder<DescribeVolumeStatusRequest.Builder,DescribeVolumeStatusRequest>
@Generated("software.amazon.awssdk:codegen") public class DescribeVolumeStatusRequest extends AmazonWebServiceRequest implements ToCopyableBuilder<DescribeVolumeStatusRequest.Builder,DescribeVolumeStatusRequest>
Contains the parameters for DescribeVolumeStatus.
Modifier and Type | Class | Description |
---|---|---|
static interface |
DescribeVolumeStatusRequest.Builder |
NOOP
Modifier and Type | Method | Description |
---|---|---|
static DescribeVolumeStatusRequest.Builder |
builder() |
|
boolean |
equals(Object obj) |
|
List<Filter> |
filters() |
One or more filters.
|
int |
hashCode() |
|
Integer |
maxResults() |
The maximum number of volume results returned by
DescribeVolumeStatus in paginated output. |
String |
nextToken() |
The
NextToken value to include in a future DescribeVolumeStatus request. |
static Class<? extends DescribeVolumeStatusRequest.Builder> |
serializableBuilderClass() |
|
DescribeVolumeStatusRequest.Builder |
toBuilder() |
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
|
List<String> |
volumeIds() |
One or more volume IDs.
|
clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout
public List<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
).
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
).
public 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.
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.public 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.
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.public List<String> volumeIds()
One or more volume IDs.
Default: Describes all your volumes.
Default: Describes all your volumes.
public DescribeVolumeStatusRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeVolumeStatusRequest.Builder,DescribeVolumeStatusRequest>
public static DescribeVolumeStatusRequest.Builder builder()
public static Class<? extends DescribeVolumeStatusRequest.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.