com.amazonaws.services.ec2.model.DescribeImagesRequest 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#describeImages(DescribeImagesRequest) DescribeImages operation}.
*
* The DescribeImages operation returns information about AMIs, AKIs,
* and ARIs available to the user. Information returned includes image
* type, product codes, architecture, and kernel and RAM disk IDs. Images
* available to the user include public images available for any user to
* launch, private images owned by the user making the request, and
* private images owned by other users for which the user has explicit
* launch permissions.
*
*
* Launch permissions fall into three categories:
*
*
*
* - Public: The owner of the AMI granted launch permissions for the
* AMI to the all group. All users have launch permissions for these
* AMIs.
* - Explicit: The owner of the AMI granted launch permissions to a
* specific user.
* - Implicit: A user has implicit launch permissions for all AMIs he
* or she owns.
*
*
*
* The list of AMIs returned can be modified by specifying AMI IDs, AMI
* owners, or users with launch permissions. If no options are specified,
* Amazon EC2 returns all AMIs for which the user has launch permissions.
*
*
* If you specify one or more AMI IDs, only AMIs that have the specified
* IDs are returned. If you specify an invalid AMI ID, a fault is
* returned. If you specify an AMI ID for which you do not have access,
* it will not be included in the returned results.
*
*
* If you specify one or more AMI owners, only AMIs from the specified
* owners and for which you have access are returned. The results can
* include the account IDs of the specified owners, amazon for AMIs owned
* by Amazon or self for AMIs that you own.
*
*
* If you specify a list of executable users, only users that have
* launch permissions for the AMIs are returned. You can specify account
* IDs (if you own the AMI(s)), self for AMIs for which you own or have
* explicit permissions, or all for public AMIs.
*
*
* NOTE: Deregistered images are included in the returned results
* for an unspecified interval after deregistration.
*
*
* @see com.amazonaws.services.ec2.AmazonEC2#describeImages(DescribeImagesRequest)
*/
public class DescribeImagesRequest extends AmazonWebServiceRequest {
/**
* An optional list of the AMI IDs to describe. If not specified, all
* AMIs will be described.
*/
private java.util.List imageIds;
/**
* The optional list of owners for the described AMIs. The IDs amazon,
* self, and explicit can be used to include AMIs owned by Amazon, AMIs
* owned by the user, and AMIs for which the user has explicit launch
* permissions, respectively.
*/
private java.util.List owners;
/**
* The optional list of users with explicit launch permissions for the
* described AMIs. The user ID can be a user's account ID, 'self' to
* return AMIs for which the sender of the request has explicit launch
* permissions, or 'all' to return AMIs with public launch permissions.
*/
private java.util.List executableUsers;
/**
* A list of filters used to match properties for Images. For a complete
* reference to the available filter keys for this operation, see the Amazon
* EC2 API reference.
*/
private java.util.List filters;
/**
* An optional list of the AMI IDs to describe. If not specified, all
* AMIs will be described.
*
* @return An optional list of the AMI IDs to describe. If not specified, all
* AMIs will be described.
*/
public java.util.List getImageIds() {
if (imageIds == null) {
imageIds = new java.util.ArrayList();
}
return imageIds;
}
/**
* An optional list of the AMI IDs to describe. If not specified, all
* AMIs will be described.
*
* @param imageIds An optional list of the AMI IDs to describe. If not specified, all
* AMIs will be described.
*/
public void setImageIds(java.util.Collection imageIds) {
java.util.List imageIdsCopy = new java.util.ArrayList();
if (imageIds != null) {
imageIdsCopy.addAll(imageIds);
}
this.imageIds = imageIdsCopy;
}
/**
* An optional list of the AMI IDs to describe. If not specified, all
* AMIs will be described.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param imageIds An optional list of the AMI IDs to describe. If not specified, all
* AMIs will be described.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withImageIds(String... imageIds) {
for (String value : imageIds) {
getImageIds().add(value);
}
return this;
}
/**
* An optional list of the AMI IDs to describe. If not specified, all
* AMIs will be described.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param imageIds An optional list of the AMI IDs to describe. If not specified, all
* AMIs will be described.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withImageIds(java.util.Collection imageIds) {
java.util.List imageIdsCopy = new java.util.ArrayList();
if (imageIds != null) {
imageIdsCopy.addAll(imageIds);
}
this.imageIds = imageIdsCopy;
return this;
}
/**
* The optional list of owners for the described AMIs. The IDs amazon,
* self, and explicit can be used to include AMIs owned by Amazon, AMIs
* owned by the user, and AMIs for which the user has explicit launch
* permissions, respectively.
*
* @return The optional list of owners for the described AMIs. The IDs amazon,
* self, and explicit can be used to include AMIs owned by Amazon, AMIs
* owned by the user, and AMIs for which the user has explicit launch
* permissions, respectively.
*/
public java.util.List getOwners() {
if (owners == null) {
owners = new java.util.ArrayList();
}
return owners;
}
/**
* The optional list of owners for the described AMIs. The IDs amazon,
* self, and explicit can be used to include AMIs owned by Amazon, AMIs
* owned by the user, and AMIs for which the user has explicit launch
* permissions, respectively.
*
* @param owners The optional list of owners for the described AMIs. The IDs amazon,
* self, and explicit can be used to include AMIs owned by Amazon, AMIs
* owned by the user, and AMIs for which the user has explicit launch
* permissions, respectively.
*/
public void setOwners(java.util.Collection owners) {
java.util.List ownersCopy = new java.util.ArrayList();
if (owners != null) {
ownersCopy.addAll(owners);
}
this.owners = ownersCopy;
}
/**
* The optional list of owners for the described AMIs. The IDs amazon,
* self, and explicit can be used to include AMIs owned by Amazon, AMIs
* owned by the user, and AMIs for which the user has explicit launch
* permissions, respectively.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param owners The optional list of owners for the described AMIs. The IDs amazon,
* self, and explicit can be used to include AMIs owned by Amazon, AMIs
* owned by the user, and AMIs for which the user has explicit launch
* permissions, respectively.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withOwners(String... owners) {
for (String value : owners) {
getOwners().add(value);
}
return this;
}
/**
* The optional list of owners for the described AMIs. The IDs amazon,
* self, and explicit can be used to include AMIs owned by Amazon, AMIs
* owned by the user, and AMIs for which the user has explicit launch
* permissions, respectively.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param owners The optional list of owners for the described AMIs. The IDs amazon,
* self, and explicit can be used to include AMIs owned by Amazon, AMIs
* owned by the user, and AMIs for which the user has explicit launch
* permissions, respectively.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withOwners(java.util.Collection owners) {
java.util.List ownersCopy = new java.util.ArrayList();
if (owners != null) {
ownersCopy.addAll(owners);
}
this.owners = ownersCopy;
return this;
}
/**
* The optional list of users with explicit launch permissions for the
* described AMIs. The user ID can be a user's account ID, 'self' to
* return AMIs for which the sender of the request has explicit launch
* permissions, or 'all' to return AMIs with public launch permissions.
*
* @return The optional list of users with explicit launch permissions for the
* described AMIs. The user ID can be a user's account ID, 'self' to
* return AMIs for which the sender of the request has explicit launch
* permissions, or 'all' to return AMIs with public launch permissions.
*/
public java.util.List getExecutableUsers() {
if (executableUsers == null) {
executableUsers = new java.util.ArrayList();
}
return executableUsers;
}
/**
* The optional list of users with explicit launch permissions for the
* described AMIs. The user ID can be a user's account ID, 'self' to
* return AMIs for which the sender of the request has explicit launch
* permissions, or 'all' to return AMIs with public launch permissions.
*
* @param executableUsers The optional list of users with explicit launch permissions for the
* described AMIs. The user ID can be a user's account ID, 'self' to
* return AMIs for which the sender of the request has explicit launch
* permissions, or 'all' to return AMIs with public launch permissions.
*/
public void setExecutableUsers(java.util.Collection executableUsers) {
java.util.List executableUsersCopy = new java.util.ArrayList();
if (executableUsers != null) {
executableUsersCopy.addAll(executableUsers);
}
this.executableUsers = executableUsersCopy;
}
/**
* The optional list of users with explicit launch permissions for the
* described AMIs. The user ID can be a user's account ID, 'self' to
* return AMIs for which the sender of the request has explicit launch
* permissions, or 'all' to return AMIs with public launch permissions.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param executableUsers The optional list of users with explicit launch permissions for the
* described AMIs. The user ID can be a user's account ID, 'self' to
* return AMIs for which the sender of the request has explicit launch
* permissions, or 'all' to return AMIs with public launch permissions.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withExecutableUsers(String... executableUsers) {
for (String value : executableUsers) {
getExecutableUsers().add(value);
}
return this;
}
/**
* The optional list of users with explicit launch permissions for the
* described AMIs. The user ID can be a user's account ID, 'self' to
* return AMIs for which the sender of the request has explicit launch
* permissions, or 'all' to return AMIs with public launch permissions.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param executableUsers The optional list of users with explicit launch permissions for the
* described AMIs. The user ID can be a user's account ID, 'self' to
* return AMIs for which the sender of the request has explicit launch
* permissions, or 'all' to return AMIs with public launch permissions.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withExecutableUsers(java.util.Collection executableUsers) {
java.util.List executableUsersCopy = new java.util.ArrayList();
if (executableUsers != null) {
executableUsersCopy.addAll(executableUsers);
}
this.executableUsers = executableUsersCopy;
return this;
}
/**
* A list of filters used to match properties for Images. 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 Images. 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 Images. 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 Images. 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 Images. 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 Images. 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 DescribeImagesRequest withFilters(Filter... filters) {
for (Filter value : filters) {
getFilters().add(value);
}
return this;
}
/**
* A list of filters used to match properties for Images. 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 Images. 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 DescribeImagesRequest 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("ImageIds: " + imageIds + ", ");
sb.append("Owners: " + owners + ", ");
sb.append("ExecutableUsers: " + executableUsers + ", ");
sb.append("Filters: " + filters + ", ");
sb.append("}");
return sb.toString();
}
}