Package software.amazon.awssdk.services.elasticsearch.model

Class ReservedElasticsearchInstance

    • Method Detail

      • reservationName

        public final String reservationName()

        The customer-specified identifier to track this reservation.

        Returns:
        The customer-specified identifier to track this reservation.

      • reservedElasticsearchInstanceId

        public final String reservedElasticsearchInstanceId()

        The unique identifier for the reservation.

        Returns:
        The unique identifier for the reservation.

      • reservedElasticsearchInstanceOfferingId

        public final String reservedElasticsearchInstanceOfferingId()

        The offering identifier.

        Returns:
        The offering identifier.

      • elasticsearchInstanceTypeAsString

        public final String elasticsearchInstanceTypeAsString()

        The Elasticsearch instance type offered by the reserved instance offering.

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

        Returns:
        The Elasticsearch instance type offered by the reserved instance offering.
        See Also:
        ESPartitionInstanceType

      • startTime

        public final Instant startTime()

        The time the reservation started.

        Returns:
        The time the reservation started.

      • duration

        public final Integer duration()

        The duration, in seconds, for which the Elasticsearch instance is reserved.

        Returns:
        The duration, in seconds, for which the Elasticsearch instance is reserved.

      • fixedPrice

        public final Double fixedPrice()

        The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.

        Returns:
        The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.

      • usagePrice

        public final Double usagePrice()

        The rate you are charged for each hour for the domain that is using this reserved instance.

        Returns:
        The rate you are charged for each hour for the domain that is using this reserved instance.

      • currencyCode

        public final String currencyCode()

        The currency code for the reserved Elasticsearch instance offering.

        Returns:
        The currency code for the reserved Elasticsearch instance offering.

      • elasticsearchInstanceCount

        public final Integer elasticsearchInstanceCount()

        The number of Elasticsearch instances that have been reserved.

        Returns:
        The number of Elasticsearch instances that have been reserved.

      • state

        public final String state()

        The state of the reserved Elasticsearch instance.

        Returns:
        The state of the reserved Elasticsearch instance.

      • 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 charge to your account regardless of whether you are creating any domains using the instance offering.

        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 charge to your account regardless of whether you are creating any domains using the instance offering.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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