com.amazonaws.services.comprehend.model

Class DocumentReaderConfig

java.lang.Object

com.amazonaws.services.comprehend.model.DocumentReaderConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentReaderConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

The input properties for a topic detection job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentReaderConfig()

Method Summary

Modifier and Type	Method and Description
DocumentReaderConfig	clone()
boolean	equals(Object obj)
String	getDocumentReadAction() This enum field will start with two values which will apply to PDFs:
String	getDocumentReadMode() This enum field provides two values:
List<String>	getFeatureTypes() Specifies how the text in an input file should be processed:
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setDocumentReadAction(String documentReadAction) This enum field will start with two values which will apply to PDFs:
void	setDocumentReadMode(String documentReadMode) This enum field provides two values:
void	setFeatureTypes(Collection<String> featureTypes) Specifies how the text in an input file should be processed:
String	toString() Returns a string representation of this object.
DocumentReaderConfig	withDocumentReadAction(DocumentReadAction documentReadAction) This enum field will start with two values which will apply to PDFs:
DocumentReaderConfig	withDocumentReadAction(String documentReadAction) This enum field will start with two values which will apply to PDFs:
DocumentReaderConfig	withDocumentReadMode(DocumentReadMode documentReadMode) This enum field provides two values:
DocumentReaderConfig	withDocumentReadMode(String documentReadMode) This enum field provides two values:
DocumentReaderConfig	withFeatureTypes(Collection<String> featureTypes) Specifies how the text in an input file should be processed:
DocumentReaderConfig	withFeatureTypes(DocumentReadFeatureTypes... featureTypes) Specifies how the text in an input file should be processed:
DocumentReaderConfig	withFeatureTypes(String... featureTypes) Specifies how the text in an input file should be processed:

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentReaderConfig

public DocumentReaderConfig()

Method Detail

setDocumentReadAction

public void setDocumentReadAction(String documentReadAction)

This enum field will start with two values which will apply to PDFs:

• TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.

• TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

Parameters:

documentReadAction - This enum field will start with two values which will apply to PDFs:

• TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.

• TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

See Also:

DocumentReadAction

getDocumentReadAction

public String getDocumentReadAction()

This enum field will start with two values which will apply to PDFs:

• TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.

• TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

Returns:

This enum field will start with two values which will apply to PDFs:

• TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.

• TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

See Also:

DocumentReadAction

withDocumentReadAction

public DocumentReaderConfig withDocumentReadAction(String documentReadAction)

This enum field will start with two values which will apply to PDFs:

• TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.

• TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

Parameters:

documentReadAction - This enum field will start with two values which will apply to PDFs:

• TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.

• TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentReadAction

withDocumentReadAction

public DocumentReaderConfig withDocumentReadAction(DocumentReadAction documentReadAction)

This enum field will start with two values which will apply to PDFs:

• TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.

• TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

Parameters:

documentReadAction - This enum field will start with two values which will apply to PDFs:

• TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.

• TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentReadAction

setDocumentReadMode

public void setDocumentReadMode(String documentReadMode)

This enum field provides two values:

• SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs

• FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.

Parameters:

documentReadMode - This enum field provides two values:

• SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs

• FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.

See Also:

DocumentReadMode

getDocumentReadMode

public String getDocumentReadMode()

This enum field provides two values:

• SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs

• FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.

Returns:

This enum field provides two values:

• SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs

• FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.

See Also:

DocumentReadMode

withDocumentReadMode

public DocumentReaderConfig withDocumentReadMode(String documentReadMode)

This enum field provides two values:

• SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs

• FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.

Parameters:

documentReadMode - This enum field provides two values:

• SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs

• FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentReadMode

withDocumentReadMode

public DocumentReaderConfig withDocumentReadMode(DocumentReadMode documentReadMode)

This enum field provides two values:

• SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs

• FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.

Parameters:

documentReadMode - This enum field provides two values:

• SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs

• FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentReadMode

getFeatureTypes

public List<String> getFeatureTypes()

Specifies how the text in an input file should be processed:

Returns:

Specifies how the text in an input file should be processed:

See Also:

DocumentReadFeatureTypes

setFeatureTypes

public void setFeatureTypes(Collection<String> featureTypes)

Specifies how the text in an input file should be processed:

Parameters:

featureTypes - Specifies how the text in an input file should be processed:

See Also:

DocumentReadFeatureTypes

withFeatureTypes

public DocumentReaderConfig withFeatureTypes(String... featureTypes)

Specifies how the text in an input file should be processed:

NOTE: This method appends the values to the existing list (if any). Use setFeatureTypes(java.util.Collection) or withFeatureTypes(java.util.Collection) if you want to override the existing values.

Parameters:

featureTypes - Specifies how the text in an input file should be processed:

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentReadFeatureTypes

withFeatureTypes

public DocumentReaderConfig withFeatureTypes(Collection<String> featureTypes)

Specifies how the text in an input file should be processed:

Parameters:

featureTypes - Specifies how the text in an input file should be processed:

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentReadFeatureTypes

withFeatureTypes

public DocumentReaderConfig withFeatureTypes(DocumentReadFeatureTypes... featureTypes)

Specifies how the text in an input file should be processed:

Parameters:

featureTypes - Specifies how the text in an input file should be processed:

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentReadFeatureTypes

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DocumentReaderConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo