Class AccessBudgetDetails

java.lang.Object
software.amazon.awssdk.services.cleanrooms.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>

Detailed information about an access budget including time bounds, budget allocation, and configuration settings.

See Also:

  • Method Details

    • startTime

      public final Instant startTime()

      The start time for the access budget period.

      Returns:
      The start time for the access budget period.

    • endTime

      public final Instant endTime()

      The end time for the access budget period.

      Returns:
      The end time for the access budget period.

    • remainingBudget

      public final Integer remainingBudget()

      The remaining budget amount available for use within this access budget.

      Returns:
      The remaining budget amount available for use within this access budget.

    • budget

      public final Integer budget()

      The total budget allocation amount for this access budget.

      Returns:
      The total budget allocation amount for this access budget.

    • budgetType

      public final AccessBudgetType budgetType()

      Specifies the time period for limiting table usage in queries and jobs. For calendar-based periods, the budget can renew if auto refresh is enabled. For lifetime budgets, the limit applies to the total usage throughout the collaboration. Valid values are:

      CALENDAR_DAY - Limit table usage per day.

      CALENDAR_WEEK - Limit table usage per week.

      CALENDAR_MONTH - Limit table usage per month.

      LIFETIME - Limit total table usage for the collaboration duration.

      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:
      Specifies the time period for limiting table usage in queries and jobs. For calendar-based periods, the budget can renew if auto refresh is enabled. For lifetime budgets, the limit applies to the total usage throughout the collaboration. Valid values are:

      CALENDAR_DAY - Limit table usage per day.

      CALENDAR_WEEK - Limit table usage per week.

      CALENDAR_MONTH - Limit table usage per month.

      LIFETIME - Limit total table usage for the collaboration duration.

      See Also:

    • budgetTypeAsString

      public final String budgetTypeAsString()

      Specifies the time period for limiting table usage in queries and jobs. For calendar-based periods, the budget can renew if auto refresh is enabled. For lifetime budgets, the limit applies to the total usage throughout the collaboration. Valid values are:

      CALENDAR_DAY - Limit table usage per day.

      CALENDAR_WEEK - Limit table usage per week.

      CALENDAR_MONTH - Limit table usage per month.

      LIFETIME - Limit total table usage for the collaboration duration.

      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:
      Specifies the time period for limiting table usage in queries and jobs. For calendar-based periods, the budget can renew if auto refresh is enabled. For lifetime budgets, the limit applies to the total usage throughout the collaboration. Valid values are:

      CALENDAR_DAY - Limit table usage per day.

      CALENDAR_WEEK - Limit table usage per week.

      CALENDAR_MONTH - Limit table usage per month.

      LIFETIME - Limit total table usage for the collaboration duration.

      See Also:

    • autoRefresh

      public final AutoRefreshMode autoRefresh()

      Indicates whether the budget automatically refreshes for each time period specified in budgetType. Valid values are:

      ENABLED - The budget refreshes automatically at the start of each period.

      DISABLED - The budget must be refreshed manually.

      NULL - The value is null when budgetType is set to LIFETIME.

      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:
      Indicates whether the budget automatically refreshes for each time period specified in budgetType. Valid values are:

      ENABLED - The budget refreshes automatically at the start of each period.

      DISABLED - The budget must be refreshed manually.

      NULL - The value is null when budgetType is set to LIFETIME.

      See Also:

    • autoRefreshAsString

      public final String autoRefreshAsString()

      Indicates whether the budget automatically refreshes for each time period specified in budgetType. Valid values are:

      ENABLED - The budget refreshes automatically at the start of each period.

      DISABLED - The budget must be refreshed manually.

      NULL - The value is null when budgetType is set to LIFETIME.

      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:
      Indicates whether the budget automatically refreshes for each time period specified in budgetType. Valid values are:

      ENABLED - The budget refreshes automatically at the start of each period.

      DISABLED - The budget must be refreshed manually.

      NULL - The value is null when budgetType is set to LIFETIME.

      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.