Class DescribeFpgaImagesRequest
- 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("software.amazon.awssdk:codegen") public final class DescribeFpgaImagesRequest extends Ec2Request implements ToCopyableBuilder<DescribeFpgaImagesRequest.Builder,DescribeFpgaImagesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeFpgaImagesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeFpgaImagesRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.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()
For responses, this returns true if the service returned a value for the Filters property.boolean
hasFpgaImageIds()
For responses, this returns true if the service returned a value for the FpgaImageIds property.int
hashCode()
boolean
hasOwners()
For responses, this returns true if the service returned a value for the Owners property.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
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
hasFpgaImageIds
public final boolean hasFpgaImageIds()
For responses, this returns true if the service returned a value for the FpgaImageIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
fpgaImageIds
public final List<String> fpgaImageIds()
The AFI IDs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFpgaImageIds()
method.- Returns:
- The AFI IDs.
-
hasOwners
public final boolean hasOwners()
For responses, this returns true if the service returned a value for the Owners property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
owners
public final List<String> 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 areamazon
|aws-marketplace
).Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOwners()
method.- Returns:
- 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 areamazon
|aws-marketplace
).
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
filters
public final 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 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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFilters()
method.- 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 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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 final String nextToken()
The token to retrieve the next page of results.
- Returns:
- The token to retrieve the next page of results.
-
maxResults
public final 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 interfaceToCopyableBuilder<DescribeFpgaImagesRequest.Builder,DescribeFpgaImagesRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeFpgaImagesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeFpgaImagesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-