Class Reservation
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Reservation.Builder,
Reservation>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
Unique reservation ARN, e.g.static Reservation.Builder
builder()
final Integer
count()
Number of reserved resourcesfinal String
Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g.final Integer
duration()
Lease duration, e.g.final OfferingDurationUnits
Units for duration, e.g.final String
Units for duration, e.g.final String
end()
Reservation UTC end date and time in ISO-8601 format, e.g.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Double
One-time charge for each reserved resource, e.g.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
User specified reservation namefinal String
Offering description, e.g.final String
Unique offering ID, e.g.final OfferingType
Offering type, e.g.final String
Offering type, e.g.final String
region()
AWS region, e.g.final RenewalSettings
Renewal settings for the reservationfinal String
Unique reservation ID, e.g.Resource configuration detailsstatic Class
<? extends Reservation.Builder> final String
start()
Reservation UTC start date and time in ISO-8601 format, e.g.final ReservationState
state()
Current state of reservation, e.g.final String
Current state of reservation, e.g.tags()
A collection of key-value pairsTake 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 Double
Recurring usage charge for each reserved resource, e.g.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'- Returns:
- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
-
count
Number of reserved resources- Returns:
- Number of reserved resources
-
currencyCode
Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'- Returns:
- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
-
duration
Lease duration, e.g. '12'- Returns:
- Lease duration, e.g. '12'
-
durationUnits
Units for duration, e.g. 'MONTHS'If the service returns an enum value that is not available in the current SDK version,
durationUnits
will returnOfferingDurationUnits.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdurationUnitsAsString()
.- Returns:
- Units for duration, e.g. 'MONTHS'
- See Also:
-
durationUnitsAsString
Units for duration, e.g. 'MONTHS'If the service returns an enum value that is not available in the current SDK version,
durationUnits
will returnOfferingDurationUnits.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdurationUnitsAsString()
.- Returns:
- Units for duration, e.g. 'MONTHS'
- See Also:
-
end
Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'- Returns:
- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
-
fixedPrice
One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering- Returns:
- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
-
name
User specified reservation name- Returns:
- User specified reservation name
-
offeringDescription
Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'- Returns:
- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
-
offeringId
Unique offering ID, e.g. '87654321'- Returns:
- Unique offering ID, e.g. '87654321'
-
offeringType
Offering type, e.g. 'NO_UPFRONT'If the service returns an enum value that is not available in the current SDK version,
offeringType
will returnOfferingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingTypeAsString()
.- Returns:
- Offering type, e.g. 'NO_UPFRONT'
- See Also:
-
offeringTypeAsString
Offering type, e.g. 'NO_UPFRONT'If the service returns an enum value that is not available in the current SDK version,
offeringType
will returnOfferingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingTypeAsString()
.- Returns:
- Offering type, e.g. 'NO_UPFRONT'
- See Also:
-
region
AWS region, e.g. 'us-west-2'- Returns:
- AWS region, e.g. 'us-west-2'
-
renewalSettings
Renewal settings for the reservation- Returns:
- Renewal settings for the reservation
-
reservationId
Unique reservation ID, e.g. '1234567'- Returns:
- Unique reservation ID, e.g. '1234567'
-
resourceSpecification
Resource configuration details- Returns:
- Resource configuration details
-
start
Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'- Returns:
- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
-
state
Current state of reservation, e.g. 'ACTIVE'If the service returns an enum value that is not available in the current SDK version,
state
will returnReservationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- Current state of reservation, e.g. 'ACTIVE'
- See Also:
-
stateAsString
Current state of reservation, e.g. 'ACTIVE'If the service returns an enum value that is not available in the current SDK version,
state
will returnReservationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- Current state of reservation, e.g. 'ACTIVE'
- See Also:
-
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
A collection of key-value pairsAttempts 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:
- A collection of key-value pairs
-
usagePrice
Recurring usage charge for each reserved resource, e.g. '157.0'- Returns:
- Recurring usage charge for each reserved resource, e.g. '157.0'
-
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<Reservation.Builder,
Reservation> - 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
-