com.amazonaws.services.ec2.model.DescribeVolumeStatusRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2010-2016 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;
/**
*
* Contains the parameters for DescribeVolumeStatus.
*
*/
public class DescribeVolumeStatusRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* One or more volume IDs.
*
*
* Default: Describes all your volumes.
*
*/
private com.amazonaws.internal.SdkInternalList 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.SdkInternalList filters;
/**
*
* 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.
*
*/
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.
*
*
* 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.SdkInternalList();
}
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;
}
this.volumeIds = new com.amazonaws.internal.SdkInternalList(
volumeIds);
}
/**
*
* One or more volume IDs.
*
*
* Default: Describes all your volumes.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setVolumeIds(java.util.Collection)} or
* {@link #withVolumeIds(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param volumeIds
* One or more volume IDs.
*
* Default: Describes all your volumes.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeVolumeStatusRequest withVolumeIds(String... volumeIds) {
if (this.volumeIds == null) {
setVolumeIds(new com.amazonaws.internal.SdkInternalList(
volumeIds.length));
}
for (String ele : volumeIds) {
this.volumeIds.add(ele);
}
return this;
}
/**
*
* One or more volume IDs.
*
*
* Default: Describes all your volumes.
*
*
* @param volumeIds
* One or more volume IDs.
*
* Default: Describes all your volumes.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeVolumeStatusRequest withVolumeIds(
java.util.Collection volumeIds) {
setVolumeIds(volumeIds);
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.SdkInternalList();
}
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;
}
this.filters = new com.amazonaws.internal.SdkInternalList(
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 {@link #setFilters(java.util.Collection)} or
* {@link #withFilters(java.util.Collection)} if you want to override the
* existing values.
*
*
* @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 Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeVolumeStatusRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(
filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
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).
*
*
*
*
* @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 Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeVolumeStatusRequest withFilters(
java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* 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.
*
*
* @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 this.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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeVolumeStatusRequest withNextToken(String nextToken) {
setNextToken(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.
*
*
* @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.
*
*
* @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 this.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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeVolumeStatusRequest withMaxResults(Integer maxResults) {
setMaxResults(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 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;
}
@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 DescribeVolumeStatusRequest clone() {
return (DescribeVolumeStatusRequest) super.clone();
}
}