Package com.oracle.bmc.aivision.model

Class DocumentJob

java.lang.Object

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

com.oracle.bmc.aivision.model.DocumentJob

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

The job details for a batch document analysis.
Note: Objects should always be created or deserialized using the DocumentJob.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 DocumentJob.Builder, which maintain a set of all explicitly set fields called DocumentJob.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	DocumentJob.Builder
static class	DocumentJob.LifecycleDetails	The detailed status of FAILED state.
static class	DocumentJob.LifecycleState	The current state of the batch document 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

DocumentJob(String id, String compartmentId, String displayName, List<DocumentFeature> features, DocumentLanguage language, DocumentType documentType, InputLocation inputLocation, Date timeAccepted, Date timeStarted, Date timeFinished, Float percentComplete, OutputLocation outputLocation, DocumentJob.LifecycleState lifecycleState, Boolean isZipOutputEnabled, DocumentJob.LifecycleDetails lifecycleDetails)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static DocumentJob.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment that starts the job.
String	getDisplayName()	The document job display name.
DocumentType	getDocumentType()	The type of document.
List<DocumentFeature>	getFeatures()	The list of requested document analysis types.
String	getId()	The job id.
InputLocation	getInputLocation()
Boolean	getIsZipOutputEnabled()	Whether or not to generate a ZIP file containing the results.
DocumentLanguage	getLanguage()	The document language, abbreviated according to ISO 639-2.
DocumentJob.LifecycleDetails	getLifecycleDetails()	The detailed status of FAILED state.
DocumentJob.LifecycleState	getLifecycleState()	The current state of the batch document job.
OutputLocation	getOutputLocation()
Float	getPercentComplete()	How much progress the operation has made, compared to the total amount of work to be performed.
Date	getTimeAccepted()	The job acceptance time.
Date	getTimeFinished()	The job finish time.
Date	getTimeStarted()	The job start time.
int	hashCode()
DocumentJob.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

DocumentJob

@Deprecated
@ConstructorProperties({"id","compartmentId","displayName","features","language","documentType","inputLocation","timeAccepted","timeStarted","timeFinished","percentComplete","outputLocation","lifecycleState","isZipOutputEnabled","lifecycleDetails"})
public DocumentJob(String id,
                   String compartmentId,
                   String displayName,
                   List<DocumentFeature> features,
                   DocumentLanguage language,
                   DocumentType documentType,
                   InputLocation inputLocation,
                   Date timeAccepted,
                   Date timeStarted,
                   Date timeFinished,
                   Float percentComplete,
                   OutputLocation outputLocation,
                   DocumentJob.LifecycleState lifecycleState,
                   Boolean isZipOutputEnabled,
                   DocumentJob.LifecycleDetails lifecycleDetails)

Deprecated.

Method Detail

builder

public static DocumentJob.Builder builder()

Create a new builder.

toBuilder

public DocumentJob.Builder toBuilder()

getId

public String getId()

The job id.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that starts the job.

Returns:

the value

getDisplayName

public String getDisplayName()

The document job display name.

Returns:

the value

getFeatures

public List<DocumentFeature> getFeatures()

The list of requested document analysis types.

Returns:

the value

getLanguage

public DocumentLanguage getLanguage()

The document language, abbreviated according to ISO 639-2.

Returns:

the value

getDocumentType

public DocumentType getDocumentType()

The type of document.

Returns:

the value

getInputLocation

public InputLocation getInputLocation()

getTimeAccepted

public Date getTimeAccepted()

The job acceptance time.

Returns:

the value

getTimeStarted

public Date getTimeStarted()

The job start time.

Returns:

the value

getTimeFinished

public Date getTimeFinished()

The job finish time.

Returns:

the value

getPercentComplete

public Float getPercentComplete()

How much progress the operation has made, compared to the total amount of work to be performed.

Returns:

the value

getOutputLocation

public OutputLocation getOutputLocation()

getLifecycleState

public DocumentJob.LifecycleState getLifecycleState()

The current state of the batch document job.

Returns:

the value

getIsZipOutputEnabled

public Boolean getIsZipOutputEnabled()

Whether or not to generate a ZIP file containing the results.

Returns:

the value

getLifecycleDetails

public DocumentJob.LifecycleDetails getLifecycleDetails()

The detailed status of FAILED state.

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