Class DescribeVolumeStatusRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.DescribeVolumeStatusRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeVolumeStatusRequest.Builder,DescribeVolumeStatusRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeVolumeStatusRequest extends Ec2Request implements ToCopyableBuilder<DescribeVolumeStatusRequest.Builder,DescribeVolumeStatusRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeVolumeStatusRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeVolumeStatusRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<Filter>
filters()
The filters.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
boolean
hasVolumeIds()
For responses, this returns true if the service returned a value for the VolumeIds property.Integer
maxResults()
The maximum number of items to return for this request.String
nextToken()
The token returned from a previous paginated request.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeVolumeStatusRequest.Builder>
serializableBuilderClass()
DescribeVolumeStatusRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.List<String>
volumeIds()
The IDs of the volumes.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
filters
public final List<Filter> filters()
The 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 (forio-enabled
:passed
|failed
; forio-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 forvolume-status.status
(io-enabled
|io-performance
). -
volume-status.details-status
- The status ofvolume-status.details-name
(forio-enabled
:passed
|failed
; forio-performance
:normal
|degraded
|severely-degraded
|stalled
). -
volume-status.status
- The status of the volume (ok
|impaired
|warning
|insufficient-data
).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFilters()
method.- Returns:
- The 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 (forio-enabled
:passed
|failed
; forio-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 forvolume-status.status
(io-enabled
|io-performance
). -
volume-status.details-status
- The status ofvolume-status.details-name
(forio-enabled
:passed
|failed
; forio-performance
:normal
|degraded
|severely-degraded
|stalled
). -
volume-status.status
- The status of the volume (ok
|impaired
|warning
|insufficient-data
).
-
-
-
maxResults
public final Integer maxResults()
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1,000; if the value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.
- Returns:
- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1,000; if the value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.
-
nextToken
public final String nextToken()
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- Returns:
- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
-
hasVolumeIds
public final boolean hasVolumeIds()
For responses, this returns true if the service returned a value for the VolumeIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
volumeIds
public final List<String> volumeIds()
The IDs of the volumes.
Default: Describes all your volumes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasVolumeIds()
method.- Returns:
- The IDs of the volumes.
Default: Describes all your volumes.
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
toBuilder
public DescribeVolumeStatusRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeVolumeStatusRequest.Builder,DescribeVolumeStatusRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeVolumeStatusRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeVolumeStatusRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-