com.amazonaws.services.ec2.model.DescribeVolumeStatusRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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, DryRunSupportedRequest {
/**
* One or more volume IDs. Default: Describes all your volumes.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag volumeIds;
/**
* 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).
*/
private com.amazonaws.internal.ListWithAutoConstructFlag filters;
/**
* The next paginated set of results to return using the pagination token
* returned by a previous call.
*/
private String nextToken;
/**
* The maximum number of paginated volume items per response.
*/
private Integer maxResults;
/**
* One or more volume IDs. Default: Describes all your volumes.
*
* @return One or more volume IDs.
Default: Describes all your volumes.
*/
public java.util.List getVolumeIds() {
if (volumeIds == null) {
volumeIds = new com.amazonaws.internal.ListWithAutoConstructFlag();
volumeIds.setAutoConstruct(true);
}
return volumeIds;
}
/**
* One or more volume IDs. Default: Describes all your volumes.
*
* @param volumeIds One or more volume IDs.
Default: Describes all your volumes.
*/
public void setVolumeIds(java.util.Collection volumeIds) {
if (volumeIds == null) {
this.volumeIds = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag volumeIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(volumeIds.size());
volumeIdsCopy.addAll(volumeIds);
this.volumeIds = volumeIdsCopy;
}
/**
* One or more volume IDs. 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(volumeIds.length));
for (String value : volumeIds) {
getVolumeIds().add(value);
}
return this;
}
/**
* One or more volume IDs. 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 volumeIds) {
if (volumeIds == null) {
this.volumeIds = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag volumeIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(volumeIds.size());
volumeIdsCopy.addAll(volumeIds);
this.volumeIds = volumeIdsCopy;
}
return this;
}
/**
* 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).
*
* @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.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.ListWithAutoConstructFlag();
filters.setAutoConstruct(true);
}
return 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).
*
* @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.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
/**
* 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 a reference to this object so that method calls can be chained together.
*
* @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).
*
* @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.ArrayList(filters.length));
for (Filter value : filters) {
getFilters().add(value);
}
return this;
}
/**
* 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 a reference to this object so that method calls can be chained together.
*
* @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).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeVolumeStatusRequest withFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
return this;
}
/**
* The next paginated set of results to return using the pagination token
* returned by a previous call.
*
* @return The next paginated set of results to return using the pagination token
* returned by a previous call.
*/
public String getNextToken() {
return nextToken;
}
/**
* The next paginated set of results to return using the pagination token
* returned by a previous call.
*
* @param nextToken The next paginated set of results to return using the pagination token
* returned by a previous call.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
* The next paginated set of results to return using the pagination token
* returned by a previous call.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param nextToken The next paginated set of results to return using the pagination token
* returned by a previous call.
*
* @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 paginated volume items per response.
*
* @return The maximum number of paginated volume items per response.
*/
public Integer getMaxResults() {
return maxResults;
}
/**
* The maximum number of paginated volume items per response.
*
* @param maxResults The maximum number of paginated volume items per response.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
* The maximum number of paginated volume items per response.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param maxResults The maximum number of paginated volume items per response.
*
* @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 getDryRunRequest() {
Request request = new DescribeVolumeStatusRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getVolumeIds() != null) sb.append("VolumeIds: " + getVolumeIds() + ",");
if (getFilters() != null) sb.append("Filters: " + getFilters() + ",");
if (getNextToken() != null) sb.append("NextToken: " + getNextToken() + ",");
if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVolumeIds() == null) ? 0 : getVolumeIds().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeVolumeStatusRequest == false) return false;
DescribeVolumeStatusRequest other = (DescribeVolumeStatusRequest)obj;
if (other.getVolumeIds() == null ^ this.getVolumeIds() == null) return false;
if (other.getVolumeIds() != null && other.getVolumeIds().equals(this.getVolumeIds()) == false) return false;
if (other.getFilters() == null ^ this.getFilters() == null) return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false;
if (other.getNextToken() == null ^ this.getNextToken() == null) return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false;
return true;
}
}