DescribeFpgaImagesRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.DescribeFpgaImagesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeFpgaImagesRequest.Builder,DescribeFpgaImagesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeFpgaImagesRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeFpgaImagesRequest.Builder,DescribeFpgaImagesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeFpgaImagesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeFpgaImagesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeFpgaImagesRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Filter>`	`filters()` The filters.
`List<String>`	`fpgaImageIds()` The AFI IDs.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilters()` Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasFpgaImageIds()` Returns true if the FpgaImageIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasOwners()` Returns true if the Owners property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Integer`	`maxResults()` The maximum number of results to return in a single call.
`String`	`nextToken()` The token to retrieve the next page of results.
`List<String>`	`owners()` Filters the AFI by owner.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeFpgaImagesRequest.Builder>`	`serializableBuilderClass()`
`DescribeFpgaImagesRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasFpgaImageIds
```
public boolean hasFpgaImageIds()
```
    Returns true if the FpgaImageIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - fpgaImageIds
```
public List<String> fpgaImageIds()
```
    The AFI IDs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasFpgaImageIds() to see if a value was sent in this field.
    
    Returns:
    
    The AFI IDs.
  - hasOwners
```
public boolean hasOwners()
```
    Returns true if the Owners property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - owners
```
public List<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).
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasOwners() to see if a value was sent in this field.
    
    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).
  - hasFilters
```
public boolean hasFilters()
```
    Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - filters
```
public List<Filter> 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 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> - 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasFilters() to see if a value was sent in this field.
    Returns:
    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 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> - 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.
  - nextToken
```
public String nextToken()
```
    The token to retrieve the next page of results.
    
    Returns:
    
    The token to retrieve the next page of results.
  - maxResults
```
public Integer maxResults()
```
    The maximum number of results to return in a single call.
    
    Returns:
    
    The maximum number of results to return in a single call.
  - toBuilder
```
public DescribeFpgaImagesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeFpgaImagesRequest.Builder,DescribeFpgaImagesRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeFpgaImagesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeFpgaImagesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeFpgaImagesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasFpgaImageIds

fpgaImageIds

hasOwners

owners

hasFilters

filters

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields