Package com.oracle.bmc.batch.model

Class BatchJob.Builder

  • Enclosing class:
    BatchJob
    public static class BatchJob.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public BatchJob.Builder id​(String id)
        The OCID of the batch job.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • compartmentId

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

      • batchJobPoolId

        public BatchJob.Builder batchJobPoolId​(String batchJobPoolId)
        The OCID of the parent batch job pool.
        Parameters:
        batchJobPoolId - the value to set
        Returns:
        this builder

      • batchContextId

        public BatchJob.Builder batchContextId​(String batchContextId)
        The OCID of the parent batch context of the parent job pool.
        Parameters:
        batchContextId - the value to set
        Returns:
        this builder

      • displayName

        public BatchJob.Builder displayName​(String displayName)
        A user-friendly name.

        Does not have to be unique, and it’s changeable.

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

      • description

        public BatchJob.Builder description​(String description)
        An optional description that provides additional context next to the displayName.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • priority

        public BatchJob.Builder priority​(Integer priority)
        A value calculated by the system based on the priority tags.
        Parameters:
        priority - the value to set
        Returns:
        this builder

      • progressPercentage

        public BatchJob.Builder progressPercentage​(Integer progressPercentage)
        A percentage value (0..100) of the job completion.
        Parameters:
        progressPercentage - the value to set
        Returns:
        this builder

      • progressDetails

        public BatchJob.Builder progressDetails​(String progressDetails)
        A more detailed textual representation of the job completion.
        Parameters:
        progressDetails - the value to set
        Returns:
        this builder

      • environmentVariables

        public BatchJob.Builder environmentVariables​(List<EnvironmentVariable> environmentVariables)
        An environment variables to use for the job’s tasks (can be overridden by task’s environment variables).
        Parameters:
        environmentVariables - the value to set
        Returns:
        this builder

      • timeCreated

        public BatchJob.Builder timeCreated​(Date timeCreated)
        The date and time the batch job was created, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

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

      • timeUpdated

        public BatchJob.Builder timeUpdated​(Date timeUpdated)
        The date and time the batch job was updated, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

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

      • lifecycleState

        public BatchJob.Builder lifecycleState​(BatchJob.LifecycleState lifecycleState)
        The current state of the batch job.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public BatchJob.Builder lifecycleDetails​(String lifecycleDetails)
        A message that describes the current state of the batch job in more detail.

        For example, can be used to provide actionable information for a resource in the Failed state.

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

      • freeformTags

        public BatchJob.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 BatchJob.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

      • systemTags

        public BatchJob.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        System tags for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

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