AugmentedManifestsListItem (AWS Java SDK for Amazon Comprehend 1.12.262 API)

java.lang.Object
- com.amazonaws.services.comprehend.model.AugmentedManifestsListItem

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AugmentedManifestsListItem
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AugmentedManifestsListItem()

Constructors
Constructor and Description
`AugmentedManifestsListItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AugmentedManifestsListItem`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAnnotationDataS3Uri()` The S3 prefix to the annotation files that are referred in the augmented manifest file.
`List<String>`	`getAttributeNames()` The JSON attribute that contains the annotations for your training documents.
`String`	`getDocumentType()` The type of augmented manifest.
`String`	`getS3Uri()` The Amazon S3 location of the augmented manifest file.
`String`	`getSourceDocumentsS3Uri()` The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
`String`	`getSplit()` The purpose of the data you've provided in the augmented manifest.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAnnotationDataS3Uri(String annotationDataS3Uri)` The S3 prefix to the annotation files that are referred in the augmented manifest file.
`void`	`setAttributeNames(Collection<String> attributeNames)` The JSON attribute that contains the annotations for your training documents.
`void`	`setDocumentType(String documentType)` The type of augmented manifest.
`void`	`setS3Uri(String s3Uri)` The Amazon S3 location of the augmented manifest file.
`void`	`setSourceDocumentsS3Uri(String sourceDocumentsS3Uri)` The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
`void`	`setSplit(String split)` The purpose of the data you've provided in the augmented manifest.
`String`	`toString()` Returns a string representation of this object.
`AugmentedManifestsListItem`	`withAnnotationDataS3Uri(String annotationDataS3Uri)` The S3 prefix to the annotation files that are referred in the augmented manifest file.
`AugmentedManifestsListItem`	`withAttributeNames(Collection<String> attributeNames)` The JSON attribute that contains the annotations for your training documents.
`AugmentedManifestsListItem`	`withAttributeNames(String... attributeNames)` The JSON attribute that contains the annotations for your training documents.
`AugmentedManifestsListItem`	`withDocumentType(AugmentedManifestsDocumentTypeFormat documentType)` The type of augmented manifest.
`AugmentedManifestsListItem`	`withDocumentType(String documentType)` The type of augmented manifest.
`AugmentedManifestsListItem`	`withS3Uri(String s3Uri)` The Amazon S3 location of the augmented manifest file.
`AugmentedManifestsListItem`	`withSourceDocumentsS3Uri(String sourceDocumentsS3Uri)` The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
`AugmentedManifestsListItem`	`withSplit(Split split)` The purpose of the data you've provided in the augmented manifest.
`AugmentedManifestsListItem`	`withSplit(String split)` The purpose of the data you've provided in the augmented manifest.

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

- Constructor Detail
  - AugmentedManifestsListItem
```
public AugmentedManifestsListItem()
```
- Method Detail
  - setS3Uri
```
public void setS3Uri(String s3Uri)
```
    The Amazon S3 location of the augmented manifest file.
    
    Parameters:
    
    s3Uri - The Amazon S3 location of the augmented manifest file.
  - getS3Uri
```
public String getS3Uri()
```
    The Amazon S3 location of the augmented manifest file.
    
    Returns:
    
    The Amazon S3 location of the augmented manifest file.
  - withS3Uri
```
public AugmentedManifestsListItem withS3Uri(String s3Uri)
```
    The Amazon S3 location of the augmented manifest file.
    
    Parameters:
    
    s3Uri - The Amazon S3 location of the augmented manifest file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSplit
```
public void setSplit(String split)
```
    The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
    
    TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
    
    TEST - all of the documents in the manifest will be used for testing.
    
    Parameters:
    
    split - The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
    
    TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
    
    TEST - all of the documents in the manifest will be used for testing.
    
    See Also:
    
    Split
  - getSplit
```
public String getSplit()
```
    The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
    
    TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
    
    TEST - all of the documents in the manifest will be used for testing.
    
    Returns:
    
    The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
    
    TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
    
    TEST - all of the documents in the manifest will be used for testing.
    
    See Also:
    
    Split
  - withSplit
```
public AugmentedManifestsListItem withSplit(String split)
```
    The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
    
    TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
    
    TEST - all of the documents in the manifest will be used for testing.
    
    Parameters:
    
    split - The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
    
    TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
    
    TEST - all of the documents in the manifest will be used for testing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Split
  - withSplit
```
public AugmentedManifestsListItem withSplit(Split split)
```
    The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
    
    TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
    
    TEST - all of the documents in the manifest will be used for testing.
    
    Parameters:
    
    split - The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
    
    TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
    
    TEST - all of the documents in the manifest will be used for testing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Split
  - getAttributeNames
```
public List<String> getAttributeNames()
```
    The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
    
    If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
    
    If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
    
    Returns:
    
    The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
    
    If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
    
    If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
  - setAttributeNames
```
public void setAttributeNames(Collection<String> attributeNames)
```
    The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
    
    If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
    
    If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
    
    Parameters:
    
    attributeNames - The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
    
    If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
    
    If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
  - withAttributeNames
```
public AugmentedManifestsListItem withAttributeNames(String... attributeNames)
```
    The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
    
    If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
    
    If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttributeNames(java.util.Collection) or withAttributeNames(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    attributeNames - The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
    
    If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
    
    If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttributeNames
```
public AugmentedManifestsListItem withAttributeNames(Collection<String> attributeNames)
```
    The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
    
    If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
    
    If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
    
    Parameters:
    
    attributeNames - The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
    
    If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
    
    If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAnnotationDataS3Uri
```
public void setAnnotationDataS3Uri(String annotationDataS3Uri)
```
    The S3 prefix to the annotation files that are referred in the augmented manifest file.
    
    Parameters:
    
    annotationDataS3Uri - The S3 prefix to the annotation files that are referred in the augmented manifest file.
  - getAnnotationDataS3Uri
```
public String getAnnotationDataS3Uri()
```
    The S3 prefix to the annotation files that are referred in the augmented manifest file.
    
    Returns:
    
    The S3 prefix to the annotation files that are referred in the augmented manifest file.
  - withAnnotationDataS3Uri
```
public AugmentedManifestsListItem withAnnotationDataS3Uri(String annotationDataS3Uri)
```
    The S3 prefix to the annotation files that are referred in the augmented manifest file.
    
    Parameters:
    
    annotationDataS3Uri - The S3 prefix to the annotation files that are referred in the augmented manifest file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceDocumentsS3Uri
```
public void setSourceDocumentsS3Uri(String sourceDocumentsS3Uri)
```
    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    
    Parameters:
    
    sourceDocumentsS3Uri - The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
  - getSourceDocumentsS3Uri
```
public String getSourceDocumentsS3Uri()
```
    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    
    Returns:
    
    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
  - withSourceDocumentsS3Uri
```
public AugmentedManifestsListItem withSourceDocumentsS3Uri(String sourceDocumentsS3Uri)
```
    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    
    Parameters:
    
    sourceDocumentsS3Uri - The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentType
```
public void setDocumentType(String documentType)
```
    The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
    - PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
    - SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
    Parameters:
    documentType - The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
    
    PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
    
    SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
    See Also:
    
    AugmentedManifestsDocumentTypeFormat
  - getDocumentType
```
public String getDocumentType()
```
    The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
    - PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
    - SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
    Returns:
    The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
    
    PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
    
    SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
    See Also:
    
    AugmentedManifestsDocumentTypeFormat
  - withDocumentType
```
public AugmentedManifestsListItem withDocumentType(String documentType)
```
    The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
    - PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
    - SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
    Parameters:
    documentType - The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
    
    PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
    
    SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AugmentedManifestsDocumentTypeFormat
  - withDocumentType
```
public AugmentedManifestsListItem withDocumentType(AugmentedManifestsDocumentTypeFormat documentType)
```
    The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
    - PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
    - SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
    Parameters:
    documentType - The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
    
    PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.
    
    SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AugmentedManifestsDocumentTypeFormat
  - 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 AugmentedManifestsListItem clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class AugmentedManifestsListItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AugmentedManifestsListItem

Method Detail

setS3Uri

getS3Uri

withS3Uri

setSplit

getSplit

withSplit

withSplit

getAttributeNames

setAttributeNames

withAttributeNames

withAttributeNames

setAnnotationDataS3Uri

getAnnotationDataS3Uri

withAnnotationDataS3Uri

setSourceDocumentsS3Uri

getSourceDocumentsS3Uri

withSourceDocumentsS3Uri

setDocumentType

getDocumentType

withDocumentType

withDocumentType

toString

equals

hashCode

clone

marshall