Class FpgaImage
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FpgaImage.Builder,
FpgaImage>
Describes an Amazon FPGA image (AFI).
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic FpgaImage.Builder
builder()
final Instant
The date and time the AFI was created.final Boolean
Indicates whether data retention support is enabled for the AFI.final String
The description of the AFI.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The global FPGA image identifier (AGFI ID).final String
The FPGA image identifier (AFI ID).final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InstanceTypes property.final boolean
For responses, this returns true if the service returned a value for the ProductCodes property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.The instance types supported by the AFI.final Boolean
isPublic()
Indicates whether the AFI is public.final String
name()
The name of the AFI.final String
The alias of the AFI owner.final String
ownerId()
The ID of the Amazon Web Services account that owns the AFI.final PciId
pciId()
Information about the PCI bus.final List
<ProductCode> The product codes for the AFI.static Class
<? extends FpgaImage.Builder> final String
The version of the Amazon Web Services Shell that was used to create the bitstream.final FpgaImageState
state()
Information about the state of the AFI.tags()
Any tags assigned to the AFI.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
The time of the most recent update to the AFI.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
fpgaImageId
The FPGA image identifier (AFI ID).
- Returns:
- The FPGA image identifier (AFI ID).
-
fpgaImageGlobalId
The global FPGA image identifier (AGFI ID).
- Returns:
- The global FPGA image identifier (AGFI ID).
-
name
The name of the AFI.
- Returns:
- The name of the AFI.
-
description
The description of the AFI.
- Returns:
- The description of the AFI.
-
shellVersion
The version of the Amazon Web Services Shell that was used to create the bitstream.
- Returns:
- The version of the Amazon Web Services Shell that was used to create the bitstream.
-
pciId
Information about the PCI bus.
- Returns:
- Information about the PCI bus.
-
state
Information about the state of the AFI.
- Returns:
- Information about the state of the AFI.
-
createTime
The date and time the AFI was created.
- Returns:
- The date and time the AFI was created.
-
updateTime
The time of the most recent update to the AFI.
- Returns:
- The time of the most recent update to the AFI.
-
ownerId
The ID of the Amazon Web Services account that owns the AFI.
- Returns:
- The ID of the Amazon Web Services account that owns the AFI.
-
ownerAlias
The alias of the AFI owner. Possible values include
self
,amazon
, andaws-marketplace
.- Returns:
- The alias of the AFI owner. Possible values include
self
,amazon
, andaws-marketplace
.
-
hasProductCodes
public final boolean hasProductCodes()For responses, this returns true if the service returned a value for the ProductCodes 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. -
productCodes
The product codes for the AFI.
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
hasProductCodes()
method.- Returns:
- The product codes for the AFI.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
Any tags assigned to the AFI.
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
hasTags()
method.- Returns:
- Any tags assigned to the AFI.
-
dataRetentionSupport
Indicates whether data retention support is enabled for the AFI.
- Returns:
- Indicates whether data retention support is enabled for the AFI.
-
hasInstanceTypes
public final boolean hasInstanceTypes()For responses, this returns true if the service returned a value for the InstanceTypes 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. -
instanceTypes
The instance types supported by the AFI.
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
hasInstanceTypes()
method.- Returns:
- The instance types supported by the AFI.
-
isPublic
Indicates whether the AFI is public.
- Returns:
- Indicates whether the AFI is public.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<FpgaImage.Builder,
FpgaImage> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-