@Generated(value="OracleSDKGenerator", comments="API Version: 20200430") public final class TaskRun extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The information about a task run.
Note: Objects should always be created or deserialized using the TaskRun.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 TaskRun.Builder
, which maintain a
set of all explicitly set fields called TaskRun.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 |
TaskRun.AuthMode
The autorization mode for when the task was executed.
|
static class |
TaskRun.Builder |
static class |
TaskRun.ExpectedDurationUnit
The expected duration unit of measure.
|
static class |
TaskRun.Status
The status of the task run.
|
static class |
TaskRun.TaskType
The type of task run.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
TaskRun(String key,
String modelType,
String modelVersion,
ParentReference parentRef,
String name,
String description,
Integer objectVersion,
ConfigProvider configProvider,
TaskRun.Status status,
Long startTimeMillis,
Long endTimeMillis,
Long lastUpdated,
Long recordsWritten,
Long bytesProcessed,
String errorMessage,
Double expectedDuration,
TaskRun.ExpectedDurationUnit expectedDurationUnit,
String taskKey,
String externalId,
Integer retryAttempt,
TaskSchedule taskSchedule,
Map<String,Float> metrics,
Map<String,ParameterValue> outputs,
List<String> executionErrors,
List<String> terminationErrors,
TaskRun.AuthMode authMode,
String opcRequestId,
Integer objectStatus,
TaskRun.TaskType taskType,
Boolean isLogProcessingInProgress,
String identifier,
ObjectMetadata metadata,
Map<String,String> keyMap)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static TaskRun.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
TaskRun.AuthMode |
getAuthMode()
The autorization mode for when the task was executed.
|
Long |
getBytesProcessed()
The number of bytes processed in the task run.
|
ConfigProvider |
getConfigProvider() |
String |
getDescription()
Detailed description for the object.
|
Long |
getEndTimeMillis()
The end time.
|
String |
getErrorMessage()
Contains an error message if status is
ERROR . |
List<String> |
getExecutionErrors()
An array of execution errors from the run.
|
Double |
getExpectedDuration()
The expected duration for the task run.
|
TaskRun.ExpectedDurationUnit |
getExpectedDurationUnit()
The expected duration unit of measure.
|
String |
getExternalId()
The external identifier for the task run.
|
String |
getIdentifier()
Value can only contain upper case letters, underscore and numbers.
|
Boolean |
getIsLogProcessingInProgress()
This field tells the user if there is any logs being fetched in backend for failure.
|
String |
getKey()
The key of the object.
|
Map<String,String> |
getKeyMap()
A key map.
|
Long |
getLastUpdated()
The date and time the object was last updated.
|
ObjectMetadata |
getMetadata() |
Map<String,Float> |
getMetrics()
A map of metrics for the run.
|
String |
getModelType()
The type of the object.
|
String |
getModelVersion()
The model version of an object.
|
String |
getName()
Free form text without any restriction on permitted characters.
|
Integer |
getObjectStatus()
The status of an object that can be set to value 1 for shallow references across objects,
other values reserved.
|
Integer |
getObjectVersion()
The version of the object that is used to track changes in the object instance.
|
String |
getOpcRequestId()
The OPC request ID of execution of the task run.
|
Map<String,ParameterValue> |
getOutputs()
A map of the outputs of the run.
|
ParentReference |
getParentRef() |
Long |
getRecordsWritten()
The number of records processed in the task run.
|
Integer |
getRetryAttempt()
Holds the particular attempt number.
|
Long |
getStartTimeMillis()
The start time.
|
TaskRun.Status |
getStatus()
The status of the task run.
|
String |
getTaskKey()
Task Key of the task for which TaskRun is being created.
|
TaskSchedule |
getTaskSchedule() |
TaskRun.TaskType |
getTaskType()
The type of task run.
|
List<String> |
getTerminationErrors()
An array of termination errors from the run.
|
int |
hashCode() |
TaskRun.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"key","modelType","modelVersion","parentRef","name","description","objectVersion","configProvider","status","startTimeMillis","endTimeMillis","lastUpdated","recordsWritten","bytesProcessed","errorMessage","expectedDuration","expectedDurationUnit","taskKey","externalId","retryAttempt","taskSchedule","metrics","outputs","executionErrors","terminationErrors","authMode","opcRequestId","objectStatus","taskType","isLogProcessingInProgress","identifier","metadata","keyMap"}) public TaskRun(String key, String modelType, String modelVersion, ParentReference parentRef, String name, String description, Integer objectVersion, ConfigProvider configProvider, TaskRun.Status status, Long startTimeMillis, Long endTimeMillis, Long lastUpdated, Long recordsWritten, Long bytesProcessed, String errorMessage, Double expectedDuration, TaskRun.ExpectedDurationUnit expectedDurationUnit, String taskKey, String externalId, Integer retryAttempt, TaskSchedule taskSchedule, Map<String,Float> metrics, Map<String,ParameterValue> outputs, List<String> executionErrors, List<String> terminationErrors, TaskRun.AuthMode authMode, String opcRequestId, Integer objectStatus, TaskRun.TaskType taskType, Boolean isLogProcessingInProgress, String identifier, ObjectMetadata metadata, Map<String,String> keyMap)
public static TaskRun.Builder builder()
Create a new builder.
public TaskRun.Builder toBuilder()
public String getKey()
The key of the object.
public String getModelType()
The type of the object.
public String getModelVersion()
The model version of an object.
public ParentReference getParentRef()
public String getName()
Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
public String getDescription()
Detailed description for the object.
public Integer getObjectVersion()
The version of the object that is used to track changes in the object instance.
public ConfigProvider getConfigProvider()
public TaskRun.Status getStatus()
The status of the task run.
public Long getStartTimeMillis()
The start time.
public Long getEndTimeMillis()
The end time.
public Long getLastUpdated()
The date and time the object was last updated.
public Long getRecordsWritten()
The number of records processed in the task run.
public Long getBytesProcessed()
The number of bytes processed in the task run.
public String getErrorMessage()
Contains an error message if status is ERROR
.
public Double getExpectedDuration()
The expected duration for the task run.
public TaskRun.ExpectedDurationUnit getExpectedDurationUnit()
The expected duration unit of measure.
public String getTaskKey()
Task Key of the task for which TaskRun is being created. If not specified, the AggregatorKey in RegistryMetadata will be assumed to be the TaskKey
public String getExternalId()
The external identifier for the task run.
public Integer getRetryAttempt()
Holds the particular attempt number.
public TaskSchedule getTaskSchedule()
public Map<String,ParameterValue> getOutputs()
A map of the outputs of the run.
public List<String> getExecutionErrors()
An array of execution errors from the run.
public List<String> getTerminationErrors()
An array of termination errors from the run.
public TaskRun.AuthMode getAuthMode()
The autorization mode for when the task was executed.
public String getOpcRequestId()
The OPC request ID of execution of the task run.
public Integer getObjectStatus()
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
public TaskRun.TaskType getTaskType()
The type of task run.
public Boolean getIsLogProcessingInProgress()
This field tells the user if there is any logs being fetched in backend for failure. Applicable only for failed pipeline tasks.
public String getIdentifier()
Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified.
public ObjectMetadata getMetadata()
public Map<String,String> getKeyMap()
A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public 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.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.