Interface AccessBudgetDetails.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AccessBudgetDetails.Builder,AccessBudgetDetails>, SdkBuilder<AccessBudgetDetails.Builder,AccessBudgetDetails>, SdkPojo
Enclosing class:
AccessBudgetDetails
@Mutable @NotThreadSafe public static interface AccessBudgetDetails.Builder extends SdkPojo, CopyableBuilder<AccessBudgetDetails.Builder,AccessBudgetDetails>

  • Method Details

    • startTime

      AccessBudgetDetails.Builder startTime(Instant startTime)

      The start time for the access budget period.

      Parameters:
      startTime - The start time for the access budget period.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      AccessBudgetDetails.Builder endTime(Instant endTime)

      The end time for the access budget period.

      Parameters:
      endTime - The end time for the access budget period.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • remainingBudget

      AccessBudgetDetails.Builder remainingBudget(Integer remainingBudget)

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

      Parameters:
      remainingBudget - The remaining budget amount available for use within this access budget.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • budget

      AccessBudgetDetails.Builder budget(Integer budget)

      The total budget allocation amount for this access budget.

      Parameters:
      budget - The total budget allocation amount for this access budget.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • budgetType

      AccessBudgetDetails.Builder budgetType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • budgetType

      AccessBudgetDetails.Builder budgetType(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • autoRefresh

      AccessBudgetDetails.Builder autoRefresh(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • autoRefresh

      AccessBudgetDetails.Builder autoRefresh(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: