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