Class UpdateBudgetRequest

    • Method Detail

      • hasActionsToAdd

        public final boolean hasActionsToAdd()
        For responses, this returns true if the service returned a value for the ActionsToAdd property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
      • actionsToAdd

        public final List<BudgetActionToAdd> actionsToAdd()

        The budget actions to add. Budget actions specify what happens when the budget runs out.

        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 hasActionsToAdd() method.

        Returns:
        The budget actions to add. Budget actions specify what happens when the budget runs out.
      • hasActionsToRemove

        public final boolean hasActionsToRemove()
        For responses, this returns true if the service returned a value for the ActionsToRemove property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
      • actionsToRemove

        public final List<BudgetActionToRemove> actionsToRemove()

        The budget actions to remove from the budget.

        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 hasActionsToRemove() method.

        Returns:
        The budget actions to remove from the budget.
      • approximateDollarLimit

        public final Float approximateDollarLimit()

        The dollar limit to update on the budget. Based on consumed usage.

        Returns:
        The dollar limit to update on the budget. Based on consumed usage.
      • budgetId

        public final String budgetId()

        The budget ID to update.

        Returns:
        The budget ID to update.
      • clientToken

        public final String clientToken()

        The unique token which the server uses to recognize retries of the same request.

        Returns:
        The unique token which the server uses to recognize retries of the same request.
      • description

        public final String description()

        The description of the budget to update.

        Returns:
        The description of the budget to update.
      • displayName

        public final String displayName()

        The display name of the budget to update.

        Returns:
        The display name of the budget to update.
      • farmId

        public final String farmId()

        The farm ID of the budget to update.

        Returns:
        The farm ID of the budget to update.
      • schedule

        public final BudgetSchedule schedule()

        The schedule to update.

        Returns:
        The schedule to update.
      • status

        public final BudgetStatus status()

        Updates the status of the budget.

        • ACTIVE–The budget is being evaluated.

        • INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

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

        Returns:
        Updates the status of the budget.

        • ACTIVE–The budget is being evaluated.

        • INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

        See Also:
        BudgetStatus
      • statusAsString

        public final String statusAsString()

        Updates the status of the budget.

        • ACTIVE–The budget is being evaluated.

        • INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

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

        Returns:
        Updates the status of the budget.

        • ACTIVE–The budget is being evaluated.

        • INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

        See Also:
        BudgetStatus
      • 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