com.amazonaws.services.ec2.model.DescribeVolumesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
* Copyright 2011-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.DescribeVolumesRequestMarshaller;
/**
*
* Contains the parameters for DescribeVolumes.
*
*/
public class DescribeVolumesRequest extends AmazonWebServiceRequest implements
Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* One or more volume IDs.
*
*/
private com.amazonaws.internal.SdkInternalList volumeIds;
/**
*
* One or more filters.
*
*
* -
*
* attachment.attach-time - The time stamp when the attachment
* initiated.
*
*
* -
*
* attachment.delete-on-termination - Whether the volume is
* deleted on instance termination.
*
*
* -
*
* attachment.device - The device name that is exposed to the
* instance (for example, /dev/sda1).
*
*
* -
*
* attachment.instance-id - The ID of the instance the volume
* is attached to.
*
*
* -
*
* attachment.status - The attachment state (
* attaching | attached | detaching |
* detached).
*
*
* -
*
* availability-zone - The Availability Zone in which the
* volume was created.
*
*
* -
*
* create-time - The time stamp when the volume was created.
*
*
* -
*
* encrypted - The encryption status of the volume.
*
*
* -
*
* size - The size of the volume, in GiB.
*
*
* -
*
* snapshot-id - The snapshot from which the volume was
* created.
*
*
* -
*
* status - The status of the volume (creating |
* available | in-use | deleting |
* deleted | error).
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* volume-id - The volume ID.
*
*
* -
*
* volume-type - The Amazon EBS volume type. This can be
* gp2 for General Purpose SSD, io1 for
* Provisioned IOPS SSD, st1 for Throughput Optimized HDD,
* sc1 for Cold HDD, or standard for Magnetic
* volumes.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The NextToken value returned from a previous paginated
* DescribeVolumes request where MaxResults was
* used and the results exceeded the value of that parameter. Pagination
* continues from the end of the previous results that returned the
* NextToken value. This value is null when there
* are no more results to return.
*
*/
private String nextToken;
/**
*
* The maximum number of volume results returned by
* DescribeVolumes in paginated output. When this parameter is
* used, DescribeVolumes 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 DescribeVolumes 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
* DescribeVolumes returns all results. You cannot specify this
* parameter and the volume IDs parameter in the same request.
*
*/
private Integer maxResults;
/**
* Default constructor for DescribeVolumesRequest object. Callers should use
* the setter or fluent setter (with...) methods to initialize the object
* after creating it.
*/
public DescribeVolumesRequest() {
}
/**
* Constructs a new DescribeVolumesRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize any additional
* object members.
*
* @param volumeIds
* One or more volume IDs.
*/
public DescribeVolumesRequest(java.util.List volumeIds) {
setVolumeIds(volumeIds);
}
/**
*
* One or more volume IDs.
*
*
* @return One or more volume IDs.
*/
public java.util.List getVolumeIds() {
if (volumeIds == null) {
volumeIds = new com.amazonaws.internal.SdkInternalList();
}
return volumeIds;
}
/**
*
* One or more volume IDs.
*
*
* @param volumeIds
* One or more volume IDs.
*/
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.
*
*
* 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeVolumesRequest 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.
*
*
* @param volumeIds
* One or more volume IDs.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeVolumesRequest withVolumeIds(
java.util.Collection volumeIds) {
setVolumeIds(volumeIds);
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* attachment.attach-time - The time stamp when the attachment
* initiated.
*
*
* -
*
* attachment.delete-on-termination - Whether the volume is
* deleted on instance termination.
*
*
* -
*
* attachment.device - The device name that is exposed to the
* instance (for example, /dev/sda1).
*
*
* -
*
* attachment.instance-id - The ID of the instance the volume
* is attached to.
*
*
* -
*
* attachment.status - The attachment state (
* attaching | attached | detaching |
* detached).
*
*
* -
*
* availability-zone - The Availability Zone in which the
* volume was created.
*
*
* -
*
* create-time - The time stamp when the volume was created.
*
*
* -
*
* encrypted - The encryption status of the volume.
*
*
* -
*
* size - The size of the volume, in GiB.
*
*
* -
*
* snapshot-id - The snapshot from which the volume was
* created.
*
*
* -
*
* status - The status of the volume (creating |
* available | in-use | deleting |
* deleted | error).
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* volume-id - The volume ID.
*
*
* -
*
* volume-type - The Amazon EBS volume type. This can be
* gp2 for General Purpose SSD, io1 for
* Provisioned IOPS SSD, st1 for Throughput Optimized HDD,
* sc1 for Cold HDD, or standard for Magnetic
* volumes.
*
*
*
*
* @return One or more filters.
*
* -
*
* attachment.attach-time - The time stamp when the
* attachment initiated.
*
*
* -
*
* attachment.delete-on-termination - Whether the
* volume is deleted on instance termination.
*
*
* -
*
* attachment.device - The device name that is exposed
* to the instance (for example, /dev/sda1).
*
*
* -
*
* attachment.instance-id - The ID of the instance the
* volume is attached to.
*
*
* -
*
* attachment.status - The attachment state (
* attaching | attached |
* detaching | detached).
*
*
* -
*
* availability-zone - The Availability Zone in which
* the volume was created.
*
*
* -
*
* create-time - The time stamp when the volume was
* created.
*
*
* -
*
* encrypted - The encryption status of the volume.
*
*
* -
*
* size - The size of the volume, in GiB.
*
*
* -
*
* snapshot-id - The snapshot from which the volume was
* created.
*
*
* -
*
* status - The status of the volume (
* creating | available |
* in-use | deleting |
* deleted | error).
*
*
* -
*
* tag:key=value - The key/value
* combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter.
* For example, if you use both the filter "tag-key=Purpose" and the
* filter "tag-value=X", you get any resources assigned both the tag
* key Purpose (regardless of what the tag's value is), and the tag
* value X (regardless of what the tag's key is). If you want to
* list only resources where Purpose is X, see the tag
* :key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
*
* -
*
* volume-id - The volume ID.
*
*
* -
*
* volume-type - The Amazon EBS volume type. This can
* be gp2 for General Purpose SSD, io1 for
* Provisioned IOPS SSD, st1 for Throughput Optimized
* HDD, sc1 for Cold HDD, or standard for
* Magnetic volumes.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* One or more filters.
*
*
* -
*
* attachment.attach-time - The time stamp when the attachment
* initiated.
*
*
* -
*
* attachment.delete-on-termination - Whether the volume is
* deleted on instance termination.
*
*
* -
*
* attachment.device - The device name that is exposed to the
* instance (for example, /dev/sda1).
*
*
* -
*
* attachment.instance-id - The ID of the instance the volume
* is attached to.
*
*
* -
*
* attachment.status - The attachment state (
* attaching | attached | detaching |
* detached).
*
*
* -
*
* availability-zone - The Availability Zone in which the
* volume was created.
*
*
* -
*
* create-time - The time stamp when the volume was created.
*
*
* -
*
* encrypted - The encryption status of the volume.
*
*
* -
*
* size - The size of the volume, in GiB.
*
*
* -
*
* snapshot-id - The snapshot from which the volume was
* created.
*
*
* -
*
* status - The status of the volume (creating |
* available | in-use | deleting |
* deleted | error).
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* volume-id - The volume ID.
*
*
* -
*
* volume-type - The Amazon EBS volume type. This can be
* gp2 for General Purpose SSD, io1 for
* Provisioned IOPS SSD, st1 for Throughput Optimized HDD,
* sc1 for Cold HDD, or standard for Magnetic
* volumes.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* attachment.attach-time - The time stamp when the
* attachment initiated.
*
*
* -
*
* attachment.delete-on-termination - Whether the volume
* is deleted on instance termination.
*
*
* -
*
* attachment.device - The device name that is exposed
* to the instance (for example, /dev/sda1).
*
*
* -
*
* attachment.instance-id - The ID of the instance the
* volume is attached to.
*
*
* -
*
* attachment.status - The attachment state (
* attaching | attached |
* detaching | detached).
*
*
* -
*
* availability-zone - The Availability Zone in which
* the volume was created.
*
*
* -
*
* create-time - The time stamp when the volume was
* created.
*
*
* -
*
* encrypted - The encryption status of the volume.
*
*
* -
*
* size - The size of the volume, in GiB.
*
*
* -
*
* snapshot-id - The snapshot from which the volume was
* created.
*
*
* -
*
* status - The status of the volume (
* creating | available |
* in-use | deleting | deleted
* | error).
*
*
* -
*
* tag:key=value - The key/value
* combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter.
* For example, if you use both the filter "tag-key=Purpose" and the
* filter "tag-value=X", you get any resources assigned both the tag
* key Purpose (regardless of what the tag's value is), and the tag
* value X (regardless of what the tag's key is). If you want to list
* only resources where Purpose is X, see the tag
* :key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
*
* -
*
* volume-id - The volume ID.
*
*
* -
*
* volume-type - The Amazon EBS volume type. This can be
* gp2 for General Purpose SSD, io1 for
* Provisioned IOPS SSD, st1 for Throughput Optimized
* HDD, sc1 for Cold HDD, or standard for
* Magnetic volumes.
*
*
*/
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.
*
*
* -
*
* attachment.attach-time - The time stamp when the attachment
* initiated.
*
*
* -
*
* attachment.delete-on-termination - Whether the volume is
* deleted on instance termination.
*
*
* -
*
* attachment.device - The device name that is exposed to the
* instance (for example, /dev/sda1).
*
*
* -
*
* attachment.instance-id - The ID of the instance the volume
* is attached to.
*
*
* -
*
* attachment.status - The attachment state (
* attaching | attached | detaching |
* detached).
*
*
* -
*
* availability-zone - The Availability Zone in which the
* volume was created.
*
*
* -
*
* create-time - The time stamp when the volume was created.
*
*
* -
*
* encrypted - The encryption status of the volume.
*
*
* -
*
* size - The size of the volume, in GiB.
*
*
* -
*
* snapshot-id - The snapshot from which the volume was
* created.
*
*
* -
*
* status - The status of the volume (creating |
* available | in-use | deleting |
* deleted | error).
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* volume-id - The volume ID.
*
*
* -
*
* volume-type - The Amazon EBS volume type. This can be
* gp2 for General Purpose SSD, io1 for
* Provisioned IOPS SSD, st1 for Throughput Optimized HDD,
* sc1 for Cold HDD, or standard for Magnetic
* volumes.
*
*
*
*
* 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.
*
* -
*
* attachment.attach-time - The time stamp when the
* attachment initiated.
*
*
* -
*
* attachment.delete-on-termination - Whether the volume
* is deleted on instance termination.
*
*
* -
*
* attachment.device - The device name that is exposed
* to the instance (for example, /dev/sda1).
*
*
* -
*
* attachment.instance-id - The ID of the instance the
* volume is attached to.
*
*
* -
*
* attachment.status - The attachment state (
* attaching | attached |
* detaching | detached).
*
*
* -
*
* availability-zone - The Availability Zone in which
* the volume was created.
*
*
* -
*
* create-time - The time stamp when the volume was
* created.
*
*
* -
*
* encrypted - The encryption status of the volume.
*
*
* -
*
* size - The size of the volume, in GiB.
*
*
* -
*
* snapshot-id - The snapshot from which the volume was
* created.
*
*
* -
*
* status - The status of the volume (
* creating | available |
* in-use | deleting | deleted
* | error).
*
*
* -
*
* tag:key=value - The key/value
* combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter.
* For example, if you use both the filter "tag-key=Purpose" and the
* filter "tag-value=X", you get any resources assigned both the tag
* key Purpose (regardless of what the tag's value is), and the tag
* value X (regardless of what the tag's key is). If you want to list
* only resources where Purpose is X, see the tag
* :key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
*
* -
*
* volume-id - The volume ID.
*
*
* -
*
* volume-type - The Amazon EBS volume type. This can be
* gp2 for General Purpose SSD, io1 for
* Provisioned IOPS SSD, st1 for Throughput Optimized
* HDD, sc1 for Cold HDD, or standard for
* Magnetic volumes.
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeVolumesRequest 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.
*
*
* -
*
* attachment.attach-time - The time stamp when the attachment
* initiated.
*
*
* -
*
* attachment.delete-on-termination - Whether the volume is
* deleted on instance termination.
*
*
* -
*
* attachment.device - The device name that is exposed to the
* instance (for example, /dev/sda1).
*
*
* -
*
* attachment.instance-id - The ID of the instance the volume
* is attached to.
*
*
* -
*
* attachment.status - The attachment state (
* attaching | attached | detaching |
* detached).
*
*
* -
*
* availability-zone - The Availability Zone in which the
* volume was created.
*
*
* -
*
* create-time - The time stamp when the volume was created.
*
*
* -
*
* encrypted - The encryption status of the volume.
*
*
* -
*
* size - The size of the volume, in GiB.
*
*
* -
*
* snapshot-id - The snapshot from which the volume was
* created.
*
*
* -
*
* status - The status of the volume (creating |
* available | in-use | deleting |
* deleted | error).
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* volume-id - The volume ID.
*
*
* -
*
* volume-type - The Amazon EBS volume type. This can be
* gp2 for General Purpose SSD, io1 for
* Provisioned IOPS SSD, st1 for Throughput Optimized HDD,
* sc1 for Cold HDD, or standard for Magnetic
* volumes.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* attachment.attach-time - The time stamp when the
* attachment initiated.
*
*
* -
*
* attachment.delete-on-termination - Whether the volume
* is deleted on instance termination.
*
*
* -
*
* attachment.device - The device name that is exposed
* to the instance (for example, /dev/sda1).
*
*
* -
*
* attachment.instance-id - The ID of the instance the
* volume is attached to.
*
*
* -
*
* attachment.status - The attachment state (
* attaching | attached |
* detaching | detached).
*
*
* -
*
* availability-zone - The Availability Zone in which
* the volume was created.
*
*
* -
*
* create-time - The time stamp when the volume was
* created.
*
*
* -
*
* encrypted - The encryption status of the volume.
*
*
* -
*
* size - The size of the volume, in GiB.
*
*
* -
*
* snapshot-id - The snapshot from which the volume was
* created.
*
*
* -
*
* status - The status of the volume (
* creating | available |
* in-use | deleting | deleted
* | error).
*
*
* -
*
* tag:key=value - The key/value
* combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter.
* For example, if you use both the filter "tag-key=Purpose" and the
* filter "tag-value=X", you get any resources assigned both the tag
* key Purpose (regardless of what the tag's value is), and the tag
* value X (regardless of what the tag's key is). If you want to list
* only resources where Purpose is X, see the tag
* :key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
*
* -
*
* volume-id - The volume ID.
*
*
* -
*
* volume-type - The Amazon EBS volume type. This can be
* gp2 for General Purpose SSD, io1 for
* Provisioned IOPS SSD, st1 for Throughput Optimized
* HDD, sc1 for Cold HDD, or standard for
* Magnetic volumes.
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeVolumesRequest withFilters(
java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The NextToken value returned from a previous paginated
* DescribeVolumes request where MaxResults was
* used and the results exceeded the value of that parameter. Pagination
* continues from the end of the previous results that returned the
* NextToken value. This value is null when there
* are no more results to return.
*
*
* @param nextToken
* The NextToken value returned from a previous
* paginated DescribeVolumes request where
* MaxResults was used and the results exceeded the
* value of that parameter. Pagination continues from the end of the
* previous results that returned the NextToken value.
* This value is null when there are no more results to
* return.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The NextToken value returned from a previous paginated
* DescribeVolumes request where MaxResults was
* used and the results exceeded the value of that parameter. Pagination
* continues from the end of the previous results that returned the
* NextToken value. This value is null when there
* are no more results to return.
*
*
* @return The NextToken value returned from a previous
* paginated DescribeVolumes request where
* MaxResults was used and the results exceeded the
* value of that parameter. Pagination continues from the end of the
* previous results that returned the NextToken value.
* This value is null when there are no more results to
* return.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The NextToken value returned from a previous paginated
* DescribeVolumes request where MaxResults was
* used and the results exceeded the value of that parameter. Pagination
* continues from the end of the previous results that returned the
* NextToken value. This value is null when there
* are no more results to return.
*
*
* @param nextToken
* The NextToken value returned from a previous
* paginated DescribeVolumes request where
* MaxResults was used and the results exceeded the
* value of that parameter. Pagination continues from the end of the
* previous results that returned the NextToken value.
* 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 DescribeVolumesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of volume results returned by
* DescribeVolumes in paginated output. When this parameter is
* used, DescribeVolumes 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 DescribeVolumes 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
* DescribeVolumes 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
* DescribeVolumes in paginated output. When this
* parameter is used, DescribeVolumes 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
* DescribeVolumes 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 DescribeVolumes 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
* DescribeVolumes in paginated output. When this parameter is
* used, DescribeVolumes 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 DescribeVolumes 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
* DescribeVolumes 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
* DescribeVolumes in paginated output. When this
* parameter is used, DescribeVolumes 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
* DescribeVolumes 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 DescribeVolumes 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
* DescribeVolumes in paginated output. When this parameter is
* used, DescribeVolumes 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 DescribeVolumes 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
* DescribeVolumes 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
* DescribeVolumes in paginated output. When this
* parameter is used, DescribeVolumes 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
* DescribeVolumes 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 DescribeVolumes 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 DescribeVolumesRequest 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 DescribeVolumesRequestMarshaller()
.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 DescribeVolumesRequest == false)
return false;
DescribeVolumesRequest other = (DescribeVolumesRequest) 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 DescribeVolumesRequest clone() {
return (DescribeVolumesRequest) super.clone();
}
}