com.oracle.bmc.aivision.model

Class DocumentJob.Builder

java.lang.Object

com.oracle.bmc.aivision.model.DocumentJob.Builder

Enclosing class:

DocumentJob

public static class DocumentJob.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DocumentJob	build()
DocumentJob.Builder	compartmentId(String compartmentId) The OCID of the compartment that starts the job.
DocumentJob.Builder	copy(DocumentJob model)
DocumentJob.Builder	displayName(String displayName) The document job display name.
DocumentJob.Builder	documentType(DocumentType documentType) The type of document.
DocumentJob.Builder	features(List<DocumentFeature> features) The list of requested document analysis types.
DocumentJob.Builder	id(String id) The job id.
DocumentJob.Builder	inputLocation(InputLocation inputLocation)
DocumentJob.Builder	isZipOutputEnabled(Boolean isZipOutputEnabled) Whether or not to generate a ZIP file containing the results.
DocumentJob.Builder	language(DocumentLanguage language) The document language, abbreviated according to ISO 639-2.
DocumentJob.Builder	lifecycleDetails(DocumentJob.LifecycleDetails lifecycleDetails) The detailed status of FAILED state.
DocumentJob.Builder	lifecycleState(DocumentJob.LifecycleState lifecycleState) The current state of the batch document job.
DocumentJob.Builder	outputLocation(OutputLocation outputLocation)
DocumentJob.Builder	percentComplete(Float percentComplete) How much progress the operation has made, compared to the total amount of work to be performed.
DocumentJob.Builder	timeAccepted(Date timeAccepted) The job acceptance time.
DocumentJob.Builder	timeFinished(Date timeFinished) The job finish time.
DocumentJob.Builder	timeStarted(Date timeStarted) The job start time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

id

public DocumentJob.Builder id(String id)

The job id.

Parameters:

id - the value to set

Returns:

this builder

compartmentId

public DocumentJob.Builder compartmentId(String compartmentId)

The OCID of the compartment that starts the job.

Parameters:

compartmentId - the value to set

Returns:

this builder

displayName

public DocumentJob.Builder displayName(String displayName)

The document job display name.

Parameters:

displayName - the value to set

Returns:

this builder

features

public DocumentJob.Builder features(List<DocumentFeature> features)

The list of requested document analysis types.

Parameters:

features - the value to set

Returns:

this builder

language

public DocumentJob.Builder language(DocumentLanguage language)

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

Parameters:

language - the value to set

Returns:

this builder

documentType

public DocumentJob.Builder documentType(DocumentType documentType)

The type of document.

Parameters:

documentType - the value to set

Returns:

this builder

inputLocation

public DocumentJob.Builder inputLocation(InputLocation inputLocation)

timeAccepted

public DocumentJob.Builder timeAccepted(Date timeAccepted)

The job acceptance time.

Parameters:

timeAccepted - the value to set

Returns:

this builder

timeStarted

public DocumentJob.Builder timeStarted(Date timeStarted)

The job start time.

Parameters:

timeStarted - the value to set

Returns:

this builder

timeFinished

public DocumentJob.Builder timeFinished(Date timeFinished)

The job finish time.

Parameters:

timeFinished - the value to set

Returns:

this builder

percentComplete

public DocumentJob.Builder percentComplete(Float percentComplete)

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

Parameters:

percentComplete - the value to set

Returns:

this builder

outputLocation

public DocumentJob.Builder outputLocation(OutputLocation outputLocation)

lifecycleState

public DocumentJob.Builder lifecycleState(DocumentJob.LifecycleState lifecycleState)

The current state of the batch document job.

Parameters:

lifecycleState - the value to set

Returns:

this builder

isZipOutputEnabled

public DocumentJob.Builder isZipOutputEnabled(Boolean isZipOutputEnabled)

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

Parameters:

isZipOutputEnabled - the value to set

Returns:

this builder

lifecycleDetails

public DocumentJob.Builder lifecycleDetails(DocumentJob.LifecycleDetails lifecycleDetails)

The detailed status of FAILED state.

Parameters:

lifecycleDetails - the value to set

Returns:

this builder

build

public DocumentJob build()

copy

public DocumentJob.Builder copy(DocumentJob model)