Class AccessBudgetDetails

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

The detailed information for a specific budget period, including time boundaries and budget amounts.

See Also:

  • Method Details

    • startTime

      public final Instant startTime()

      The start time of this budget period.

      Returns:
      The start time of this budget period.

    • endTime

      public final Instant endTime()

      The end time of this budget period. If not specified, the budget period continues indefinitely.

      Returns:
      The end time of this budget period. If not specified, the budget period continues indefinitely.

    • remainingBudget

      public final Integer remainingBudget()

      The amount of budget remaining in this period.

      Returns:
      The amount of budget remaining in this period.

    • budget

      public final Integer budget()

      The total budget amount allocated for this period.

      Returns:
      The total budget amount allocated for this period.

    • budgetType

      public final AccessBudgetType budgetType()

      The type of budget period. Calendar-based types reset automatically at regular intervals, while LIFETIME budgets never reset.

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

      Returns:
      The type of budget period. Calendar-based types reset automatically at regular intervals, while LIFETIME budgets never reset.
      See Also:

    • budgetTypeAsString

      public final String budgetTypeAsString()

      The type of budget period. Calendar-based types reset automatically at regular intervals, while LIFETIME budgets never reset.

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

      Returns:
      The type of budget period. Calendar-based types reset automatically at regular intervals, while LIFETIME budgets never reset.
      See Also:

    • autoRefresh

      public final AutoRefreshMode autoRefresh()

      Specifies whether this budget automatically refreshes when the current period ends.

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

      Returns:
      Specifies whether this budget automatically refreshes when the current period ends.
      See Also:

    • autoRefreshAsString

      public final String autoRefreshAsString()

      Specifies whether this budget automatically refreshes when the current period ends.

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

      Returns:
      Specifies whether this budget automatically refreshes when the current period ends.
      See Also:

    • toBuilder

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

    • builder

      public static AccessBudgetDetails.Builder builder()

    • serializableBuilderClass

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