@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
JobExecution.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
JobExecution(String key,
String jobKey,
JobType jobType,
String subType,
String parentKey,
String scheduleInstanceKey,
JobExecutionState lifecycleState,
Date timeCreated,
Date timeStarted,
Date timeEnded,
String errorCode,
String errorMessage,
String processKey,
String externalUrl,
String eventKey,
String dataEntityKey,
String createdById,
String updatedBy,
String uri,
Map<String,Map<String,String>> properties)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static JobExecution.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCreatedById()
OCID of the user who created the job execution.
|
String |
getDataEntityKey()
The key of the associated data entity resource.
|
String |
getErrorCode()
Error code returned from the job execution or null if job is still running or didn’t return
an error.
|
String |
getErrorMessage()
Error message returned from the job execution or null if job is still running or didn’t
return an error.
|
String |
getEventKey()
An identifier used for log message correlation.
|
String |
getExternalUrl()
If the job is an external process, then a URL of the job for accessing this resource and its
status.
|
String |
getJobKey()
The unique key of the parent job.
|
JobType |
getJobType()
Type of the job execution.
|
String |
getKey()
Unique key of the job execution resource.
|
JobExecutionState |
getLifecycleState()
Status of the job execution, such as running, paused, or completed.
|
String |
getParentKey()
The unique key of the parent execution or null if this job execution has no parent.
|
String |
getProcessKey()
Process identifier related to the job execution if the job is an external job.
|
Map<String,Map<String,String>> |
getProperties()
A map of maps that contains the execution context properties which are specific to a job
execution.
|
String |
getScheduleInstanceKey()
The unique key of the triggering external scheduler resource or null if this job execution is
not externally triggered.
|
String |
getSubType()
Sub-type of this job execution.
|
Date |
getTimeCreated()
The date and time the job execution was created, in the format defined by
RFC3339.
|
Date |
getTimeEnded()
Time that the job execution ended or null if it hasn’t yet completed.
|
Date |
getTimeStarted()
Time that job execution started.
|
String |
getUpdatedBy()
OCID of the user who updated the job execution.
|
String |
getUri()
URI to the job execution instance in the API.
|
int |
hashCode() |
JobExecution.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"key","jobKey","jobType","subType","parentKey","scheduleInstanceKey","lifecycleState","timeCreated","timeStarted","timeEnded","errorCode","errorMessage","processKey","externalUrl","eventKey","dataEntityKey","createdById","updatedBy","uri","properties"}) public JobExecution(String key, String jobKey, JobType jobType, String subType, String parentKey, String scheduleInstanceKey, JobExecutionState lifecycleState, Date timeCreated, Date timeStarted, Date timeEnded, String errorCode, String errorMessage, String processKey, String externalUrl, String eventKey, String dataEntityKey, String createdById, String updatedBy, String uri, Map<String,Map<String,String>> properties)
public static JobExecution.Builder builder()
Create a new builder.
public JobExecution.Builder toBuilder()
public String getKey()
Unique key of the job execution resource.
public String getJobKey()
The unique key of the parent job.
public JobType getJobType()
Type of the job execution.
public String getSubType()
Sub-type of this job execution.
public String getParentKey()
The unique key of the parent execution or null if this job execution has no parent.
public String getScheduleInstanceKey()
The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.
public JobExecutionState getLifecycleState()
Status of the job execution, such as running, paused, or completed.
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
public Date getTimeStarted()
Time that job execution started. An RFC3339 formatted datetime string.
public Date getTimeEnded()
Time that the job execution ended or null if it hasn’t yet completed. An RFC3339 formatted datetime string.
public String getErrorCode()
Error code returned from the job execution or null if job is still running or didn’t return an error.
public String getErrorMessage()
Error message returned from the job execution or null if job is still running or didn’t return an error.
public String getProcessKey()
Process identifier related to the job execution if the job is an external job.
public String getExternalUrl()
If the job is an external process, then a URL of the job for accessing this resource and its status.
public String getEventKey()
An identifier used for log message correlation.
public String getDataEntityKey()
The key of the associated data entity resource.
public String getCreatedById()
OCID of the user who created the job execution.
public String getUpdatedBy()
OCID of the user who updated the job execution.
public String getUri()
URI to the job execution instance in the API.
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"}}}
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.