com.amazonaws.services.ec2.model.DescribeVolumesRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2011 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 com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeVolumes(DescribeVolumesRequest) DescribeVolumes operation}.
*
* Describes the status of the indicated or, in lieu of any specified,
* all volumes belonging to the caller. Volumes that have been deleted
* are not described.
*
*
* @see com.amazonaws.services.ec2.AmazonEC2#describeVolumes(DescribeVolumesRequest)
*/
public class DescribeVolumesRequest extends AmazonWebServiceRequest {
/**
* The optional list of EBS volumes to describe.
*/
private java.util.List volumeIds;
/**
* A list of filters used to match properties for Volumes. For a complete
* reference to the available filter keys for this operation, see the Amazon
* EC2 API reference.
*/
private java.util.List filters;
/**
* Default constructor for a new DescribeVolumesRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this 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 The optional list of EBS volumes to describe.
*/
public DescribeVolumesRequest(java.util.List volumeIds) {
this.volumeIds = volumeIds;
}
/**
* The optional list of EBS volumes to describe.
*
* @return The optional list of EBS volumes to describe.
*/
public java.util.List getVolumeIds() {
if (volumeIds == null) {
volumeIds = new java.util.ArrayList();
}
return volumeIds;
}
/**
* The optional list of EBS volumes to describe.
*
* @param volumeIds The optional list of EBS volumes to describe.
*/
public void setVolumeIds(java.util.Collection volumeIds) {
java.util.List volumeIdsCopy = new java.util.ArrayList();
if (volumeIds != null) {
volumeIdsCopy.addAll(volumeIds);
}
this.volumeIds = volumeIdsCopy;
}
/**
* The optional list of EBS volumes to describe.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param volumeIds The optional list of EBS volumes to describe.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeVolumesRequest withVolumeIds(String... volumeIds) {
for (String value : volumeIds) {
getVolumeIds().add(value);
}
return this;
}
/**
* The optional list of EBS volumes to describe.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param volumeIds The optional list of EBS volumes to describe.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeVolumesRequest withVolumeIds(java.util.Collection volumeIds) {
java.util.List volumeIdsCopy = new java.util.ArrayList();
if (volumeIds != null) {
volumeIdsCopy.addAll(volumeIds);
}
this.volumeIds = volumeIdsCopy;
return this;
}
/**
* A list of filters used to match properties for Volumes. For a complete
* reference to the available filter keys for this operation, see the Amazon
* EC2 API reference.
*
* @return A list of filters used to match properties for Volumes. For a complete
* reference to the available filter keys for this operation, see the Amazon
* EC2 API reference.
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new java.util.ArrayList();
}
return filters;
}
/**
* A list of filters used to match properties for Volumes. For a complete
* reference to the available filter keys for this operation, see the Amazon
* EC2 API reference.
*
* @param filters A list of filters used to match properties for Volumes. For a complete
* reference to the available filter keys for this operation, see the Amazon
* EC2 API reference.
*/
public void setFilters(java.util.Collection filters) {
java.util.List filtersCopy = new java.util.ArrayList();
if (filters != null) {
filtersCopy.addAll(filters);
}
this.filters = filtersCopy;
}
/**
* A list of filters used to match properties for Volumes. For a complete
* reference to the available filter keys for this operation, see the Amazon
* EC2 API reference.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters A list of filters used to match properties for Volumes. For a complete
* reference to the available filter keys for this operation, see the Amazon
* EC2 API reference.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeVolumesRequest withFilters(Filter... filters) {
for (Filter value : filters) {
getFilters().add(value);
}
return this;
}
/**
* A list of filters used to match properties for Volumes. For a complete
* reference to the available filter keys for this operation, see the Amazon
* EC2 API reference.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters A list of filters used to match properties for Volumes. For a complete
* reference to the available filter keys for this operation, see the Amazon
* EC2 API reference.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeVolumesRequest withFilters(java.util.Collection filters) {
java.util.List filtersCopy = new java.util.ArrayList();
if (filters != null) {
filtersCopy.addAll(filters);
}
this.filters = filtersCopy;
return this;
}
/**
* 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("{");
sb.append("VolumeIds: " + volumeIds + ", ");
sb.append("Filters: " + filters + ", ");
sb.append("}");
return sb.toString();
}
}