Class Reservation

java.lang.Object
software.amazon.awssdk.services.mediaconnect.model.Reservation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Reservation.Builder,Reservation>
@Generated("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:

  • Method Details

    • currencyCode

      public final 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 final 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 final 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:

    • durationUnitsAsString

      public final 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:

    • end

      public final 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 final 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 final 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 final 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 final 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:

    • priceUnitsAsString

      public final 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:

    • reservationArn

      public final 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 final 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 final 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:

    • reservationStateAsString

      public final 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:

    • resourceSpecification

      public final 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 final 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()
      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 interface ToCopyableBuilder<Reservation.Builder,Reservation>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.