/* * Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.ec2.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; import com.amazonaws.Request; import com.amazonaws.services.ec2.model.transform.DescribeVolumeStatusRequestMarshaller; /** * Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeVolumeStatus(DescribeVolumeStatusRequest) DescribeVolumeStatus operation}. *
* Describes the status of the specified volumes. Volume status provides * the result of the checks performed on your volumes to determine events * that can impair the performance of your volumes. The performance of a * volume can be affected if an issue occurs on the volume's underlying * host. If the volume's underlying host experiences a power outage or * system issue, after the system is restored, there could be data * inconsistencies on the volume. Volume events notify you if this * occurs. Volume actions notify you if any action needs to be taken in * response to the event. *
*
* The DescribeVolumeStatus operation provides the following
* information about the specified volumes:
*
* Status : Reflects the current status of the volume. The
* possible values are ok ,
* impaired ,
* warning , or
* insufficient-data . If all checks pass, the overall
* status of the volume is ok . If the check fails, the
* overall status is impaired . If the status is
* insufficient-data , then the checks may still be taking
* place on your volume at the time. We recommend that you retry the
* request. For more information on volume status, see
* Monitoring the Status of Your Volumes
* .
*
* Events : Reflect the cause of a volume status and may require
* you to take action. For example, if your volume returns an
* impaired status, then the volume event might be
* potential-data-inconsistency . This means that your
* volume has been affected by an issue with the underlying host, has all
* I/O operations disabled, and may have inconsistent data.
*
* Actions : Reflect the actions you may have to take in response
* to an event. For example, if the status of the volume is
* impaired and the volume event shows
* potential-data-inconsistency , then the action shows
* enable-volume-io . This means that you may want to enable
* the I/O operations for the volume by calling the EnableVolumeIO action
* and then check the volume for data consistency.
*
* NOTE: Volume status is based on the volume status checks, and * does not reflect the volume state. Therefore, volume status does not * indicate volumes in the error state (for example, when a volume is * incapable of accepting I/O.) *
* * @see com.amazonaws.services.ec2.AmazonEC2#describeVolumeStatus(DescribeVolumeStatusRequest) */ public class DescribeVolumeStatusRequest extends AmazonWebServiceRequest implements Serializable, DryRunSupportedRequestDefault: Describes all your volumes.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag Default: Describes all your volumes.
*
* @return One or more volume IDs. Default: Describes all your volumes.
*/
public java.util.List Default: Describes all your volumes.
*
* @param volumeIds One or more volume IDs. Default: Describes all your volumes.
*/
public void setVolumeIds(java.util.Collection Default: Describes all your volumes.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param volumeIds One or more volume IDs. Default: Describes all your volumes.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeVolumeStatusRequest withVolumeIds(String... volumeIds) {
if (getVolumeIds() == null) setVolumeIds(new java.util.ArrayList Default: Describes all your volumes.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param volumeIds One or more volume IDs. Default: Describes all your volumes.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeVolumeStatusRequest withVolumeIds(java.util.Collection
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
* Returns a reference to this object so that method calls can be chained together.
*
* @param nextToken The
* Returns a reference to this object so that method calls can be chained together.
*
* @param maxResults The maximum number of volume results returned by
*
*/
private com.amazonaws.internal.ListWithAutoConstructFlagaction.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). 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.
*/
private String nextToken;
/**
* 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.
*/
private Integer maxResults;
/**
* One or more volume IDs.
*
* @return 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).
*/
public java.util.Listaction.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).
*
* @param 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).
*/
public void setFilters(java.util.Collectionaction.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).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeVolumeStatusRequest withFilters(Filter... filters) {
if (getFilters() == null) setFilters(new java.util.ArrayListaction.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).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeVolumeStatusRequest withFilters(java.util.Collectionaction.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). 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.
*
* @return 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.
*/
public String getNextToken() {
return 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.
*
* @param 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.
*/
public void setNextToken(String nextToken) {
this.nextToken = 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeVolumeStatusRequest withNextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
/**
* 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.
*
* @return 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.
*/
public Integer getMaxResults() {
return 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.
*
* @param 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.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeVolumeStatusRequest withMaxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
/**
* This method is intended for internal use only.
* Returns the marshaled request configured with additional parameters to
* enable operation dry-run.
*/
@Override
public Request