com.amazonaws.services.ec2.model

Class DescribeFpgaImagesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeFpgaImagesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribeFpgaImagesRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeFpgaImagesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeFpgaImagesRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeFpgaImagesRequest()

Method Summary

Modifier and Type	Method and Description
DescribeFpgaImagesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Request<DescribeFpgaImagesRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() One or more filters.
List<String>	getFpgaImageIds() One or more AFI IDs.
Integer	getMaxResults() The maximum number of results to return in a single call.
String	getNextToken() The token to retrieve the next page of results.
List<String>	getOwners() Filters the AFI by owner.
int	hashCode()
void	setFilters(Collection<Filter> filters) One or more filters.
void	setFpgaImageIds(Collection<String> fpgaImageIds) One or more AFI IDs.
void	setMaxResults(Integer maxResults) The maximum number of results to return in a single call.
void	setNextToken(String nextToken) The token to retrieve the next page of results.
void	setOwners(Collection<String> owners) Filters the AFI by owner.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeFpgaImagesRequest	withFilters(Collection<Filter> filters) One or more filters.
DescribeFpgaImagesRequest	withFilters(Filter... filters) One or more filters.
DescribeFpgaImagesRequest	withFpgaImageIds(Collection<String> fpgaImageIds) One or more AFI IDs.
DescribeFpgaImagesRequest	withFpgaImageIds(String... fpgaImageIds) One or more AFI IDs.
DescribeFpgaImagesRequest	withMaxResults(Integer maxResults) The maximum number of results to return in a single call.
DescribeFpgaImagesRequest	withNextToken(String nextToken) The token to retrieve the next page of results.
DescribeFpgaImagesRequest	withOwners(Collection<String> owners) Filters the AFI by owner.
DescribeFpgaImagesRequest	withOwners(String... owners) Filters the AFI by owner.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeFpgaImagesRequest

public DescribeFpgaImagesRequest()

Method Detail

getFpgaImageIds

public List<String> getFpgaImageIds()

One or more AFI IDs.

Returns:

One or more AFI IDs.

setFpgaImageIds

public void setFpgaImageIds(Collection<String> fpgaImageIds)

One or more AFI IDs.

Parameters:

fpgaImageIds - One or more AFI IDs.

withFpgaImageIds

public DescribeFpgaImagesRequest withFpgaImageIds(String... fpgaImageIds)

One or more AFI IDs.

NOTE: This method appends the values to the existing list (if any). Use setFpgaImageIds(java.util.Collection) or withFpgaImageIds(java.util.Collection) if you want to override the existing values.

Parameters:

fpgaImageIds - One or more AFI IDs.

Returns:

Returns a reference to this object so that method calls can be chained together.

withFpgaImageIds

public DescribeFpgaImagesRequest withFpgaImageIds(Collection<String> fpgaImageIds)

One or more AFI IDs.

Parameters:

fpgaImageIds - One or more AFI IDs.

Returns:

Returns a reference to this object so that method calls can be chained together.

getOwners

public List<String> getOwners()

Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

Returns:

Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

setOwners

public void setOwners(Collection<String> owners)

Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

Parameters:

owners - Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

withOwners

public DescribeFpgaImagesRequest withOwners(String... owners)

Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

NOTE: This method appends the values to the existing list (if any). Use setOwners(java.util.Collection) or withOwners(java.util.Collection) if you want to override the existing values.

Parameters:

owners - Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

Returns:

Returns a reference to this object so that method calls can be chained together.

withOwners

public DescribeFpgaImagesRequest withOwners(Collection<String> owners)

Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

Parameters:

owners - Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

Returns:

Returns a reference to this object so that method calls can be chained together.

getFilters

public List<Filter> getFilters()

One or more 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 AWS account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the AWS Shell that was used to create the bitstream.

• state - The state of the AFI (pending | failed | available | unavailable).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• 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.

• update-time - The time of the most recent update.

Returns:

One or more 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 AWS account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the AWS Shell that was used to create the bitstream.

• state - The state of the AFI (pending | failed | available | unavailable).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• 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.

• update-time - The time of the most recent update.

setFilters

public void setFilters(Collection<Filter> filters)

One or more 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 AWS account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the AWS Shell that was used to create the bitstream.

• state - The state of the AFI (pending | failed | available | unavailable).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• 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.

• update-time - The time of the most recent update.

Parameters:

filters - One or more 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 AWS account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the AWS Shell that was used to create the bitstream.

• state - The state of the AFI (pending | failed | available | unavailable).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• 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.

• update-time - The time of the most recent update.

withFilters

public DescribeFpgaImagesRequest withFilters(Filter... filters)

One or more 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 AWS account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the AWS Shell that was used to create the bitstream.

• state - The state of the AFI (pending | failed | available | unavailable).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• 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.

• update-time - The time of the most recent update.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - One or more 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 AWS account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the AWS Shell that was used to create the bitstream.

• state - The state of the AFI (pending | failed | available | unavailable).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• 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.

• update-time - The time of the most recent update.

Returns:

Returns a reference to this object so that method calls can be chained together.

withFilters

public DescribeFpgaImagesRequest withFilters(Collection<Filter> filters)

One or more 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 AWS account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the AWS Shell that was used to create the bitstream.

• state - The state of the AFI (pending | failed | available | unavailable).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• 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.

• update-time - The time of the most recent update.

Parameters:

filters - One or more 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 AWS account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the AWS Shell that was used to create the bitstream.

• state - The state of the AFI (pending | failed | available | unavailable).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• 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.

• update-time - The time of the most recent update.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

The token to retrieve the next page of results.

Parameters:

nextToken - The token to retrieve the next page of results.

getNextToken

public String getNextToken()

The token to retrieve the next page of results.

Returns:

The token to retrieve the next page of results.

withNextToken

public DescribeFpgaImagesRequest withNextToken(String nextToken)

The token to retrieve the next page of results.

Parameters:

nextToken - The token to retrieve the next page of results.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return in a single call.

Parameters:

maxResults - The maximum number of results to return in a single call.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return in a single call.

Returns:

The maximum number of results to return in a single call.

withMaxResults

public DescribeFpgaImagesRequest withMaxResults(Integer maxResults)

The maximum number of results to return in a single call.

Parameters:

maxResults - The maximum number of results to return in a single call.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDryRunRequest

public Request<DescribeFpgaImagesRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeFpgaImagesRequest>

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeFpgaImagesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()