software.amazon.awssdk.services.ec2.model

Interface DescribeVolumeStatusRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeVolumeStatusRequest.Builder,DescribeVolumeStatusRequest>, Ec2Request.Builder, SdkBuilder<DescribeVolumeStatusRequest.Builder,DescribeVolumeStatusRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeVolumeStatusRequest

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

Method Summary

Modifier and Type	Method and Description
DescribeVolumeStatusRequest.Builder	filters(Collection<Filter> filters) The filters.
DescribeVolumeStatusRequest.Builder	filters(Consumer<Filter.Builder>... filters) The filters.
DescribeVolumeStatusRequest.Builder	filters(Filter... filters) The 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	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeVolumeStatusRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeVolumeStatusRequest.Builder	volumeIds(Collection<String> volumeIds) The IDs of the volumes.
DescribeVolumeStatusRequest.Builder	volumeIds(String... volumeIds) The IDs of the volumes.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

filters

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

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 (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 - 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 (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(Consumer<Filter.Builder>... 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 (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).

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#filters(List)

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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 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)

The IDs of the volumes.

Default: Describes all your volumes.

Parameters:

volumeIds - The IDs of the volumes.

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)

The IDs of the volumes.

Default: Describes all your volumes.

Parameters:

volumeIds - The IDs of the volumes.

Default: Describes all your volumes.

Returns:

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

overrideConfiguration

DescribeVolumeStatusRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeVolumeStatusRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder