Package software.amazon.awssdk.services.ec2.model

Interface DescribeVolumeStatusRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeVolumeStatusRequest.Builder,DescribeVolumeStatusRequest>, SdkBuilder<DescribeVolumeStatusRequest.Builder,DescribeVolumeStatusRequest>

Enclosing class:

DescribeVolumeStatusRequest

public static interface DescribeVolumeStatusRequest.Builder
extends CopyableBuilder<DescribeVolumeStatusRequest.Builder,DescribeVolumeStatusRequest>

Method Summary

Modifier and Type	Method	Description
DescribeVolumeStatusRequest.Builder	filters(Collection<Filter> filters)	One or more filters.
DescribeVolumeStatusRequest.Builder	filters(Filter... filters)	One or more filters.
DescribeVolumeStatusRequest.Builder	maxResults(Integer maxResults)	The maximum number of volume results returned by DescribeVolumeStatus in paginated output.
DescribeVolumeStatusRequest.Builder	nextToken(String nextToken)	The NextToken value to include in a future DescribeVolumeStatus request.
DescribeVolumeStatusRequest.Builder	volumeIds(String... volumeIds)	One or more volume IDs.
DescribeVolumeStatusRequest.Builder	volumeIds(Collection<String> volumeIds)	One or more volume IDs.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

filters

DescribeVolumeStatusRequest.Builder filters(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.

filters

DescribeVolumeStatusRequest.Builder filters(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.

maxResults

DescribeVolumeStatusRequest.Builder maxResults(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.

nextToken

DescribeVolumeStatusRequest.Builder nextToken(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.

volumeIds

DescribeVolumeStatusRequest.Builder volumeIds(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.

volumeIds

DescribeVolumeStatusRequest.Builder volumeIds(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.