Package software.amazon.awssdk.services.ec2.model

Class PurchaseHostReservationRequest

    • Method Detail

      • clientToken

        public final String clientToken()

        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

        Returns:
        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

      • currencyCode

        public final CurrencyCodeValues currencyCode()

        The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

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

        Returns:
        The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.
        See Also:
        CurrencyCodeValues

      • currencyCodeAsString

        public final String currencyCodeAsString()

        The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

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

        Returns:
        The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.
        See Also:
        CurrencyCodeValues

      • hasHostIdSet

        public final boolean hasHostIdSet()
        For responses, this returns true if the service returned a value for the HostIdSet 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.

      • hostIdSet

        public final List<String> hostIdSet()

        The IDs of the Dedicated Hosts with which the reservation will be associated.

        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 hasHostIdSet() method.

        Returns:
        The IDs of the Dedicated Hosts with which the reservation will be associated.

      • limitPrice

        public final String limitPrice()

        The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.

        Returns:
        The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.

      • offeringId

        public final String offeringId()

        The ID of the offering.

        Returns:
        The ID of the offering.

      • hasTagSpecifications

        public final boolean hasTagSpecifications()
        For responses, this returns true if the service returned a value for the TagSpecifications 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.

      • tagSpecifications

        public final List<TagSpecification> tagSpecifications()

        The tags to apply to the Dedicated Host Reservation during purchase.

        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 hasTagSpecifications() method.

        Returns:
        The tags to apply to the Dedicated Host Reservation during purchase.

      • 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