Package com.oracle.bmc.ailanguage.model

Class Job

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.ailanguage.model.Job

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20221001")
public final class Job
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Job details which contain input document details on which prediction need to run, features (which and all language services ) need to run and where to store results
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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Job.Builder
static class	Job.LifecycleState	The current state of the Job.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

Job(String id, String displayName, String description, InputLocation inputLocation, InputConfiguration inputConfiguration, List<ModelMetadataDetails> modelMetadataDetails, String compartmentId, Job.LifecycleState lifecycleState, String lifecycleDetails, Integer percentComplete, Integer totalDocuments, Integer pendingDocuments, Integer completedDocuments, Integer failedDocuments, Integer warningsCount, ObjectPrefixOutputLocation outputLocation, Integer ttlInDays, String createdBy, Date timeAccepted, Date timeStarted, Date timeCompleted)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static Job.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment where you want to create the job.
Integer	getCompletedDocuments()	Number of documents processed for prediction.
String	getCreatedBy()	The OCID of the user who created the job.
String	getDescription()	A short description of the job.
String	getDisplayName()	A user-friendly display name for the job.
Integer	getFailedDocuments()	Number of documents failed for prediction.
String	getId()	The OCID of the job.
InputConfiguration	getInputConfiguration()
InputLocation	getInputLocation()
String	getLifecycleDetails()	A message describing the current state in more detail.
Job.LifecycleState	getLifecycleState()	The current state of the Job.
List<ModelMetadataDetails>	getModelMetadataDetails()	training model details For this release only one model is allowed to be input here.
ObjectPrefixOutputLocation	getOutputLocation()
Integer	getPendingDocuments()	Number of documents still to process.
Integer	getPercentComplete()	How much progress the operation has made, vs the total amount of work that must be performed.
Date	getTimeAccepted()	Job accepted time.
Date	getTimeCompleted()	Job finished time.
Date	getTimeStarted()	Job started time.
Integer	getTotalDocuments()	Total number of documents given as input for prediction.
Integer	getTtlInDays()	Time to live duration in days for Job.
Integer	getWarningsCount()	warnings count
int	hashCode()
Job.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Job

@Deprecated
@ConstructorProperties({"id","displayName","description","inputLocation","inputConfiguration","modelMetadataDetails","compartmentId","lifecycleState","lifecycleDetails","percentComplete","totalDocuments","pendingDocuments","completedDocuments","failedDocuments","warningsCount","outputLocation","ttlInDays","createdBy","timeAccepted","timeStarted","timeCompleted"})
public Job(String id,
           String displayName,
           String description,
           InputLocation inputLocation,
           InputConfiguration inputConfiguration,
           List<ModelMetadataDetails> modelMetadataDetails,
           String compartmentId,
           Job.LifecycleState lifecycleState,
           String lifecycleDetails,
           Integer percentComplete,
           Integer totalDocuments,
           Integer pendingDocuments,
           Integer completedDocuments,
           Integer failedDocuments,
           Integer warningsCount,
           ObjectPrefixOutputLocation outputLocation,
           Integer ttlInDays,
           String createdBy,
           Date timeAccepted,
           Date timeStarted,
           Date timeCompleted)

Deprecated.

Method Detail

builder

public static Job.Builder builder()

Create a new builder.

toBuilder

public Job.Builder toBuilder()

getId

public String getId()

The OCID of the job.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly display name for the job.

Returns:

the value

getDescription

public String getDescription()

A short description of the job.

Returns:

the value

getInputLocation

public InputLocation getInputLocation()

getInputConfiguration

public InputConfiguration getInputConfiguration()

getModelMetadataDetails

public List<ModelMetadataDetails> getModelMetadataDetails()

training model details For this release only one model is allowed to be input here.

One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment where you want to create the job.

Returns:

the value

getLifecycleState

public Job.LifecycleState getLifecycleState()

The current state of the Job.

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

A message describing the current state in more detail.

For example, can be used to provide actionable information for a resource in Failed state.

Returns:

the value

getPercentComplete

public Integer getPercentComplete()

How much progress the operation has made, vs the total amount of work that must be performed.

Returns:

the value

getTotalDocuments

public Integer getTotalDocuments()

Total number of documents given as input for prediction.

For CSV this signifies number of rows and for TXT this signifies number of files.

Returns:

the value

getPendingDocuments

public Integer getPendingDocuments()

Number of documents still to process.

For CSV this signifies number of rows and for TXT this signifies number of files.

Returns:

the value

getCompletedDocuments

public Integer getCompletedDocuments()

Number of documents processed for prediction.

For CSV this signifies number of rows and for TXT this signifies number of files.

Returns:

the value

getFailedDocuments

public Integer getFailedDocuments()

Number of documents failed for prediction.

For CSV this signifies number of rows and for TXT this signifies number of files.

Returns:

the value

getWarningsCount

public Integer getWarningsCount()

warnings count

Returns:

the value

getOutputLocation

public ObjectPrefixOutputLocation getOutputLocation()

getTtlInDays

public Integer getTtlInDays()

Time to live duration in days for Job.

Job will be available till max 90 days.

Returns:

the value

getCreatedBy

public String getCreatedBy()

The OCID of the user who created the job.

Returns:

the value

getTimeAccepted

public Date getTimeAccepted()

Job accepted time.

Returns:

the value

getTimeStarted

public Date getTimeStarted()

Job started time.

Returns:

the value

getTimeCompleted

public Date getTimeCompleted()

Job finished time.

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