java.lang.Object
- software.amazon.awssdk.services.textract.model.DocumentGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentGroup.Builder,DocumentGroup>
```
@Generated("software.amazon.awssdk:codegen")
public final class DocumentGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentGroup.Builder,DocumentGroup>
```
Summary information about documents grouped by the same document type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DocumentGroup.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DocumentGroup.Builder`	`builder()`
`List<DetectedSignature>`	`detectedSignatures()`	A list of the detected signatures found in a document group.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDetectedSignatures()`	For responses, this returns true if the service returned a value for the DetectedSignatures property.
`int`	`hashCode()`
`boolean`	`hasSplitDocuments()`	For responses, this returns true if the service returned a value for the SplitDocuments property.
`boolean`	`hasUndetectedSignatures()`	For responses, this returns true if the service returned a value for the UndetectedSignatures property.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DocumentGroup.Builder>`	`serializableBuilderClass()`
`List<SplitDocument>`	`splitDocuments()`	An array that contains information about the pages of a document, defined by logical boundary.
`DocumentGroup.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`type()`	The type of document that Amazon Textract has detected.
`List<UndetectedSignature>`	`undetectedSignatures()`	A list of any expected signatures not found in a document group.

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
  - type
```
public final String type()
```
    The type of document that Amazon Textract has detected. See Analyze Lending Response Objects for a list of all types returned by Textract.
    
    Returns:
    
    The type of document that Amazon Textract has detected. See Analyze Lending Response Objects for a list of all types returned by Textract.
  - hasSplitDocuments
```
public final boolean hasSplitDocuments()
```
    For responses, this returns true if the service returned a value for the SplitDocuments 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.
  - splitDocuments
```
public final List<SplitDocument> splitDocuments()
```
    An array that contains information about the pages of a document, defined by logical boundary.
    
    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 hasSplitDocuments() method.
    
    Returns:
    
    An array that contains information about the pages of a document, defined by logical boundary.
  - hasDetectedSignatures
```
public final boolean hasDetectedSignatures()
```
    For responses, this returns true if the service returned a value for the DetectedSignatures 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.
  - detectedSignatures
```
public final List<DetectedSignature> detectedSignatures()
```
    A list of the detected signatures found in a document group.
    
    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 hasDetectedSignatures() method.
    
    Returns:
    
    A list of the detected signatures found in a document group.
  - hasUndetectedSignatures
```
public final boolean hasUndetectedSignatures()
```
    For responses, this returns true if the service returned a value for the UndetectedSignatures 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.
  - undetectedSignatures
```
public final List<UndetectedSignature> undetectedSignatures()
```
    A list of any expected signatures not found in a document group.
    
    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 hasUndetectedSignatures() method.
    
    Returns:
    
    A list of any expected signatures not found in a document group.
  - toBuilder
```
public DocumentGroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DocumentGroup.Builder,DocumentGroup>
  - builder
```
public static DocumentGroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DocumentGroup.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DocumentGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

type

hasSplitDocuments

splitDocuments

hasDetectedSignatures

detectedSignatures

hasUndetectedSignatures

undetectedSignatures

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField