Reservation (AWS Java SDK :: Services :: AWS Elemental MediaLive 2.18.21 API)

java.lang.Object
- software.amazon.awssdk.services.medialive.model.Reservation

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Reservation.Builder,Reservation>

@Generated(value="software.amazon.awssdk:codegen")
public final class Reservation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Reservation.Builder,Reservation>

Reserved resources available to use

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Reservation.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Reservation.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` Unique reservation ARN, e.g.
`static Reservation.Builder`	`builder()`
`Integer`	`count()` Number of reserved resources
`String`	`currencyCode()` Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g.
`Integer`	`duration()` Lease duration, e.g.
`OfferingDurationUnits`	`durationUnits()` Units for duration, e.g.
`String`	`durationUnitsAsString()` Units for duration, e.g.
`String`	`end()` Reservation UTC end date and time in ISO-8601 format, e.g.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Double`	`fixedPrice()` One-time charge for each reserved resource, e.g.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`name()` User specified reservation name
`String`	`offeringDescription()` Offering description, e.g.
`String`	`offeringId()` Unique offering ID, e.g.
`OfferingType`	`offeringType()` Offering type, e.g.
`String`	`offeringTypeAsString()` Offering type, e.g.
`String`	`region()` AWS region, e.g.
`RenewalSettings`	`renewalSettings()` Renewal settings for the reservation
`String`	`reservationId()` Unique reservation ID, e.g.
`ReservationResourceSpecification`	`resourceSpecification()` Resource configuration details
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Reservation.Builder>`	`serializableBuilderClass()`
`String`	`start()` Reservation UTC start date and time in ISO-8601 format, e.g.
`ReservationState`	`state()` Current state of reservation, e.g.
`String`	`stateAsString()` Current state of reservation, e.g.
`Map<String,String>`	`tags()` A collection of key-value pairs
`Reservation.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Double`	`usagePrice()` Recurring usage charge for each reserved resource, e.g.

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
  - arn
```
public final String 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
```
public final Integer count()
```
    Number of reserved resources
    
    Returns:
    
    Number of reserved resources
  - currencyCode
```
public final String 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
```
public final Integer duration()
```
    Lease duration, e.g. '12'
    
    Returns:
    
    Lease duration, e.g. '12'
  - durationUnits
```
public final OfferingDurationUnits 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 return OfferingDurationUnits.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from durationUnitsAsString().
    
    Returns:
    
    Units for duration, e.g. 'MONTHS'
    
    See Also:
    
    OfferingDurationUnits
  - durationUnitsAsString
```
public final String 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 return OfferingDurationUnits.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from durationUnitsAsString().
    
    Returns:
    
    Units for duration, e.g. 'MONTHS'
    
    See Also:
    
    OfferingDurationUnits
  - end
```
public final String 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
```
public final Double 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
```
public final String name()
```
    User specified reservation name
    
    Returns:
    
    User specified reservation name
  - offeringDescription
```
public final String 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
```
public final String offeringId()
```
    Unique offering ID, e.g. '87654321'
    
    Returns:
    
    Unique offering ID, e.g. '87654321'
  - offeringType
```
public final OfferingType 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 return OfferingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringTypeAsString().
    
    Returns:
    
    Offering type, e.g. 'NO_UPFRONT'
    
    See Also:
    
    OfferingType
  - offeringTypeAsString
```
public final String 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 return OfferingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringTypeAsString().
    
    Returns:
    
    Offering type, e.g. 'NO_UPFRONT'
    
    See Also:
    
    OfferingType
  - region
```
public final String region()
```
    AWS region, e.g. 'us-west-2'
    
    Returns:
    
    AWS region, e.g. 'us-west-2'
  - renewalSettings
```
public final RenewalSettings renewalSettings()
```
    Renewal settings for the reservation
    
    Returns:
    
    Renewal settings for the reservation
  - reservationId
```
public final String reservationId()
```
    Unique reservation ID, e.g. '1234567'
    
    Returns:
    
    Unique reservation ID, e.g. '1234567'
  - resourceSpecification
```
public final ReservationResourceSpecification resourceSpecification()
```
    Resource configuration details
    
    Returns:
    
    Resource configuration details
  - start
```
public final String 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
```
public final ReservationState 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 return ReservationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    Current state of reservation, e.g. 'ACTIVE'
    
    See Also:
    
    ReservationState
  - stateAsString
```
public final String 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 return ReservationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    Current state of reservation, e.g. 'ACTIVE'
    
    See Also:
    
    ReservationState
  - 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 the isEmpty() 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
```
public final Map<String,String> tags()
```
    A collection of key-value pairs
    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:
    
    A collection of key-value pairs
  - usagePrice
```
public final Double 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
```
public Reservation.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Reservation.Builder,Reservation>
  - builder
```
public static Reservation.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Reservation.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Reservation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

count

currencyCode

duration

durationUnits

durationUnitsAsString

end

fixedPrice

name

offeringDescription

offeringId

offeringType

offeringTypeAsString

region

renewalSettings

reservationId

resourceSpecification

start

state

stateAsString

hasTags

tags

usagePrice

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields