DocumentReaderConfig (AWS Java SDK :: Services :: Amazon Comprehend 2.17.172 API)

java.lang.Object
- software.amazon.awssdk.services.comprehend.model.DocumentReaderConfig

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DocumentReaderConfig.Builder,DocumentReaderConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class DocumentReaderConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentReaderConfig.Builder,DocumentReaderConfig>

The input properties for a topic detection job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DocumentReaderConfig.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DocumentReaderConfig.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DocumentReaderConfig.Builder`	`builder()`
`DocumentReadAction`	`documentReadAction()` This enum field will start with two values which will apply to PDFs:
`String`	`documentReadActionAsString()` This enum field will start with two values which will apply to PDFs:
`DocumentReadMode`	`documentReadMode()` This enum field provides two values:
`String`	`documentReadModeAsString()` This enum field provides two values:
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<DocumentReadFeatureTypes>`	`featureTypes()` Specifies how the text in an input file should be processed:
`List<String>`	`featureTypesAsStrings()` Specifies how the text in an input file should be processed:
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFeatureTypes()` For responses, this returns true if the service returned a value for the FeatureTypes property.
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DocumentReaderConfig.Builder>`	`serializableBuilderClass()`
`DocumentReaderConfig.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - documentReadAction
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, documentReadAction will return DocumentReadAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentReadActionAsString().
    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
  - documentReadActionAsString
```
public final String documentReadActionAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, documentReadAction will return DocumentReadAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentReadActionAsString().
    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
  - documentReadMode
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, documentReadMode will return DocumentReadMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentReadModeAsString().
    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
  - documentReadModeAsString
```
public final String documentReadModeAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, documentReadMode will return DocumentReadMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentReadModeAsString().
    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
  - featureTypes
```
public final List<DocumentReadFeatureTypes> featureTypes()
```
    Specifies how the text in an input file should be processed:
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFeatureTypes() method.
    
    Returns:
    
    Specifies how the text in an input file should be processed:
  - hasFeatureTypes
```
public final boolean hasFeatureTypes()
```
    For responses, this returns true if the service returned a value for the FeatureTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - featureTypesAsStrings
```
public final List<String> featureTypesAsStrings()
```
    Specifies how the text in an input file should be processed:
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFeatureTypes() method.
    
    Returns:
    
    Specifies how the text in an input file should be processed:
  - toBuilder
```
public DocumentReaderConfig.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DocumentReaderConfig.Builder,DocumentReaderConfig>
  - builder
```
public static DocumentReaderConfig.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DocumentReaderConfig.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DocumentReaderConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

documentReadAction

documentReadActionAsString

documentReadMode

documentReadModeAsString

featureTypes

hasFeatureTypes

featureTypesAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields