Class JobExecution.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • key

        public JobExecution.Builder key​(String key)
        Unique key of the job execution resource.
        Parameters:
        key - the value to set
        Returns:
        this builder
      • jobKey

        public JobExecution.Builder jobKey​(String jobKey)
        The unique key of the parent job.
        Parameters:
        jobKey - the value to set
        Returns:
        this builder
      • jobType

        public JobExecution.Builder jobType​(JobType jobType)
        Type of the job execution.
        Parameters:
        jobType - the value to set
        Returns:
        this builder
      • subType

        public JobExecution.Builder subType​(String subType)
        Sub-type of this job execution.
        Parameters:
        subType - the value to set
        Returns:
        this builder
      • parentKey

        public JobExecution.Builder parentKey​(String parentKey)
        The unique key of the parent execution or null if this job execution has no parent.
        Parameters:
        parentKey - the value to set
        Returns:
        this builder
      • scheduleInstanceKey

        public JobExecution.Builder scheduleInstanceKey​(String scheduleInstanceKey)
        The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.
        Parameters:
        scheduleInstanceKey - the value to set
        Returns:
        this builder
      • lifecycleState

        public JobExecution.Builder lifecycleState​(JobExecutionState lifecycleState)
        Status of the job execution, such as running, paused, or completed.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder
      • timeCreated

        public JobExecution.Builder timeCreated​(Date timeCreated)
        The date and time the job execution was created, in the format defined by RFC3339.

        Example: 2019-03-25T21:10:29.600Z

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

        public JobExecution.Builder timeStarted​(Date timeStarted)
        Time that job execution started.

        An RFC3339 formatted datetime string.

        Parameters:
        timeStarted - the value to set
        Returns:
        this builder
      • timeEnded

        public JobExecution.Builder timeEnded​(Date timeEnded)
        Time that the job execution ended or null if it hasn’t yet completed.

        An RFC3339 formatted datetime string.

        Parameters:
        timeEnded - the value to set
        Returns:
        this builder
      • errorCode

        public JobExecution.Builder errorCode​(String errorCode)
        Error code returned from the job execution or null if job is still running or didn’t return an error.
        Parameters:
        errorCode - the value to set
        Returns:
        this builder
      • errorMessage

        public JobExecution.Builder errorMessage​(String errorMessage)
        Error message returned from the job execution or null if job is still running or didn’t return an error.
        Parameters:
        errorMessage - the value to set
        Returns:
        this builder
      • processKey

        public JobExecution.Builder processKey​(String processKey)
        Process identifier related to the job execution if the job is an external job.
        Parameters:
        processKey - the value to set
        Returns:
        this builder
      • externalUrl

        public JobExecution.Builder externalUrl​(String externalUrl)
        If the job is an external process, then a URL of the job for accessing this resource and its status.
        Parameters:
        externalUrl - the value to set
        Returns:
        this builder
      • eventKey

        public JobExecution.Builder eventKey​(String eventKey)
        An identifier used for log message correlation.
        Parameters:
        eventKey - the value to set
        Returns:
        this builder
      • dataEntityKey

        public JobExecution.Builder dataEntityKey​(String dataEntityKey)
        The key of the associated data entity resource.
        Parameters:
        dataEntityKey - the value to set
        Returns:
        this builder
      • createdById

        public JobExecution.Builder createdById​(String createdById)
        OCID of the user who created the job execution.
        Parameters:
        createdById - the value to set
        Returns:
        this builder
      • updatedBy

        public JobExecution.Builder updatedBy​(String updatedBy)
        OCID of the user who updated the job execution.
        Parameters:
        updatedBy - the value to set
        Returns:
        this builder
      • uri

        public JobExecution.Builder uri​(String uri)
        URI to the job execution instance in the API.
        Parameters:
        uri - the value to set
        Returns:
        this builder
      • properties

        public JobExecution.Builder properties​(Map<String,​Map<String,​String>> properties)
        A map of maps that contains the execution context properties which are specific to a job execution.

        Each job execution may define it’s set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most job executions have required properties within the “default” category. Example: {“properties”: { “default”: { “host”: “host1”, “port”: “1521”, “database”: “orcl”}}}

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