Class AccessBudget
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AccessBudget.Builder,
AccessBudget>
Controls and tracks usage limits for associated configured tables within a collaboration across queries and job. Supports both period-based budgets that can renew (daily, weekly, or monthly) and fixed lifetime budgets. Contains the resource ARN, remaining budget information, and up to two budget configurations (period-based and lifetime). By default, table usage is unlimited unless a budget is configured.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
The total remaining budget across all budget parameters, showing the lower value between the per-period budget and lifetime budget for this access budget.static AccessBudget.Builder
builder()
final List
<AccessBudgetDetails> details()
Detailed budget information including time bounds, remaining budget, and refresh settings.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Details property.final int
hashCode()
final String
The Amazon Resource Name (ARN) of the access budget resource.static Class
<? extends AccessBudget.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
resourceArn
The Amazon Resource Name (ARN) of the access budget resource.
- Returns:
- The Amazon Resource Name (ARN) of the access budget resource.
-
hasDetails
public final boolean hasDetails()For responses, this returns true if the service returned a value for the Details property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
details
Detailed budget information including time bounds, remaining budget, and refresh settings.
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
hasDetails()
method.- Returns:
- Detailed budget information including time bounds, remaining budget, and refresh settings.
-
aggregateRemainingBudget
The total remaining budget across all budget parameters, showing the lower value between the per-period budget and lifetime budget for this access budget. For individual parameter budgets, see
remainingBudget
.- Returns:
- The total remaining budget across all budget parameters, showing the lower value between the per-period
budget and lifetime budget for this access budget. For individual parameter budgets, see
remainingBudget
.
-
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 interfaceToCopyableBuilder<AccessBudget.Builder,
AccessBudget> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-