com.amazonaws.services.comprehend.model

Class DocumentMetadata

java.lang.Object

com.amazonaws.services.comprehend.model.DocumentMetadata

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Information about the document, discovered during text extraction.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentMetadata()

Method Summary

Modifier and Type	Method and Description
DocumentMetadata	clone()
boolean	equals(Object obj)
List<ExtractedCharactersListItem>	getExtractedCharacters() List of pages in the document, with the number of characters extracted from each page.
Integer	getPages() Number of pages in the document.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setExtractedCharacters(Collection<ExtractedCharactersListItem> extractedCharacters) List of pages in the document, with the number of characters extracted from each page.
void	setPages(Integer pages) Number of pages in the document.
String	toString() Returns a string representation of this object.
DocumentMetadata	withExtractedCharacters(Collection<ExtractedCharactersListItem> extractedCharacters) List of pages in the document, with the number of characters extracted from each page.
DocumentMetadata	withExtractedCharacters(ExtractedCharactersListItem... extractedCharacters) List of pages in the document, with the number of characters extracted from each page.
DocumentMetadata	withPages(Integer pages) Number of pages in the document.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentMetadata

public DocumentMetadata()

Method Detail

setPages

public void setPages(Integer pages)

Number of pages in the document.

Parameters:

pages - Number of pages in the document.

getPages

public Integer getPages()

Number of pages in the document.

Returns:

Number of pages in the document.

withPages

public DocumentMetadata withPages(Integer pages)

Number of pages in the document.

Parameters:

pages - Number of pages in the document.

Returns:

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

getExtractedCharacters

public List<ExtractedCharactersListItem> getExtractedCharacters()

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

Returns:

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

setExtractedCharacters

public void setExtractedCharacters(Collection<ExtractedCharactersListItem> extractedCharacters)

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

Parameters:

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

withExtractedCharacters

public DocumentMetadata withExtractedCharacters(ExtractedCharactersListItem... extractedCharacters)

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

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

Parameters:

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

Returns:

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

withExtractedCharacters

public DocumentMetadata withExtractedCharacters(Collection<ExtractedCharactersListItem> extractedCharacters)

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

Parameters:

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

Returns:

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

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 DocumentMetadata clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.