Class JobSummary
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.datacatalog.model.JobSummary
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20190325") public final class JobSummary 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 theJobSummary.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 theJobSummary.Builder
, which maintain a set of all explicitly set fields calledJobSummary.Builder.__explicitlySet__
. ThehashCode()
andequals(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).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
JobSummary.Builder
-
Constructor Summary
Constructors Constructor Description JobSummary(String key, String uri, String displayName, String catalogId, String jobDefinitionKey, JobLifecycleState lifecycleState, JobType jobType, String scheduleType, String description, Date timeCreated, Date timeUpdated, String createdById, String updatedById, String scheduleCronExpression, Date timeScheduleBegin, Integer executionCount, Date timeOfLatestExecution, String jobDefinitionName, String dataAssetKey, String glossaryKey, String errorCode, String errorMessage, List<JobExecutionSummary> executions)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static JobSummary.Builder
builder()
Create a new builder.boolean
equals(Object o)
String
getCatalogId()
The data catalog’s OCID.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.List<JobExecutionSummary>
getExecutions()
Array of the executions summary associated with this job.String
getGlossaryKey()
Unique key of the glossary to which this job applies.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.JobLifecycleState
getLifecycleState()
Lifecycle state of the job, such as running, paused, or completed.String
getScheduleCronExpression()
Interval on which the job will be run.String
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
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()
JobSummary.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
JobSummary
@Deprecated @ConstructorProperties({"key","uri","displayName","catalogId","jobDefinitionKey","lifecycleState","jobType","scheduleType","description","timeCreated","timeUpdated","createdById","updatedById","scheduleCronExpression","timeScheduleBegin","executionCount","timeOfLatestExecution","jobDefinitionName","dataAssetKey","glossaryKey","errorCode","errorMessage","executions"}) public JobSummary(String key, String uri, String displayName, String catalogId, String jobDefinitionKey, JobLifecycleState lifecycleState, JobType jobType, String scheduleType, String description, Date timeCreated, Date timeUpdated, String createdById, String updatedById, String scheduleCronExpression, Date timeScheduleBegin, Integer executionCount, Date timeOfLatestExecution, String jobDefinitionName, String dataAssetKey, String glossaryKey, String errorCode, String errorMessage, List<JobExecutionSummary> executions)
Deprecated.
-
-
Method Detail
-
builder
public static JobSummary.Builder builder()
Create a new builder.
-
toBuilder
public JobSummary.Builder toBuilder()
-
getKey
public String getKey()
Unique key of the job.- Returns:
- the value
-
getUri
public String getUri()
URI to the job instance in the API.- 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
-
getCatalogId
public String getCatalogId()
The data catalog’s OCID.- 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
-
getLifecycleState
public JobLifecycleState getLifecycleState()
Lifecycle state of the job, such as running, paused, or completed.- Returns:
- the value
-
getJobType
public JobType getJobType()
Type of the job.- Returns:
- the value
-
getScheduleType
public String getScheduleType()
Type of job schedule that is inferred from the scheduling properties.- Returns:
- the value
-
getDescription
public String getDescription()
Detailed description of the 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
-
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
-
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
-
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
-
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
-
getExecutions
public List<JobExecutionSummary> getExecutions()
Array of the executions summary associated with this job.- Returns:
- the value
-
toString
public String toString()
- Overrides:
toString
in classcom.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 classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-