com.amazonaws.services.ec2.model.DescribeSnapshotsRequest 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#describeSnapshots(DescribeSnapshotsRequest) DescribeSnapshots operation}.
*
* Returns information about the Amazon EBS snapshots available to you.
* Snapshots available to you include public snapshots available for any
* AWS account to launch, private snapshots you own, and private
* snapshots owned by another AWS account but for which you've been given
* explicit create volume permissions.
*
*
* @see com.amazonaws.services.ec2.AmazonEC2#describeSnapshots(DescribeSnapshotsRequest)
*/
public class DescribeSnapshotsRequest extends AmazonWebServiceRequest {
/**
* The optional list of EBS snapshot IDs to describe.
*/
private java.util.List snapshotIds;
/**
* The optional list of EBS snapshot owners.
*/
private java.util.List ownerIds;
/**
* The optional list of users who have permission to create volumes from
* the described EBS snapshots.
*/
private java.util.List restorableByUserIds;
/**
* A list of filters used to match properties for Snapshots. For a
* complete reference to the available filter keys for this operation,
* see the Amazon
* EC2 API reference.
*/
private java.util.List filters;
/**
* The optional list of EBS snapshot IDs to describe.
*
* @return The optional list of EBS snapshot IDs to describe.
*/
public java.util.List getSnapshotIds() {
if (snapshotIds == null) {
snapshotIds = new java.util.ArrayList();
}
return snapshotIds;
}
/**
* The optional list of EBS snapshot IDs to describe.
*
* @param snapshotIds The optional list of EBS snapshot IDs to describe.
*/
public void setSnapshotIds(java.util.Collection snapshotIds) {
java.util.List snapshotIdsCopy = new java.util.ArrayList();
if (snapshotIds != null) {
snapshotIdsCopy.addAll(snapshotIds);
}
this.snapshotIds = snapshotIdsCopy;
}
/**
* The optional list of EBS snapshot IDs to describe.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param snapshotIds The optional list of EBS snapshot IDs to describe.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withSnapshotIds(String... snapshotIds) {
for (String value : snapshotIds) {
getSnapshotIds().add(value);
}
return this;
}
/**
* The optional list of EBS snapshot IDs to describe.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param snapshotIds The optional list of EBS snapshot IDs to describe.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withSnapshotIds(java.util.Collection snapshotIds) {
java.util.List snapshotIdsCopy = new java.util.ArrayList();
if (snapshotIds != null) {
snapshotIdsCopy.addAll(snapshotIds);
}
this.snapshotIds = snapshotIdsCopy;
return this;
}
/**
* The optional list of EBS snapshot owners.
*
* @return The optional list of EBS snapshot owners.
*/
public java.util.List getOwnerIds() {
if (ownerIds == null) {
ownerIds = new java.util.ArrayList();
}
return ownerIds;
}
/**
* The optional list of EBS snapshot owners.
*
* @param ownerIds The optional list of EBS snapshot owners.
*/
public void setOwnerIds(java.util.Collection ownerIds) {
java.util.List ownerIdsCopy = new java.util.ArrayList();
if (ownerIds != null) {
ownerIdsCopy.addAll(ownerIds);
}
this.ownerIds = ownerIdsCopy;
}
/**
* The optional list of EBS snapshot owners.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param ownerIds The optional list of EBS snapshot owners.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withOwnerIds(String... ownerIds) {
for (String value : ownerIds) {
getOwnerIds().add(value);
}
return this;
}
/**
* The optional list of EBS snapshot owners.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param ownerIds The optional list of EBS snapshot owners.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withOwnerIds(java.util.Collection ownerIds) {
java.util.List ownerIdsCopy = new java.util.ArrayList();
if (ownerIds != null) {
ownerIdsCopy.addAll(ownerIds);
}
this.ownerIds = ownerIdsCopy;
return this;
}
/**
* The optional list of users who have permission to create volumes from
* the described EBS snapshots.
*
* @return The optional list of users who have permission to create volumes from
* the described EBS snapshots.
*/
public java.util.List getRestorableByUserIds() {
if (restorableByUserIds == null) {
restorableByUserIds = new java.util.ArrayList();
}
return restorableByUserIds;
}
/**
* The optional list of users who have permission to create volumes from
* the described EBS snapshots.
*
* @param restorableByUserIds The optional list of users who have permission to create volumes from
* the described EBS snapshots.
*/
public void setRestorableByUserIds(java.util.Collection restorableByUserIds) {
java.util.List restorableByUserIdsCopy = new java.util.ArrayList();
if (restorableByUserIds != null) {
restorableByUserIdsCopy.addAll(restorableByUserIds);
}
this.restorableByUserIds = restorableByUserIdsCopy;
}
/**
* The optional list of users who have permission to create volumes from
* the described EBS snapshots.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param restorableByUserIds The optional list of users who have permission to create volumes from
* the described EBS snapshots.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withRestorableByUserIds(String... restorableByUserIds) {
for (String value : restorableByUserIds) {
getRestorableByUserIds().add(value);
}
return this;
}
/**
* The optional list of users who have permission to create volumes from
* the described EBS snapshots.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param restorableByUserIds The optional list of users who have permission to create volumes from
* the described EBS snapshots.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withRestorableByUserIds(java.util.Collection restorableByUserIds) {
java.util.List restorableByUserIdsCopy = new java.util.ArrayList();
if (restorableByUserIds != null) {
restorableByUserIdsCopy.addAll(restorableByUserIds);
}
this.restorableByUserIds = restorableByUserIdsCopy;
return this;
}
/**
* A list of filters used to match properties for Snapshots. 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 Snapshots. 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 Snapshots. 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 Snapshots. 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 Snapshots. 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 Snapshots. 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 DescribeSnapshotsRequest withFilters(Filter... filters) {
for (Filter value : filters) {
getFilters().add(value);
}
return this;
}
/**
* A list of filters used to match properties for Snapshots. 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 Snapshots. 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 DescribeSnapshotsRequest 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("SnapshotIds: " + snapshotIds + ", ");
sb.append("OwnerIds: " + ownerIds + ", ");
sb.append("RestorableByUserIds: " + restorableByUserIds + ", ");
sb.append("Filters: " + filters + ", ");
sb.append("}");
return sb.toString();
}
}