Class BudgetParameter

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

Individual budget parameter configuration that defines specific budget allocation settings for access budgets.

See Also:

  • Method Details

    • type

      public final AccessBudgetType type()

      The type of budget parameter being configured.

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

      Returns:
      The type of budget parameter being configured.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of budget parameter being configured.

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

      Returns:
      The type of budget parameter being configured.
      See Also:

    • budget

      public final Integer budget()

      The budget allocation amount for this specific parameter.

      Returns:
      The budget allocation amount for this specific parameter.

    • autoRefresh

      public final AutoRefreshMode autoRefresh()

      Whether this individual budget parameter automatically refreshes when the budget period resets.

      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:
      Whether this individual budget parameter automatically refreshes when the budget period resets.
      See Also:

    • autoRefreshAsString

      public final String autoRefreshAsString()

      Whether this individual budget parameter automatically refreshes when the budget period resets.

      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:
      Whether this individual budget parameter automatically refreshes when the budget period resets.
      See Also:

    • toBuilder

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

    • builder

      public static BudgetParameter.Builder builder()

    • serializableBuilderClass

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