Package com.oracle.bmc.datacatalog.model

Class Job

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class Job
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Details of a job.

    Jobs are scheduled instances of a job definition.
    Note: Objects should always be created or deserialized using the Job.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 Job.Builder, which maintain a set of all explicitly set fields called Job.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).

    • Constructor Detail

      • Job

        @Deprecated
@ConstructorProperties({"key","displayName","description","catalogId","lifecycleState","timeCreated","timeUpdated","jobType","scheduleCronExpression","timeScheduleBegin","timeScheduleEnd","scheduleType","connectionKey","jobDefinitionKey","internalVersion","executionCount","timeOfLatestExecution","createdById","updatedById","jobDefinitionName","dataAssetKey","glossaryKey","errorCode","errorMessage","uri"})
public Job​(String key,
           String displayName,
           String description,
           String catalogId,
           JobLifecycleState lifecycleState,
           Date timeCreated,
           Date timeUpdated,
           JobType jobType,
           String scheduleCronExpression,
           Date timeScheduleBegin,
           Date timeScheduleEnd,
           JobScheduleType scheduleType,
           String connectionKey,
           String jobDefinitionKey,
           String internalVersion,
           Integer executionCount,
           Date timeOfLatestExecution,
           String createdById,
           String updatedById,
           String jobDefinitionName,
           String dataAssetKey,
           String glossaryKey,
           String errorCode,
           String errorMessage,
           String uri)
        Deprecated.

    • Method Detail

      • builder

        public static Job.Builder builder()
        Create a new builder.

      • getKey

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

      • getDisplayName

        public String getDisplayName()
        A user-friendly display name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value

      • getDescription

        public String getDescription()
        Detailed description of the job.
        Returns:
        the value

      • getCatalogId

        public String getCatalogId()
        The data catalog’s OCID.
        Returns:
        the value

      • getLifecycleState

        public JobLifecycleState getLifecycleState()
        Lifecycle state for job.
        Returns:
        the value

      • getTimeCreated

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

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

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        Time that this job was last updated.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getJobType

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

      • getScheduleCronExpression

        public String getScheduleCronExpression()
        Interval on which the job will be run.

        Value is specified as a cron-supported time specification “nickname”. The following subset of those is supported: @monthly, @weekly, @daily, @hourly. For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.

        Returns:
        the value

      • getTimeScheduleBegin

        public Date getTimeScheduleBegin()
        Date that the schedule should be operational.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getTimeScheduleEnd

        public Date getTimeScheduleEnd()
        Date that the schedule should end from being operational.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getScheduleType

        public JobScheduleType getScheduleType()
        Type of job schedule that is inferred from the scheduling properties.
        Returns:
        the value

      • getConnectionKey

        public String getConnectionKey()
        The key of the connection used by the job.

        This connection will override the default connection specified in the associated job definition. All executions will use this connection.

        Returns:
        the value

      • getJobDefinitionKey

        public String getJobDefinitionKey()
        The unique key of the job definition resource that defined the scope of this job.
        Returns:
        the value

      • getInternalVersion

        public String getInternalVersion()
        Internal version of the job resource.
        Returns:
        the value

      • getExecutionCount

        public Integer getExecutionCount()
        The total number of executions for this job schedule.
        Returns:
        the value

      • getTimeOfLatestExecution

        public Date getTimeOfLatestExecution()
        The date and time of the most recent execution for this Job, in the format defined by RFC3339.

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

        Returns:
        the value

      • getCreatedById

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

      • getUpdatedById

        public String getUpdatedById()
        OCID of the user who updated this job.
        Returns:
        the value

      • getJobDefinitionName

        public String getJobDefinitionName()
        The display name of the job definition resource that defined the scope of this job.
        Returns:
        the value

      • getDataAssetKey

        public String getDataAssetKey()
        Unique key of the data asset to which this job applies, if the job involves a data asset.
        Returns:
        the value

      • getGlossaryKey

        public String getGlossaryKey()
        Unique key of the glossary to which this job applies.
        Returns:
        the value

      • getErrorCode

        public String getErrorCode()
        Error code returned from the latest job execution for this job.

        Useful when the latest Job execution is in FAILED state.

        Returns:
        the value

      • getErrorMessage

        public String getErrorMessage()
        Error message returned from the latest job execution for this job.

        Useful when the latest Job Execution is in a FAILED state.

        Returns:
        the value

      • getUri

        public String getUri()
        URI to the job instance in the API.
        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