Class SpendingLimitSummary

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

Contains summary information about a spending limit, including current spending status and configuration details.

See Also:

  • Method Details

    • spendingLimitArn

      public final String spendingLimitArn()

      The Amazon Resource Name (ARN) that uniquely identifies the spending limit.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies the spending limit.

    • deviceArn

      public final String deviceArn()

      The Amazon Resource Name (ARN) of the quantum device associated with this spending limit.

      Returns:
      The Amazon Resource Name (ARN) of the quantum device associated with this spending limit.

    • timePeriod

      public final TimePeriod timePeriod()

      The time period during which the spending limit is active.

      Returns:
      The time period during which the spending limit is active.

    • spendingLimit

      public final String spendingLimit()

      The maximum spending amount allowed for the device during the specified time period, in USD.

      Returns:
      The maximum spending amount allowed for the device during the specified time period, in USD.

    • queuedSpend

      public final String queuedSpend()

      The amount currently queued for spending on the device, in USD.

      Returns:
      The amount currently queued for spending on the device, in USD.

    • totalSpend

      public final String totalSpend()

      The total amount spent on the device so far during the current time period, in USD.

      Returns:
      The total amount spent on the device so far during the current time period, in USD.

    • createdAt

      public final Instant createdAt()

      The date and time when the spending limit was created, in epoch seconds.

      Returns:
      The date and time when the spending limit was created, in epoch seconds.

    • updatedAt

      public final Instant updatedAt()

      The date and time when the spending limit was last modified, in epoch seconds.

      Returns:
      The date and time when the spending limit was last modified, in epoch seconds.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags associated with the spending limit. Each tag consists of a key and an optional value.

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

      Returns:
      The tags associated with the spending limit. Each tag consists of a key and an optional value.

    • toBuilder

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

    • builder

      public static SpendingLimitSummary.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.