com.amazonaws.services.ec2.model.DescribeFpgaImagesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2018-2023 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeFpgaImagesRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeFpgaImagesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The AFI IDs.
*
*/
private com.amazonaws.internal.SdkInternalList fpgaImageIds;
/**
*
* Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of
* the request), or an Amazon Web Services owner alias (valid values are amazon |
* aws-marketplace).
*
*/
private com.amazonaws.internal.SdkInternalList owners;
/**
*
* The filters.
*
*
* -
*
* create-time - The creation time of the AFI.
*
*
* -
*
* fpga-image-id - The FPGA image identifier (AFI ID).
*
*
* -
*
* fpga-image-global-id - The global FPGA image identifier (AGFI ID).
*
*
* -
*
* name - The name of the AFI.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the AFI owner.
*
*
* -
*
* product-code - The product code.
*
*
* -
*
* shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
*
*
* -
*
* state - The state of the AFI (pending | failed | available |
* unavailable).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* update-time - The time of the most recent update.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The token to retrieve the next page of results.
*
*/
private String nextToken;
/**
*
* The maximum number of results to return in a single call.
*
*/
private Integer maxResults;
/**
*
* The AFI IDs.
*
*
* @return The AFI IDs.
*/
public java.util.List getFpgaImageIds() {
if (fpgaImageIds == null) {
fpgaImageIds = new com.amazonaws.internal.SdkInternalList();
}
return fpgaImageIds;
}
/**
*
* The AFI IDs.
*
*
* @param fpgaImageIds
* The AFI IDs.
*/
public void setFpgaImageIds(java.util.Collection fpgaImageIds) {
if (fpgaImageIds == null) {
this.fpgaImageIds = null;
return;
}
this.fpgaImageIds = new com.amazonaws.internal.SdkInternalList(fpgaImageIds);
}
/**
*
* The AFI IDs.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFpgaImageIds(java.util.Collection)} or {@link #withFpgaImageIds(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param fpgaImageIds
* The AFI IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFpgaImagesRequest withFpgaImageIds(String... fpgaImageIds) {
if (this.fpgaImageIds == null) {
setFpgaImageIds(new com.amazonaws.internal.SdkInternalList(fpgaImageIds.length));
}
for (String ele : fpgaImageIds) {
this.fpgaImageIds.add(ele);
}
return this;
}
/**
*
* The AFI IDs.
*
*
* @param fpgaImageIds
* The AFI IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFpgaImagesRequest withFpgaImageIds(java.util.Collection fpgaImageIds) {
setFpgaImageIds(fpgaImageIds);
return this;
}
/**
*
* Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of
* the request), or an Amazon Web Services owner alias (valid values are amazon |
* aws-marketplace).
*
*
* @return Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the
* sender of the request), or an Amazon Web Services owner alias (valid values are amazon |
* aws-marketplace).
*/
public java.util.List getOwners() {
if (owners == null) {
owners = new com.amazonaws.internal.SdkInternalList();
}
return owners;
}
/**
*
* Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of
* the request), or an Amazon Web Services owner alias (valid values are amazon |
* aws-marketplace).
*
*
* @param owners
* Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the
* sender of the request), or an Amazon Web Services owner alias (valid values are amazon |
* aws-marketplace).
*/
public void setOwners(java.util.Collection owners) {
if (owners == null) {
this.owners = null;
return;
}
this.owners = new com.amazonaws.internal.SdkInternalList(owners);
}
/**
*
* Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of
* the request), or an Amazon Web Services owner alias (valid values are amazon |
* aws-marketplace).
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setOwners(java.util.Collection)} or {@link #withOwners(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param owners
* Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the
* sender of the request), or an Amazon Web Services owner alias (valid values are amazon |
* aws-marketplace).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFpgaImagesRequest withOwners(String... owners) {
if (this.owners == null) {
setOwners(new com.amazonaws.internal.SdkInternalList(owners.length));
}
for (String ele : owners) {
this.owners.add(ele);
}
return this;
}
/**
*
* Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of
* the request), or an Amazon Web Services owner alias (valid values are amazon |
* aws-marketplace).
*
*
* @param owners
* Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the
* sender of the request), or an Amazon Web Services owner alias (valid values are amazon |
* aws-marketplace).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFpgaImagesRequest withOwners(java.util.Collection owners) {
setOwners(owners);
return this;
}
/**
*
* The filters.
*
*
* -
*
* create-time - The creation time of the AFI.
*
*
* -
*
* fpga-image-id - The FPGA image identifier (AFI ID).
*
*
* -
*
* fpga-image-global-id - The global FPGA image identifier (AGFI ID).
*
*
* -
*
* name - The name of the AFI.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the AFI owner.
*
*
* -
*
* product-code - The product code.
*
*
* -
*
* shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
*
*
* -
*
* state - The state of the AFI (pending | failed | available |
* unavailable).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* update-time - The time of the most recent update.
*
*
*
*
* @return The filters.
*
* -
*
* create-time - The creation time of the AFI.
*
*
* -
*
* fpga-image-id - The FPGA image identifier (AFI ID).
*
*
* -
*
* fpga-image-global-id - The global FPGA image identifier (AGFI ID).
*
*
* -
*
* name - The name of the AFI.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the AFI owner.
*
*
* -
*
* product-code - The product code.
*
*
* -
*
* shell-version - The version of the Amazon Web Services Shell that was used to create the
* bitstream.
*
*
* -
*
* state - The state of the AFI (pending | failed |
* available | unavailable).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that
* have a tag with the key Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* update-time - The time of the most recent update.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* The filters.
*
*
* -
*
* create-time - The creation time of the AFI.
*
*
* -
*
* fpga-image-id - The FPGA image identifier (AFI ID).
*
*
* -
*
* fpga-image-global-id - The global FPGA image identifier (AGFI ID).
*
*
* -
*
* name - The name of the AFI.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the AFI owner.
*
*
* -
*
* product-code - The product code.
*
*
* -
*
* shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
*
*
* -
*
* state - The state of the AFI (pending | failed | available |
* unavailable).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* update-time - The time of the most recent update.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* create-time - The creation time of the AFI.
*
*
* -
*
* fpga-image-id - The FPGA image identifier (AFI ID).
*
*
* -
*
* fpga-image-global-id - The global FPGA image identifier (AGFI ID).
*
*
* -
*
* name - The name of the AFI.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the AFI owner.
*
*
* -
*
* product-code - The product code.
*
*
* -
*
* shell-version - The version of the Amazon Web Services Shell that was used to create the
* bitstream.
*
*
* -
*
* state - The state of the AFI (pending | failed |
* available | unavailable).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* update-time - The time of the most recent update.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* The filters.
*
*
* -
*
* create-time - The creation time of the AFI.
*
*
* -
*
* fpga-image-id - The FPGA image identifier (AFI ID).
*
*
* -
*
* fpga-image-global-id - The global FPGA image identifier (AGFI ID).
*
*
* -
*
* name - The name of the AFI.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the AFI owner.
*
*
* -
*
* product-code - The product code.
*
*
* -
*
* shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
*
*
* -
*
* state - The state of the AFI (pending | failed | available |
* unavailable).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* update-time - The time of the most recent update.
*
*
*
*
* 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
* The filters.
*
* -
*
* create-time - The creation time of the AFI.
*
*
* -
*
* fpga-image-id - The FPGA image identifier (AFI ID).
*
*
* -
*
* fpga-image-global-id - The global FPGA image identifier (AGFI ID).
*
*
* -
*
* name - The name of the AFI.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the AFI owner.
*
*
* -
*
* product-code - The product code.
*
*
* -
*
* shell-version - The version of the Amazon Web Services Shell that was used to create the
* bitstream.
*
*
* -
*
* state - The state of the AFI (pending | failed |
* available | unavailable).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* update-time - The time of the most recent update.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFpgaImagesRequest 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;
}
/**
*
* The filters.
*
*
* -
*
* create-time - The creation time of the AFI.
*
*
* -
*
* fpga-image-id - The FPGA image identifier (AFI ID).
*
*
* -
*
* fpga-image-global-id - The global FPGA image identifier (AGFI ID).
*
*
* -
*
* name - The name of the AFI.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the AFI owner.
*
*
* -
*
* product-code - The product code.
*
*
* -
*
* shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
*
*
* -
*
* state - The state of the AFI (pending | failed | available |
* unavailable).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* update-time - The time of the most recent update.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* create-time - The creation time of the AFI.
*
*
* -
*
* fpga-image-id - The FPGA image identifier (AFI ID).
*
*
* -
*
* fpga-image-global-id - The global FPGA image identifier (AGFI ID).
*
*
* -
*
* name - The name of the AFI.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the AFI owner.
*
*
* -
*
* product-code - The product code.
*
*
* -
*
* shell-version - The version of the Amazon Web Services Shell that was used to create the
* bitstream.
*
*
* -
*
* state - The state of the AFI (pending | failed |
* available | unavailable).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* update-time - The time of the most recent update.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFpgaImagesRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The token to retrieve the next page of results.
*
*
* @param nextToken
* The token to retrieve the next page of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token to retrieve the next page of results.
*
*
* @return The token to retrieve the next page of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token to retrieve the next page of results.
*
*
* @param nextToken
* The token to retrieve the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFpgaImagesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of results to return in a single call.
*
*
* @param maxResults
* The maximum number of results to return in a single call.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return in a single call.
*
*
* @return The maximum number of results to return in a single call.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return in a single call.
*
*
* @param maxResults
* The maximum number of results to return in a single call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFpgaImagesRequest 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 DescribeFpgaImagesRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFpgaImageIds() != null)
sb.append("FpgaImageIds: ").append(getFpgaImageIds()).append(",");
if (getOwners() != null)
sb.append("Owners: ").append(getOwners()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(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 DescribeFpgaImagesRequest == false)
return false;
DescribeFpgaImagesRequest other = (DescribeFpgaImagesRequest) obj;
if (other.getFpgaImageIds() == null ^ this.getFpgaImageIds() == null)
return false;
if (other.getFpgaImageIds() != null && other.getFpgaImageIds().equals(this.getFpgaImageIds()) == 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.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 + ((getFpgaImageIds() == null) ? 0 : getFpgaImageIds().hashCode());
hashCode = prime * hashCode + ((getOwners() == null) ? 0 : getOwners().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 DescribeFpgaImagesRequest clone() {
return (DescribeFpgaImagesRequest) super.clone();
}
}