Package software.amazon.awssdk.services.comprehend.model

Class DocumentMetadata

java.lang.Object

software.amazon.awssdk.services.comprehend.model.DocumentMetadata

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentMetadata.Builder,DocumentMetadata>

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

Information about the document, discovered during text extraction.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentMetadata.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentMetadata.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<ExtractedCharactersListItem>	extractedCharacters()	List of pages in the document, with the number of characters extracted from each page.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExtractedCharacters()	For responses, this returns true if the service returned a value for the ExtractedCharacters property.
int	hashCode()
Integer	pages()	Number of pages in the document.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentMetadata.Builder>	serializableBuilderClass()
DocumentMetadata.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

pages

public final Integer pages()

Number of pages in the document.

Returns:

Number of pages in the document.

hasExtractedCharacters

public final boolean hasExtractedCharacters()

For responses, this returns true if the service returned a value for the ExtractedCharacters 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.

extractedCharacters

public final List<ExtractedCharactersListItem> extractedCharacters()

List of pages in the document, with the number of characters extracted from each page.

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 hasExtractedCharacters() method.

Returns:

List of pages in the document, with the number of characters extracted from each page.

toBuilder

public DocumentMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentMetadata.Builder,DocumentMetadata>

builder

public static DocumentMetadata.Builder builder()

serializableBuilderClass

public static Class<? extends DocumentMetadata.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