com.oracle.bmc.aivision.model

Class ImageJob

java.lang.Object

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

com.oracle.bmc.aivision.model.ImageJob

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

The job details for a batch image analysis.
Note: Objects should always be created or deserialized using the ImageJob.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 ImageJob.Builder, which maintain a set of all explicitly set fields called ImageJob.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 and Description
static class	ImageJob.Builder
static class	ImageJob.LifecycleDetails The detailed status of FAILED state.
static class	ImageJob.LifecycleState The current state of the batch image 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 and Description
ImageJob(String id, String compartmentId, String displayName, List<ImageFeature> features, InputLocation inputLocation, Date timeAccepted, Date timeStarted, Date timeFinished, Float percentComplete, OutputLocation outputLocation, ImageJob.LifecycleState lifecycleState, ImageJob.LifecycleDetails lifecycleDetails, Boolean isZipOutputEnabled) Deprecated.

Method Summary

Modifier and Type	Method and Description
static ImageJob.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getCompartmentId() The OCID of the compartment that starts the job.
String	getDisplayName() The image job display name.
List<ImageFeature>	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.
ImageJob.LifecycleDetails	getLifecycleDetails() The detailed status of FAILED state.
ImageJob.LifecycleState	getLifecycleState() The current state of the batch image 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()
ImageJob.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

ImageJob

@Deprecated
 @ConstructorProperties(value={"id","compartmentId","displayName","features","inputLocation","timeAccepted","timeStarted","timeFinished","percentComplete","outputLocation","lifecycleState","lifecycleDetails","isZipOutputEnabled"})
public ImageJob(String id,
                                                                                                                                                                                                                                                                   String compartmentId,
                                                                                                                                                                                                                                                                   String displayName,
                                                                                                                                                                                                                                                                   List<ImageFeature> features,
                                                                                                                                                                                                                                                                   InputLocation inputLocation,
                                                                                                                                                                                                                                                                   Date timeAccepted,
                                                                                                                                                                                                                                                                   Date timeStarted,
                                                                                                                                                                                                                                                                   Date timeFinished,
                                                                                                                                                                                                                                                                   Float percentComplete,
                                                                                                                                                                                                                                                                   OutputLocation outputLocation,
                                                                                                                                                                                                                                                                   ImageJob.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                   ImageJob.LifecycleDetails lifecycleDetails,
                                                                                                                                                                                                                                                                   Boolean isZipOutputEnabled)

Deprecated.

Method Detail

builder

public static ImageJob.Builder builder()

Create a new builder.

toBuilder

public ImageJob.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 image job display name.

Returns:

the value

getFeatures

public List<ImageFeature> getFeatures()

The list of requested document analysis types.

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 ImageJob.LifecycleState getLifecycleState()

The current state of the batch image job.

Returns:

the value

getLifecycleDetails

public ImageJob.LifecycleDetails getLifecycleDetails()

The detailed status of FAILED state.

Returns:

the value

getIsZipOutputEnabled

public Boolean getIsZipOutputEnabled()

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

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