@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
Job.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
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.
|
| Modifier and Type | Method and Description |
|---|---|
static Job.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCatalogId()
The data catalog’s OCID.
|
String |
getConnectionKey()
The key of the connection used by the job.
|
String |
getCreatedById()
OCID of the user who created this job.
|
String |
getDataAssetKey()
Unique key of the data asset to which this job applies, if the job involves a data asset.
|
String |
getDescription()
Detailed description of the job.
|
String |
getDisplayName()
A user-friendly display name.
|
String |
getErrorCode()
Error code returned from the latest job execution for this job.
|
String |
getErrorMessage()
Error message returned from the latest job execution for this job.
|
Integer |
getExecutionCount()
The total number of executions for this job schedule.
|
String |
getGlossaryKey()
Unique key of the glossary to which this job applies.
|
String |
getInternalVersion()
Internal version of the job resource.
|
String |
getJobDefinitionKey()
The unique key of the job definition resource that defined the scope of this job.
|
String |
getJobDefinitionName()
The display name of the job definition resource that defined the scope of this job.
|
JobType |
getJobType()
Type of the job.
|
String |
getKey()
Unique key of the job resource.
|
JobLifecycleState |
getLifecycleState()
Lifecycle state for job.
|
String |
getScheduleCronExpression()
Interval on which the job will be run.
|
JobScheduleType |
getScheduleType()
Type of job schedule that is inferred from the scheduling properties.
|
Date |
getTimeCreated()
The date and time the job was created, in the format defined by
RFC3339.
|
Date |
getTimeOfLatestExecution()
The date and time of the most recent execution for this Job, in the format defined by
RFC3339.
|
Date |
getTimeScheduleBegin()
Date that the schedule should be operational.
|
Date |
getTimeScheduleEnd()
Date that the schedule should end from being operational.
|
Date |
getTimeUpdated()
Time that this job was last updated.
|
String |
getUpdatedById()
OCID of the user who updated this job.
|
String |
getUri()
URI to the job instance in the API.
|
int |
hashCode() |
Job.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"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)
public static Job.Builder builder()
Create a new builder.
public Job.Builder toBuilder()
public String getKey()
Unique key of the job resource.
public String getDisplayName()
A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public String getDescription()
Detailed description of the job.
public String getCatalogId()
The data catalog’s OCID.
public JobLifecycleState getLifecycleState()
Lifecycle state for job.
public Date getTimeCreated()
The date and time the job was created, in the format defined by
RFC3339. Example: 2019-03-25T21:10:29.600Z
public Date getTimeUpdated()
Time that this job was last updated. An RFC3339 formatted datetime string.
public JobType getJobType()
Type of the job.
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.
public Date getTimeScheduleBegin()
Date that the schedule should be operational. An RFC3339 formatted datetime string.
public Date getTimeScheduleEnd()
Date that the schedule should end from being operational. An RFC3339 formatted datetime string.
public JobScheduleType getScheduleType()
Type of job schedule that is inferred from the scheduling properties.
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.
public String getJobDefinitionKey()
The unique key of the job definition resource that defined the scope of this job.
public String getInternalVersion()
Internal version of the job resource.
public Integer getExecutionCount()
The total number of executions for this job schedule.
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
public String getCreatedById()
OCID of the user who created this job.
public String getUpdatedById()
OCID of the user who updated this job.
public String getJobDefinitionName()
The display name of the job definition resource that defined the scope of this job.
public String getDataAssetKey()
Unique key of the data asset to which this job applies, if the job involves a data asset.
public String getGlossaryKey()
Unique key of the glossary to which this job applies.
public String getErrorCode()
Error code returned from the latest job execution for this job. Useful when the latest Job execution is in FAILED state.
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.
public String getUri()
URI to the job instance in the API.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.