Package com.oracle.bmc.aidocument.model

Class AnalyzeDocumentDetails

java.lang.Object

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

com.oracle.bmc.aidocument.model.AnalyzeDocumentDetails

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

The details of how to analyze a document.
Note: Objects should always be created or deserialized using the AnalyzeDocumentDetails.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 AnalyzeDocumentDetails.Builder, which maintain a set of all explicitly set fields called AnalyzeDocumentDetails.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	AnalyzeDocumentDetails.Builder

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
AnalyzeDocumentDetails(List<DocumentFeature> features, DocumentDetails document, String compartmentId, OutputLocation outputLocation, String language, DocumentType documentType, AnalyzeDocumentResult ocrData)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static AnalyzeDocumentDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The compartment identifier.
DocumentDetails	getDocument()
DocumentType	getDocumentType()	The document type.
List<DocumentFeature>	getFeatures()	The types of document analysis requested.
String	getLanguage()	The document language, abbreviated according to the BCP 47 syntax.
AnalyzeDocumentResult	getOcrData()
OutputLocation	getOutputLocation()
int	hashCode()
AnalyzeDocumentDetails.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

AnalyzeDocumentDetails

@Deprecated
@ConstructorProperties({"features","document","compartmentId","outputLocation","language","documentType","ocrData"})
public AnalyzeDocumentDetails(List<DocumentFeature> features,
                              DocumentDetails document,
                              String compartmentId,
                              OutputLocation outputLocation,
                              String language,
                              DocumentType documentType,
                              AnalyzeDocumentResult ocrData)

Deprecated.

Method Detail

builder

public static AnalyzeDocumentDetails.Builder builder()

Create a new builder.

toBuilder

public AnalyzeDocumentDetails.Builder toBuilder()

getFeatures

public List<DocumentFeature> getFeatures()

The types of document analysis requested.

Returns:

the value

getDocument

public DocumentDetails getDocument()

getCompartmentId

public String getCompartmentId()

The compartment identifier.

Returns:

the value

getOutputLocation

public OutputLocation getOutputLocation()

getLanguage

public String getLanguage()

The document language, abbreviated according to the BCP 47 syntax.

Returns:

the value

getDocumentType

public DocumentType getDocumentType()

The document type.

Returns:

the value

getOcrData

public AnalyzeDocumentResult getOcrData()

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