Package software.amazon.awssdk.services.redshift.model

Class ReservedNode

java.lang.Object
software.amazon.awssdk.services.redshift.model.ReservedNode
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ReservedNode.Builder,ReservedNode>
@Generated("software.amazon.awssdk:codegen") public final class ReservedNode extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReservedNode.Builder,ReservedNode>

Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.

See Also:

  • Method Details

    • reservedNodeId

      public final String reservedNodeId()

      The unique identifier for the reservation.

      Returns:
      The unique identifier for the reservation.

    • reservedNodeOfferingId

      public final String reservedNodeOfferingId()

      The identifier for the reserved node offering.

      Returns:
      The identifier for the reserved node offering.

    • nodeType

      public final String nodeType()

      The node type of the reserved node.

      Returns:
      The node type of the reserved node.

    • startTime

      public final Instant startTime()

      The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

      Returns:
      The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

    • duration

      public final Integer duration()

      The duration of the node reservation in seconds.

      Returns:
      The duration of the node reservation in seconds.

    • fixedPrice

      public final Double fixedPrice()

      The fixed cost Amazon Redshift charges you for this reserved node.

      Returns:
      The fixed cost Amazon Redshift charges you for this reserved node.

    • usagePrice

      public final Double usagePrice()

      The hourly rate Amazon Redshift charges you for this reserved node.

      Returns:
      The hourly rate Amazon Redshift charges you for this reserved node.

    • currencyCode

      public final String currencyCode()

      The currency code for the reserved cluster.

      Returns:
      The currency code for the reserved cluster.

    • nodeCount

      public final Integer nodeCount()

      The number of reserved compute nodes.

      Returns:
      The number of reserved compute nodes.

    • state

      public final String state()

      The state of the reserved compute node.

      Possible Values:

      • pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.

      • active-This reserved node is owned by the caller and is available for use.

      • payment-failed-Payment failed for the purchase attempt.

      • retired-The reserved node is no longer available.

      • exchanging-The owner is exchanging the reserved node for another reserved node.

      Returns:
      The state of the reserved compute node.

      Possible Values:

      • pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.

      • active-This reserved node is owned by the caller and is available for use.

      • payment-failed-Payment failed for the purchase attempt.

      • retired-The reserved node is no longer available.

      • exchanging-The owner is exchanging the reserved node for another reserved node.

    • offeringType

      public final String offeringType()

      The anticipated utilization of the reserved node, as defined in the reserved node offering.

      Returns:
      The anticipated utilization of the reserved node, as defined in the reserved node offering.

    • 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 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.

    • recurringCharges

      public final List<RecurringCharge> recurringCharges()

      The recurring charges for the reserved node.

      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:
      The recurring charges for the reserved node.

    • reservedNodeOfferingType

      public final ReservedNodeOfferingType reservedNodeOfferingType()

      If the service returns an enum value that is not available in the current SDK version, reservedNodeOfferingType will return ReservedNodeOfferingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reservedNodeOfferingTypeAsString().

      Returns:
      See Also:

    • reservedNodeOfferingTypeAsString

      public final String reservedNodeOfferingTypeAsString()

      If the service returns an enum value that is not available in the current SDK version, reservedNodeOfferingType will return ReservedNodeOfferingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reservedNodeOfferingTypeAsString().

      Returns:
      See Also:

    • toBuilder

      public ReservedNode.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<ReservedNode.Builder,ReservedNode>
      Returns:
      a builder for type T

    • builder

      public static ReservedNode.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ReservedNode.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.