Package com.oracle.bmc.datacatalog.model

Class JobExecution

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class JobExecution
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A job execution is a unit of work being executed on behalf of a job.
    Note: Objects should always be created or deserialized using the JobExecution.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the JobExecution.Builder, which maintain a set of all explicitly set fields called JobExecution.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getKey

        public String getKey()
        Unique key of the job execution resource.
        Returns:
        the value

      • getJobKey

        public String getJobKey()
        The unique key of the parent job.
        Returns:
        the value

      • getJobType

        public JobType getJobType()
        Type of the job execution.
        Returns:
        the value

      • getSubType

        public String getSubType()
        Sub-type of this job execution.
        Returns:
        the value

      • getParentKey

        public String getParentKey()
        The unique key of the parent execution or null if this job execution has no parent.
        Returns:
        the value

      • getScheduleInstanceKey

        public String getScheduleInstanceKey()
        The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.
        Returns:
        the value

      • getLifecycleState

        public JobExecutionState getLifecycleState()
        Status of the job execution, such as running, paused, or completed.
        Returns:
        the value

      • getTimeCreated

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

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

        Returns:
        the value

      • getTimeStarted

        public Date getTimeStarted()
        Time that job execution started.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getTimeEnded

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

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getErrorCode

        public String getErrorCode()
        Error code returned from the job execution or null if job is still running or didn’t return an error.
        Returns:
        the value

      • getErrorMessage

        public String getErrorMessage()
        Error message returned from the job execution or null if job is still running or didn’t return an error.
        Returns:
        the value

      • getProcessKey

        public String getProcessKey()
        Process identifier related to the job execution if the job is an external job.
        Returns:
        the value

      • getExternalUrl

        public String getExternalUrl()
        If the job is an external process, then a URL of the job for accessing this resource and its status.
        Returns:
        the value

      • getEventKey

        public String getEventKey()
        An identifier used for log message correlation.
        Returns:
        the value

      • getDataEntityKey

        public String getDataEntityKey()
        The key of the associated data entity resource.
        Returns:
        the value

      • getCreatedById

        public String getCreatedById()
        OCID of the user who created the job execution.
        Returns:
        the value

      • getUpdatedBy

        public String getUpdatedBy()
        OCID of the user who updated the job execution.
        Returns:
        the value

      • getUri

        public String getUri()
        URI to the job execution instance in the API.
        Returns:
        the value

      • getProperties

        public Map<String,​Map<String,​String>> getProperties()
        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”}}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel