com.amazonaws.services.ec2.model.DescribeImagesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2010-2014 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.DescribeImagesRequestMarshaller;
/**
* Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeImages(DescribeImagesRequest) DescribeImages operation}.
*
* Describes one or more of the images (AMIs, AKIs, and ARIs) available
* to you. Images available to you include public images, private images
* that you own, and private images owned by other AWS accounts but for
* which you have explicit launch permissions.
*
*
* 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 implements Serializable, DryRunSupportedRequest {
/**
* One or more image IDs. Default: Describes all images available to
* you.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag imageIds;
/**
* Filters the images by the owner. Specify an AWS account ID,
* amazon (owner is Amazon), aws-marketplace
* (owner is AWS Marketplace), self (owner is the sender of
* the request), or all (all owners).
*/
private com.amazonaws.internal.ListWithAutoConstructFlag owners;
/**
* Scopes the images by users with explicit launch permissions. Specify
* an AWS account ID, self (the sender of the request), or
* all (public AMIs).
*/
private com.amazonaws.internal.ListWithAutoConstructFlag executableUsers;
/**
* One or more filters. -
architecture - The
* image architecture (i386 | x86_64).
* -
block-device-mapping.delete-on-termination - A
* Boolean value that indicates whether the Amazon EBS volume is deleted
* on instance termination.
-
*
block-device-mapping.device-name - The device name for
* the Amazon EBS volume (for example, /dev/sdh).
-
*
block-device-mapping.snapshot-id - The ID of the
* snapshot used for the Amazon EBS volume.
-
*
block-device-mapping.volume-size - The volume size of
* the Amazon EBS volume, in GiB.
-
*
block-device-mapping.volume-type - The volume type of
* the Amazon EBS volume (gp2 | standard |
* io1).
-
description - The
* description of the image (provided during image creation).
-
*
hypervisor - The hypervisor type (ovm |
* xen).
-
image-id - The ID of the
* image.
-
image-type - The image type
* (machine | kernel | ramdisk).
*
-
is-public - A Boolean that indicates
* whether the image is public.
-
kernel-id -
* The kernel ID.
-
manifest-location - The
* location of the image manifest.
-
name - The
* name of the AMI (provided during image creation).
-
*
owner-alias - The AWS account alias (for example,
* amazon).
-
owner-id - The AWS
* account ID of the image owner.
-
platform -
* The platform. To only list Windows-based AMIs, use
* windows.
-
product-code - The
* product code.
-
product-code.type - The type
* of the product code (devpay | marketplace).
*
-
ramdisk-id - The RAM disk ID.
-
*
root-device-name - The name of the root device volume
* (for example, /dev/sda1).
-
*
root-device-type - The type of the root device volume
* (ebs | instance-store).
-
*
state - The state of the image (available
* | pending | failed).
-
*
state-reason-code - The reason code for the state
* change.
-
state-reason-message - The message
* for the state change.
-
*
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.
-
virtualization-type - The
* virtualization type (paravirtual | hvm).
*
*/
private com.amazonaws.internal.ListWithAutoConstructFlag filters;
/**
* One or more image IDs. Default: Describes all images available to
* you.
*
* @return One or more image IDs.
Default: Describes all images available to
* you.
*/
public java.util.List getImageIds() {
if (imageIds == null) {
imageIds = new com.amazonaws.internal.ListWithAutoConstructFlag();
imageIds.setAutoConstruct(true);
}
return imageIds;
}
/**
* One or more image IDs. Default: Describes all images available to
* you.
*
* @param imageIds One or more image IDs.
Default: Describes all images available to
* you.
*/
public void setImageIds(java.util.Collection imageIds) {
if (imageIds == null) {
this.imageIds = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag imageIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(imageIds.size());
imageIdsCopy.addAll(imageIds);
this.imageIds = imageIdsCopy;
}
/**
* One or more image IDs. Default: Describes all images available to
* you.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param imageIds One or more image IDs.
Default: Describes all images available to
* you.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withImageIds(String... imageIds) {
if (getImageIds() == null) setImageIds(new java.util.ArrayList(imageIds.length));
for (String value : imageIds) {
getImageIds().add(value);
}
return this;
}
/**
* One or more image IDs. Default: Describes all images available to
* you.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param imageIds One or more image IDs.
Default: Describes all images available to
* you.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withImageIds(java.util.Collection imageIds) {
if (imageIds == null) {
this.imageIds = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag imageIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(imageIds.size());
imageIdsCopy.addAll(imageIds);
this.imageIds = imageIdsCopy;
}
return this;
}
/**
* Filters the images by the owner. Specify an AWS account ID,
* amazon (owner is Amazon), aws-marketplace
* (owner is AWS Marketplace), self (owner is the sender of
* the request), or all (all owners).
*
* @return Filters the images by the owner. Specify an AWS account ID,
* amazon (owner is Amazon), aws-marketplace
* (owner is AWS Marketplace), self (owner is the sender of
* the request), or all (all owners).
*/
public java.util.List getOwners() {
if (owners == null) {
owners = new com.amazonaws.internal.ListWithAutoConstructFlag();
owners.setAutoConstruct(true);
}
return owners;
}
/**
* Filters the images by the owner. Specify an AWS account ID,
* amazon (owner is Amazon), aws-marketplace
* (owner is AWS Marketplace), self (owner is the sender of
* the request), or all (all owners).
*
* @param owners Filters the images by the owner. Specify an AWS account ID,
* amazon (owner is Amazon), aws-marketplace
* (owner is AWS Marketplace), self (owner is the sender of
* the request), or all (all owners).
*/
public void setOwners(java.util.Collection owners) {
if (owners == null) {
this.owners = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag ownersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(owners.size());
ownersCopy.addAll(owners);
this.owners = ownersCopy;
}
/**
* Filters the images by the owner. Specify an AWS account ID,
* amazon (owner is Amazon), aws-marketplace
* (owner is AWS Marketplace), self (owner is the sender of
* the request), or all (all owners).
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param owners Filters the images by the owner. Specify an AWS account ID,
* amazon (owner is Amazon), aws-marketplace
* (owner is AWS Marketplace), self (owner is the sender of
* the request), or all (all owners).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withOwners(String... owners) {
if (getOwners() == null) setOwners(new java.util.ArrayList(owners.length));
for (String value : owners) {
getOwners().add(value);
}
return this;
}
/**
* Filters the images by the owner. Specify an AWS account ID,
* amazon (owner is Amazon), aws-marketplace
* (owner is AWS Marketplace), self (owner is the sender of
* the request), or all (all owners).
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param owners Filters the images by the owner. Specify an AWS account ID,
* amazon (owner is Amazon), aws-marketplace
* (owner is AWS Marketplace), self (owner is the sender of
* the request), or all (all owners).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withOwners(java.util.Collection owners) {
if (owners == null) {
this.owners = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag ownersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(owners.size());
ownersCopy.addAll(owners);
this.owners = ownersCopy;
}
return this;
}
/**
* Scopes the images by users with explicit launch permissions. Specify
* an AWS account ID, self (the sender of the request), or
* all (public AMIs).
*
* @return Scopes the images by users with explicit launch permissions. Specify
* an AWS account ID, self (the sender of the request), or
* all (public AMIs).
*/
public java.util.List getExecutableUsers() {
if (executableUsers == null) {
executableUsers = new com.amazonaws.internal.ListWithAutoConstructFlag();
executableUsers.setAutoConstruct(true);
}
return executableUsers;
}
/**
* Scopes the images by users with explicit launch permissions. Specify
* an AWS account ID, self (the sender of the request), or
* all (public AMIs).
*
* @param executableUsers Scopes the images by users with explicit launch permissions. Specify
* an AWS account ID, self (the sender of the request), or
* all (public AMIs).
*/
public void setExecutableUsers(java.util.Collection executableUsers) {
if (executableUsers == null) {
this.executableUsers = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag executableUsersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(executableUsers.size());
executableUsersCopy.addAll(executableUsers);
this.executableUsers = executableUsersCopy;
}
/**
* Scopes the images by users with explicit launch permissions. Specify
* an AWS account ID, self (the sender of the request), or
* all (public AMIs).
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param executableUsers Scopes the images by users with explicit launch permissions. Specify
* an AWS account ID, self (the sender of the request), or
* all (public AMIs).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withExecutableUsers(String... executableUsers) {
if (getExecutableUsers() == null) setExecutableUsers(new java.util.ArrayList(executableUsers.length));
for (String value : executableUsers) {
getExecutableUsers().add(value);
}
return this;
}
/**
* Scopes the images by users with explicit launch permissions. Specify
* an AWS account ID, self (the sender of the request), or
* all (public AMIs).
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param executableUsers Scopes the images by users with explicit launch permissions. Specify
* an AWS account ID, self (the sender of the request), or
* all (public AMIs).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withExecutableUsers(java.util.Collection executableUsers) {
if (executableUsers == null) {
this.executableUsers = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag executableUsersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(executableUsers.size());
executableUsersCopy.addAll(executableUsers);
this.executableUsers = executableUsersCopy;
}
return this;
}
/**
* One or more filters. -
architecture - The
* image architecture (i386 | x86_64).
* -
block-device-mapping.delete-on-termination - A
* Boolean value that indicates whether the Amazon EBS volume is deleted
* on instance termination.
-
*
block-device-mapping.device-name - The device name for
* the Amazon EBS volume (for example, /dev/sdh).
-
*
block-device-mapping.snapshot-id - The ID of the
* snapshot used for the Amazon EBS volume.
-
*
block-device-mapping.volume-size - The volume size of
* the Amazon EBS volume, in GiB.
-
*
block-device-mapping.volume-type - The volume type of
* the Amazon EBS volume (gp2 | standard |
* io1).
-
description - The
* description of the image (provided during image creation).
-
*
hypervisor - The hypervisor type (ovm |
* xen).
-
image-id - The ID of the
* image.
-
image-type - The image type
* (machine | kernel | ramdisk).
*
-
is-public - A Boolean that indicates
* whether the image is public.
-
kernel-id -
* The kernel ID.
-
manifest-location - The
* location of the image manifest.
-
name - The
* name of the AMI (provided during image creation).
-
*
owner-alias - The AWS account alias (for example,
* amazon).
-
owner-id - The AWS
* account ID of the image owner.
-
platform -
* The platform. To only list Windows-based AMIs, use
* windows.
-
product-code - The
* product code.
-
product-code.type - The type
* of the product code (devpay | marketplace).
*
-
ramdisk-id - The RAM disk ID.
-
*
root-device-name - The name of the root device volume
* (for example, /dev/sda1).
-
*
root-device-type - The type of the root device volume
* (ebs | instance-store).
-
*
state - The state of the image (available
* | pending | failed).
-
*
state-reason-code - The reason code for the state
* change.
-
state-reason-message - The message
* for the state change.
-
*
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.
-
virtualization-type - The
* virtualization type (paravirtual | hvm).
*
*
* @return One or more filters. -
architecture - The
* image architecture (i386 | x86_64).
* -
block-device-mapping.delete-on-termination - A
* Boolean value that indicates whether the Amazon EBS volume is deleted
* on instance termination.
-
*
block-device-mapping.device-name - The device name for
* the Amazon EBS volume (for example, /dev/sdh).
-
*
block-device-mapping.snapshot-id - The ID of the
* snapshot used for the Amazon EBS volume.
-
*
block-device-mapping.volume-size - The volume size of
* the Amazon EBS volume, in GiB.
-
*
block-device-mapping.volume-type - The volume type of
* the Amazon EBS volume (gp2 | standard |
* io1).
-
description - The
* description of the image (provided during image creation).
-
*
hypervisor - The hypervisor type (ovm |
* xen).
-
image-id - The ID of the
* image.
-
image-type - The image type
* (machine | kernel | ramdisk).
*
-
is-public - A Boolean that indicates
* whether the image is public.
-
kernel-id -
* The kernel ID.
-
manifest-location - The
* location of the image manifest.
-
name - The
* name of the AMI (provided during image creation).
-
*
owner-alias - The AWS account alias (for example,
* amazon).
-
owner-id - The AWS
* account ID of the image owner.
-
platform -
* The platform. To only list Windows-based AMIs, use
* windows.
-
product-code - The
* product code.
-
product-code.type - The type
* of the product code (devpay | marketplace).
*
-
ramdisk-id - The RAM disk ID.
-
*
root-device-name - The name of the root device volume
* (for example, /dev/sda1).
-
*
root-device-type - The type of the root device volume
* (ebs | instance-store).
-
*
state - The state of the image (available
* | pending | failed).
-
*
state-reason-code - The reason code for the state
* change.
-
state-reason-message - The message
* for the state change.
-
*
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.
-
virtualization-type - The
* virtualization type (paravirtual | hvm).
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.ListWithAutoConstructFlag();
filters.setAutoConstruct(true);
}
return filters;
}
/**
* One or more filters. -
architecture - The
* image architecture (i386 | x86_64).
* -
block-device-mapping.delete-on-termination - A
* Boolean value that indicates whether the Amazon EBS volume is deleted
* on instance termination.
-
*
block-device-mapping.device-name - The device name for
* the Amazon EBS volume (for example, /dev/sdh).
-
*
block-device-mapping.snapshot-id - The ID of the
* snapshot used for the Amazon EBS volume.
-
*
block-device-mapping.volume-size - The volume size of
* the Amazon EBS volume, in GiB.
-
*
block-device-mapping.volume-type - The volume type of
* the Amazon EBS volume (gp2 | standard |
* io1).
-
description - The
* description of the image (provided during image creation).
-
*
hypervisor - The hypervisor type (ovm |
* xen).
-
image-id - The ID of the
* image.
-
image-type - The image type
* (machine | kernel | ramdisk).
*
-
is-public - A Boolean that indicates
* whether the image is public.
-
kernel-id -
* The kernel ID.
-
manifest-location - The
* location of the image manifest.
-
name - The
* name of the AMI (provided during image creation).
-
*
owner-alias - The AWS account alias (for example,
* amazon).
-
owner-id - The AWS
* account ID of the image owner.
-
platform -
* The platform. To only list Windows-based AMIs, use
* windows.
-
product-code - The
* product code.
-
product-code.type - The type
* of the product code (devpay | marketplace).
*
-
ramdisk-id - The RAM disk ID.
-
*
root-device-name - The name of the root device volume
* (for example, /dev/sda1).
-
*
root-device-type - The type of the root device volume
* (ebs | instance-store).
-
*
state - The state of the image (available
* | pending | failed).
-
*
state-reason-code - The reason code for the state
* change.
-
state-reason-message - The message
* for the state change.
-
*
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.
-
virtualization-type - The
* virtualization type (paravirtual | hvm).
*
*
* @param filters One or more filters. -
architecture - The
* image architecture (i386 | x86_64).
* -
block-device-mapping.delete-on-termination - A
* Boolean value that indicates whether the Amazon EBS volume is deleted
* on instance termination.
-
*
block-device-mapping.device-name - The device name for
* the Amazon EBS volume (for example, /dev/sdh).
-
*
block-device-mapping.snapshot-id - The ID of the
* snapshot used for the Amazon EBS volume.
-
*
block-device-mapping.volume-size - The volume size of
* the Amazon EBS volume, in GiB.
-
*
block-device-mapping.volume-type - The volume type of
* the Amazon EBS volume (gp2 | standard |
* io1).
-
description - The
* description of the image (provided during image creation).
-
*
hypervisor - The hypervisor type (ovm |
* xen).
-
image-id - The ID of the
* image.
-
image-type - The image type
* (machine | kernel | ramdisk).
*
-
is-public - A Boolean that indicates
* whether the image is public.
-
kernel-id -
* The kernel ID.
-
manifest-location - The
* location of the image manifest.
-
name - The
* name of the AMI (provided during image creation).
-
*
owner-alias - The AWS account alias (for example,
* amazon).
-
owner-id - The AWS
* account ID of the image owner.
-
platform -
* The platform. To only list Windows-based AMIs, use
* windows.
-
product-code - The
* product code.
-
product-code.type - The type
* of the product code (devpay | marketplace).
*
-
ramdisk-id - The RAM disk ID.
-
*
root-device-name - The name of the root device volume
* (for example, /dev/sda1).
-
*
root-device-type - The type of the root device volume
* (ebs | instance-store).
-
*
state - The state of the image (available
* | pending | failed).
-
*
state-reason-code - The reason code for the state
* change.
-
state-reason-message - The message
* for the state change.
-
*
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.
-
virtualization-type - The
* virtualization type (paravirtual | hvm).
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
/**
* One or more filters. -
architecture - The
* image architecture (i386 | x86_64).
* -
block-device-mapping.delete-on-termination - A
* Boolean value that indicates whether the Amazon EBS volume is deleted
* on instance termination.
-
*
block-device-mapping.device-name - The device name for
* the Amazon EBS volume (for example, /dev/sdh).
-
*
block-device-mapping.snapshot-id - The ID of the
* snapshot used for the Amazon EBS volume.
-
*
block-device-mapping.volume-size - The volume size of
* the Amazon EBS volume, in GiB.
-
*
block-device-mapping.volume-type - The volume type of
* the Amazon EBS volume (gp2 | standard |
* io1).
-
description - The
* description of the image (provided during image creation).
-
*
hypervisor - The hypervisor type (ovm |
* xen).
-
image-id - The ID of the
* image.
-
image-type - The image type
* (machine | kernel | ramdisk).
*
-
is-public - A Boolean that indicates
* whether the image is public.
-
kernel-id -
* The kernel ID.
-
manifest-location - The
* location of the image manifest.
-
name - The
* name of the AMI (provided during image creation).
-
*
owner-alias - The AWS account alias (for example,
* amazon).
-
owner-id - The AWS
* account ID of the image owner.
-
platform -
* The platform. To only list Windows-based AMIs, use
* windows.
-
product-code - The
* product code.
-
product-code.type - The type
* of the product code (devpay | marketplace).
*
-
ramdisk-id - The RAM disk ID.
-
*
root-device-name - The name of the root device volume
* (for example, /dev/sda1).
-
*
root-device-type - The type of the root device volume
* (ebs | instance-store).
-
*
state - The state of the image (available
* | pending | failed).
-
*
state-reason-code - The reason code for the state
* change.
-
state-reason-message - The message
* for the state change.
-
*
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.
-
virtualization-type - The
* virtualization type (paravirtual | hvm).
*
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
-
architecture - The
* image architecture (i386 | x86_64).
* -
block-device-mapping.delete-on-termination - A
* Boolean value that indicates whether the Amazon EBS volume is deleted
* on instance termination.
-
*
block-device-mapping.device-name - The device name for
* the Amazon EBS volume (for example, /dev/sdh).
-
*
block-device-mapping.snapshot-id - The ID of the
* snapshot used for the Amazon EBS volume.
-
*
block-device-mapping.volume-size - The volume size of
* the Amazon EBS volume, in GiB.
-
*
block-device-mapping.volume-type - The volume type of
* the Amazon EBS volume (gp2 | standard |
* io1).
-
description - The
* description of the image (provided during image creation).
-
*
hypervisor - The hypervisor type (ovm |
* xen).
-
image-id - The ID of the
* image.
-
image-type - The image type
* (machine | kernel | ramdisk).
*
-
is-public - A Boolean that indicates
* whether the image is public.
-
kernel-id -
* The kernel ID.
-
manifest-location - The
* location of the image manifest.
-
name - The
* name of the AMI (provided during image creation).
-
*
owner-alias - The AWS account alias (for example,
* amazon).
-
owner-id - The AWS
* account ID of the image owner.
-
platform -
* The platform. To only list Windows-based AMIs, use
* windows.
-
product-code - The
* product code.
-
product-code.type - The type
* of the product code (devpay | marketplace).
*
-
ramdisk-id - The RAM disk ID.
-
*
root-device-name - The name of the root device volume
* (for example, /dev/sda1).
-
*
root-device-type - The type of the root device volume
* (ebs | instance-store).
-
*
state - The state of the image (available
* | pending | failed).
-
*
state-reason-code - The reason code for the state
* change.
-
state-reason-message - The message
* for the state change.
-
*
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.
-
virtualization-type - The
* virtualization type (paravirtual | hvm).
*
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withFilters(Filter... filters) {
if (getFilters() == null) setFilters(new java.util.ArrayList(filters.length));
for (Filter value : filters) {
getFilters().add(value);
}
return this;
}
/**
* One or more filters. -
architecture - The
* image architecture (i386 | x86_64).
* -
block-device-mapping.delete-on-termination - A
* Boolean value that indicates whether the Amazon EBS volume is deleted
* on instance termination.
-
*
block-device-mapping.device-name - The device name for
* the Amazon EBS volume (for example, /dev/sdh).
-
*
block-device-mapping.snapshot-id - The ID of the
* snapshot used for the Amazon EBS volume.
-
*
block-device-mapping.volume-size - The volume size of
* the Amazon EBS volume, in GiB.
-
*
block-device-mapping.volume-type - The volume type of
* the Amazon EBS volume (gp2 | standard |
* io1).
-
description - The
* description of the image (provided during image creation).
-
*
hypervisor - The hypervisor type (ovm |
* xen).
-
image-id - The ID of the
* image.
-
image-type - The image type
* (machine | kernel | ramdisk).
*
-
is-public - A Boolean that indicates
* whether the image is public.
-
kernel-id -
* The kernel ID.
-
manifest-location - The
* location of the image manifest.
-
name - The
* name of the AMI (provided during image creation).
-
*
owner-alias - The AWS account alias (for example,
* amazon).
-
owner-id - The AWS
* account ID of the image owner.
-
platform -
* The platform. To only list Windows-based AMIs, use
* windows.
-
product-code - The
* product code.
-
product-code.type - The type
* of the product code (devpay | marketplace).
*
-
ramdisk-id - The RAM disk ID.
-
*
root-device-name - The name of the root device volume
* (for example, /dev/sda1).
-
*
root-device-type - The type of the root device volume
* (ebs | instance-store).
-
*
state - The state of the image (available
* | pending | failed).
-
*
state-reason-code - The reason code for the state
* change.
-
state-reason-message - The message
* for the state change.
-
*
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.
-
virtualization-type - The
* virtualization type (paravirtual | hvm).
*
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
-
architecture - The
* image architecture (i386 | x86_64).
* -
block-device-mapping.delete-on-termination - A
* Boolean value that indicates whether the Amazon EBS volume is deleted
* on instance termination.
-
*
block-device-mapping.device-name - The device name for
* the Amazon EBS volume (for example, /dev/sdh).
-
*
block-device-mapping.snapshot-id - The ID of the
* snapshot used for the Amazon EBS volume.
-
*
block-device-mapping.volume-size - The volume size of
* the Amazon EBS volume, in GiB.
-
*
block-device-mapping.volume-type - The volume type of
* the Amazon EBS volume (gp2 | standard |
* io1).
-
description - The
* description of the image (provided during image creation).
-
*
hypervisor - The hypervisor type (ovm |
* xen).
-
image-id - The ID of the
* image.
-
image-type - The image type
* (machine | kernel | ramdisk).
*
-
is-public - A Boolean that indicates
* whether the image is public.
-
kernel-id -
* The kernel ID.
-
manifest-location - The
* location of the image manifest.
-
name - The
* name of the AMI (provided during image creation).
-
*
owner-alias - The AWS account alias (for example,
* amazon).
-
owner-id - The AWS
* account ID of the image owner.
-
platform -
* The platform. To only list Windows-based AMIs, use
* windows.
-
product-code - The
* product code.
-
product-code.type - The type
* of the product code (devpay | marketplace).
*
-
ramdisk-id - The RAM disk ID.
-
*
root-device-name - The name of the root device volume
* (for example, /dev/sda1).
-
*
root-device-type - The type of the root device volume
* (ebs | instance-store).
-
*
state - The state of the image (available
* | pending | failed).
-
*
state-reason-code - The reason code for the state
* change.
-
state-reason-message - The message
* for the state change.
-
*
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.
-
virtualization-type - The
* virtualization type (paravirtual | hvm).
*
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeImagesRequest withFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
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 DescribeImagesRequestMarshaller().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 (getImageIds() != null) sb.append("ImageIds: " + getImageIds() + ",");
if (getOwners() != null) sb.append("Owners: " + getOwners() + ",");
if (getExecutableUsers() != null) sb.append("ExecutableUsers: " + getExecutableUsers() + ",");
if (getFilters() != null) sb.append("Filters: " + getFilters() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getImageIds() == null) ? 0 : getImageIds().hashCode());
hashCode = prime * hashCode + ((getOwners() == null) ? 0 : getOwners().hashCode());
hashCode = prime * hashCode + ((getExecutableUsers() == null) ? 0 : getExecutableUsers().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeImagesRequest == false) return false;
DescribeImagesRequest other = (DescribeImagesRequest)obj;
if (other.getImageIds() == null ^ this.getImageIds() == null) return false;
if (other.getImageIds() != null && other.getImageIds().equals(this.getImageIds()) == false) return false;
if (other.getOwners() == null ^ this.getOwners() == null) return false;
if (other.getOwners() != null && other.getOwners().equals(this.getOwners()) == false) return false;
if (other.getExecutableUsers() == null ^ this.getExecutableUsers() == null) return false;
if (other.getExecutableUsers() != null && other.getExecutableUsers().equals(this.getExecutableUsers()) == false) return false;
if (other.getFilters() == null ^ this.getFilters() == null) return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false;
return true;
}
}