Package com.oracle.bmc.budget.model

Class CreateBudgetDetails.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • compartmentId

        public CreateBudgetDetails.Builder compartmentId​(String compartmentId)
        The OCID of the compartment.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • targetCompartmentId

        public CreateBudgetDetails.Builder targetCompartmentId​(String targetCompartmentId)
        This is DEPRECATED.

        Set the target compartment ID in targets instead.

        Parameters:
        targetCompartmentId - the value to set
        Returns:
        this builder

      • displayName

        public CreateBudgetDetails.Builder displayName​(String displayName)
        The displayName of the budget.

        Avoid entering confidential information.

        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • description

        public CreateBudgetDetails.Builder description​(String description)
        The description of the budget.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • amount

        public CreateBudgetDetails.Builder amount​(BigDecimal amount)
        The amount of the budget expressed as a whole number in the currency of the customer’s rate card.
        Parameters:
        amount - the value to set
        Returns:
        this builder

      • budgetProcessingPeriodStartOffset

        public CreateBudgetDetails.Builder budgetProcessingPeriodStartOffset​(Integer budgetProcessingPeriodStartOffset)
        The number of days offset from the first day of the month, at which the budget processing period starts.

        In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

        Parameters:
        budgetProcessingPeriodStartOffset - the value to set
        Returns:
        this builder

      • processingPeriodType

        public CreateBudgetDetails.Builder processingPeriodType​(ProcessingPeriodType processingPeriodType)
        The type of the budget processing period.

        Valid values are INVOICE, MONTH, and SINGLE_USE.

        Parameters:
        processingPeriodType - the value to set
        Returns:
        this builder

      • startDate

        public CreateBudgetDetails.Builder startDate​(Date startDate)
        The date when the one-time budget begins.

        For example, 2023-03-23. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.

        Parameters:
        startDate - the value to set
        Returns:
        this builder

      • endDate

        public CreateBudgetDetails.Builder endDate​(Date endDate)
        The date when the one-time budget concludes.

        For example, 2023-03-23. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.

        Parameters:
        endDate - the value to set
        Returns:
        this builder

      • targetType

        public CreateBudgetDetails.Builder targetType​(TargetType targetType)
        The type of target on which the budget is applied.
        Parameters:
        targetType - the value to set
        Returns:
        this builder

      • targets

        public CreateBudgetDetails.Builder targets​(List<String> targets)
        The list of targets on which the budget is applied.

        If targetType is “COMPARTMENT”, the targets contain the list of compartment OCIDs. If targetType is “TAG”, the targets contain the list of cost tracking tag identifiers in the form of “{tagNamespace}.{tagKey}.{tagValue}”. Curerntly, the array should contain exactly one item.

        Parameters:
        targets - the value to set
        Returns:
        this builder

      • freeformTags

        public CreateBudgetDetails.Builder freeformTags​(Map<String,​String> freeformTags)
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

        public CreateBudgetDetails.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder