Class Offering
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Offering.Builder,
Offering>
Represents the metadata of a device offering.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Offering.Builder
builder()
final String
A string that describes the offering.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 int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RecurringCharges property.final String
id()
The ID that corresponds to a device offering.final DevicePlatform
platform()
The platform of the device (for example,ANDROID
orIOS
).final String
The platform of the device (for example,ANDROID
orIOS
).final List
<RecurringCharge> Specifies whether there are recurring charges for the offering.static Class
<? extends Offering.Builder> 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 OfferingType
type()
The type of offering (for example,RECURRING
) for a device.final String
The type of offering (for example,RECURRING
) for a device.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The ID that corresponds to a device offering.
- Returns:
- The ID that corresponds to a device offering.
-
description
A string that describes the offering.
- Returns:
- A string that describes the offering.
-
type
The type of offering (for example,
RECURRING
) for a device.If the service returns an enum value that is not available in the current SDK version,
type
will returnOfferingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of offering (for example,
RECURRING
) for a device. - See Also:
-
typeAsString
The type of offering (for example,
RECURRING
) for a device.If the service returns an enum value that is not available in the current SDK version,
type
will returnOfferingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of offering (for example,
RECURRING
) for a device. - See Also:
-
platform
The platform of the device (for example,
ANDROID
orIOS
).If the service returns an enum value that is not available in the current SDK version,
platform
will returnDevicePlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The platform of the device (for example,
ANDROID
orIOS
). - See Also:
-
platformAsString
The platform of the device (for example,
ANDROID
orIOS
).If the service returns an enum value that is not available in the current SDK version,
platform
will returnDevicePlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The platform of the device (for example,
ANDROID
orIOS
). - See Also:
-
hasRecurringCharges
public final boolean hasRecurringCharges()For responses, this returns true if the service returned a value for the RecurringCharges 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. -
recurringCharges
Specifies whether there are recurring charges for the offering.
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
hasRecurringCharges()
method.- Returns:
- Specifies whether there are recurring charges for the offering.
-
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<Offering.Builder,
Offering> - 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
-