Class CatalogItem
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CatalogItem.Builder,
CatalogItem>
Information about a catalog item.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic CatalogItem.Builder
builder()
final String
The ID of the catalog item.final List
<EC2Capacity> Information about the EC2 capacity of an item.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the EC2Capacities property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SupportedStorage property.final boolean
For responses, this returns true if the service returned a value for the SupportedUplinkGbps property.final CatalogItemStatus
The status of a catalog item.final String
The status of a catalog item.final Float
powerKva()
Information about the power draw of an item.static Class
<? extends CatalogItem.Builder> final List
<SupportedStorageEnum> The supported storage options for the catalog item.The supported storage options for the catalog item.The uplink speed this catalog item requires for the connection to the Region.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 Integer
The weight of the item in pounds.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
catalogItemId
The ID of the catalog item.
- Returns:
- The ID of the catalog item.
-
itemStatus
The status of a catalog item.
If the service returns an enum value that is not available in the current SDK version,
itemStatus
will returnCatalogItemStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromitemStatusAsString()
.- Returns:
- The status of a catalog item.
- See Also:
-
itemStatusAsString
The status of a catalog item.
If the service returns an enum value that is not available in the current SDK version,
itemStatus
will returnCatalogItemStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromitemStatusAsString()
.- Returns:
- The status of a catalog item.
- See Also:
-
hasEc2Capacities
public final boolean hasEc2Capacities()For responses, this returns true if the service returned a value for the EC2Capacities 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. -
ec2Capacities
Information about the EC2 capacity of an item.
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
hasEc2Capacities()
method.- Returns:
- Information about the EC2 capacity of an item.
-
powerKva
Information about the power draw of an item.
- Returns:
- Information about the power draw of an item.
-
weightLbs
The weight of the item in pounds.
- Returns:
- The weight of the item in pounds.
-
hasSupportedUplinkGbps
public final boolean hasSupportedUplinkGbps()For responses, this returns true if the service returned a value for the SupportedUplinkGbps 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. -
supportedUplinkGbps
The uplink speed this catalog item requires for the connection to the Region.
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
hasSupportedUplinkGbps()
method.- Returns:
- The uplink speed this catalog item requires for the connection to the Region.
-
supportedStorage
The supported storage options for the catalog item.
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
hasSupportedStorage()
method.- Returns:
- The supported storage options for the catalog item.
-
hasSupportedStorage
public final boolean hasSupportedStorage()For responses, this returns true if the service returned a value for the SupportedStorage 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. -
supportedStorageAsStrings
The supported storage options for the catalog item.
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
hasSupportedStorage()
method.- Returns:
- The supported storage options for the catalog item.
-
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<CatalogItem.Builder,
CatalogItem> - 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
-