Reservation (AWS Java SDK :: Services :: MediaConnect 2.15.29 API)

java.lang.Object
- software.amazon.awssdk.services.mediaconnect.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>
```
A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.

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
`static Reservation.Builder`	`builder()`
`String`	`currencyCode()` The type of currency that is used for billing.
`Integer`	`duration()` The length of time that this reservation is active.
`DurationUnits`	`durationUnits()` The unit of measurement for the duration of the reservation.
`String`	`durationUnitsAsString()` The unit of measurement for the duration of the reservation.
`String`	`end()` The day and time that this reservation expires.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`offeringArn()` The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
`String`	`offeringDescription()` A description of the offering.
`String`	`pricePerUnit()` The cost of a single unit.
`PriceUnits`	`priceUnits()` The unit of measurement that is used for billing.
`String`	`priceUnitsAsString()` The unit of measurement that is used for billing.
`String`	`reservationArn()` The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
`String`	`reservationName()` The name that you assigned to the reservation when you purchased the offering.
`ReservationState`	`reservationState()` The status of your reservation.
`String`	`reservationStateAsString()` The status of your reservation.
`ResourceSpecification`	`resourceSpecification()` A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Reservation.Builder>`	`serializableBuilderClass()`
`String`	`start()` The day and time that the reservation becomes active.
`Reservation.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - currencyCode
```
public String currencyCode()
```
    The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
    
    Returns:
    
    The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
  - duration
```
public Integer duration()
```
    The length of time that this reservation is active. MediaConnect defines this value in the offering.
    
    Returns:
    
    The length of time that this reservation is active. MediaConnect defines this value in the offering.
  - durationUnits
```
public DurationUnits durationUnits()
```
    The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
    If the service returns an enum value that is not available in the current SDK version, durationUnits will return DurationUnits.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from durationUnitsAsString().
    
    Returns:
    
    The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
    
    See Also:
    
    DurationUnits
  - durationUnitsAsString
```
public String durationUnitsAsString()
```
    The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
    If the service returns an enum value that is not available in the current SDK version, durationUnits will return DurationUnits.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from durationUnitsAsString().
    
    Returns:
    
    The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
    
    See Also:
    
    DurationUnits
  - end
```
public String end()
```
    The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
    
    Returns:
    
    The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
  - offeringArn
```
public String offeringArn()
```
    The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
    
    Returns:
    
    The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
  - offeringDescription
```
public String offeringDescription()
```
    A description of the offering. MediaConnect defines this value in the offering.
    
    Returns:
    
    A description of the offering. MediaConnect defines this value in the offering.
  - pricePerUnit
```
public String pricePerUnit()
```
    The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
    
    Returns:
    
    The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
  - priceUnits
```
public PriceUnits priceUnits()
```
    The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.
    If the service returns an enum value that is not available in the current SDK version, priceUnits will return PriceUnits.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from priceUnitsAsString().
    
    Returns:
    
    The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.
    
    See Also:
    
    PriceUnits
  - priceUnitsAsString
```
public String priceUnitsAsString()
```
    The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.
    If the service returns an enum value that is not available in the current SDK version, priceUnits will return PriceUnits.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from priceUnitsAsString().
    
    Returns:
    
    The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.
    
    See Also:
    
    PriceUnits
  - reservationArn
```
public String reservationArn()
```
    The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
    
    Returns:
    
    The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
  - reservationName
```
public String reservationName()
```
    The name that you assigned to the reservation when you purchased the offering.
    
    Returns:
    
    The name that you assigned to the reservation when you purchased the offering.
  - reservationState
```
public ReservationState reservationState()
```
    The status of your reservation.
    If the service returns an enum value that is not available in the current SDK version, reservationState will return ReservationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reservationStateAsString().
    
    Returns:
    
    The status of your reservation.
    
    See Also:
    
    ReservationState
  - reservationStateAsString
```
public String reservationStateAsString()
```
    The status of your reservation.
    If the service returns an enum value that is not available in the current SDK version, reservationState will return ReservationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reservationStateAsString().
    
    Returns:
    
    The status of your reservation.
    
    See Also:
    
    ReservationState
  - resourceSpecification
```
public ResourceSpecification resourceSpecification()
```
    A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.
    
    Returns:
    
    A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.
  - start
```
public String start()
```
    The day and time that the reservation becomes active. You set this value when you purchase the offering.
    
    Returns:
    
    The day and time that the reservation becomes active. You set this value when you purchase the offering.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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

currencyCode

duration

durationUnits

durationUnitsAsString

end

offeringArn

offeringDescription

pricePerUnit

priceUnits

priceUnitsAsString

reservationArn

reservationName

reservationState

reservationStateAsString

resourceSpecification

start

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields