com.amazonaws.services.comprehend.model.InputDataConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-comprehend Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.comprehend.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The input properties for an inference job. The document reader config field applies only to non-text inputs for
* custom analysis.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class InputDataConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling.
* The URI can point to a single input file or it can provide the prefix for a collection of data files.
*
*
* For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon
* Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of
* them as input.
*
*/
private String s3Uri;
/**
*
* Specifies how the text in an input file should be processed:
*
*
* -
*
* ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are
* processing large documents, such as newspaper articles or scientific papers.
*
*
* -
*
* ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you
* are processing many short documents, such as text messages.
*
*
*
*/
private String inputFormat;
/**
*
* Provides configuration parameters to override the default actions for extracting text from PDF documents and
* image files.
*
*/
private DocumentReaderConfig documentReaderConfig;
/**
*
* The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling.
* The URI can point to a single input file or it can provide the prefix for a collection of data files.
*
*
* For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon
* Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of
* them as input.
*
*
* @param s3Uri
* The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are
* calling. The URI can point to a single input file or it can provide the prefix for a collection of data
* files.
*
* For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file,
* Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend
* uses all of them as input.
*/
public void setS3Uri(String s3Uri) {
this.s3Uri = s3Uri;
}
/**
*
* The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling.
* The URI can point to a single input file or it can provide the prefix for a collection of data files.
*
*
* For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon
* Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of
* them as input.
*
*
* @return The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are
* calling. The URI can point to a single input file or it can provide the prefix for a collection of data
* files.
*
* For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file,
* Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon
* Comprehend uses all of them as input.
*/
public String getS3Uri() {
return this.s3Uri;
}
/**
*
* The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling.
* The URI can point to a single input file or it can provide the prefix for a collection of data files.
*
*
* For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon
* Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of
* them as input.
*
*
* @param s3Uri
* The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are
* calling. The URI can point to a single input file or it can provide the prefix for a collection of data
* files.
*
* For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file,
* Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend
* uses all of them as input.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InputDataConfig withS3Uri(String s3Uri) {
setS3Uri(s3Uri);
return this;
}
/**
*
* Specifies how the text in an input file should be processed:
*
*
* -
*
* ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are
* processing large documents, such as newspaper articles or scientific papers.
*
*
* -
*
* ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you
* are processing many short documents, such as text messages.
*
*
*
*
* @param inputFormat
* Specifies how the text in an input file should be processed:
*
* -
*
* ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are
* processing large documents, such as newspaper articles or scientific papers.
*
*
* -
*
* ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option
* when you are processing many short documents, such as text messages.
*
*
* @see InputFormat
*/
public void setInputFormat(String inputFormat) {
this.inputFormat = inputFormat;
}
/**
*
* Specifies how the text in an input file should be processed:
*
*
* -
*
* ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are
* processing large documents, such as newspaper articles or scientific papers.
*
*
* -
*
* ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you
* are processing many short documents, such as text messages.
*
*
*
*
* @return Specifies how the text in an input file should be processed:
*
* -
*
* ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are
* processing large documents, such as newspaper articles or scientific papers.
*
*
* -
*
* ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option
* when you are processing many short documents, such as text messages.
*
*
* @see InputFormat
*/
public String getInputFormat() {
return this.inputFormat;
}
/**
*
* Specifies how the text in an input file should be processed:
*
*
* -
*
* ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are
* processing large documents, such as newspaper articles or scientific papers.
*
*
* -
*
* ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you
* are processing many short documents, such as text messages.
*
*
*
*
* @param inputFormat
* Specifies how the text in an input file should be processed:
*
* -
*
* ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are
* processing large documents, such as newspaper articles or scientific papers.
*
*
* -
*
* ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option
* when you are processing many short documents, such as text messages.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see InputFormat
*/
public InputDataConfig withInputFormat(String inputFormat) {
setInputFormat(inputFormat);
return this;
}
/**
*
* Specifies how the text in an input file should be processed:
*
*
* -
*
* ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are
* processing large documents, such as newspaper articles or scientific papers.
*
*
* -
*
* ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you
* are processing many short documents, such as text messages.
*
*
*
*
* @param inputFormat
* Specifies how the text in an input file should be processed:
*
* -
*
* ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are
* processing large documents, such as newspaper articles or scientific papers.
*
*
* -
*
* ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option
* when you are processing many short documents, such as text messages.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see InputFormat
*/
public InputDataConfig withInputFormat(InputFormat inputFormat) {
this.inputFormat = inputFormat.toString();
return this;
}
/**
*
* Provides configuration parameters to override the default actions for extracting text from PDF documents and
* image files.
*
*
* @param documentReaderConfig
* Provides configuration parameters to override the default actions for extracting text from PDF documents
* and image files.
*/
public void setDocumentReaderConfig(DocumentReaderConfig documentReaderConfig) {
this.documentReaderConfig = documentReaderConfig;
}
/**
*
* Provides configuration parameters to override the default actions for extracting text from PDF documents and
* image files.
*
*
* @return Provides configuration parameters to override the default actions for extracting text from PDF documents
* and image files.
*/
public DocumentReaderConfig getDocumentReaderConfig() {
return this.documentReaderConfig;
}
/**
*
* Provides configuration parameters to override the default actions for extracting text from PDF documents and
* image files.
*
*
* @param documentReaderConfig
* Provides configuration parameters to override the default actions for extracting text from PDF documents
* and image files.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InputDataConfig withDocumentReaderConfig(DocumentReaderConfig documentReaderConfig) {
setDocumentReaderConfig(documentReaderConfig);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getS3Uri() != null)
sb.append("S3Uri: ").append(getS3Uri()).append(",");
if (getInputFormat() != null)
sb.append("InputFormat: ").append(getInputFormat()).append(",");
if (getDocumentReaderConfig() != null)
sb.append("DocumentReaderConfig: ").append(getDocumentReaderConfig());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof InputDataConfig == false)
return false;
InputDataConfig other = (InputDataConfig) obj;
if (other.getS3Uri() == null ^ this.getS3Uri() == null)
return false;
if (other.getS3Uri() != null && other.getS3Uri().equals(this.getS3Uri()) == false)
return false;
if (other.getInputFormat() == null ^ this.getInputFormat() == null)
return false;
if (other.getInputFormat() != null && other.getInputFormat().equals(this.getInputFormat()) == false)
return false;
if (other.getDocumentReaderConfig() == null ^ this.getDocumentReaderConfig() == null)
return false;
if (other.getDocumentReaderConfig() != null && other.getDocumentReaderConfig().equals(this.getDocumentReaderConfig()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getS3Uri() == null) ? 0 : getS3Uri().hashCode());
hashCode = prime * hashCode + ((getInputFormat() == null) ? 0 : getInputFormat().hashCode());
hashCode = prime * hashCode + ((getDocumentReaderConfig() == null) ? 0 : getDocumentReaderConfig().hashCode());
return hashCode;
}
@Override
public InputDataConfig clone() {
try {
return (InputDataConfig) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.comprehend.model.transform.InputDataConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}