/* * 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.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DetectEntitiesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the * Bytes parameter. *

*/ private String text; /** *

* The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. * If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language * of your custom model, and it ignores any language code that you specify here. *

*

* All input documents must be in the same language. *

*/ private String languageCode; /** *

* The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an * endpoint if you want to detect entities by using your own custom model instead of the default model that is used * by Amazon Comprehend. *

*

* If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language * code that you provide in your request. *

*

* For information about endpoints, see Managing endpoints. *

*/ private String endpointArn; /** *

* This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For * other cases, enter your text input in the Text field. *

*

* Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the * Bytes parameter is equivelent to using the Text parameter (the Entities * field in the response is identical). *

*

* You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or * AnalyzeDocument output file. *

*

* Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to * detect entities, the SDK may encode the document file bytes for you. *

*

* The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom * analysis in the Comprehend Developer Guide. *

*

* If you use the Bytes parameter, do not use the Text parameter. *

*/ private java.nio.ByteBuffer bytes; /** *

* Provides configuration parameters to override the default actions for extracting text from PDF documents and * image files. *

*/ private DocumentReaderConfig documentReaderConfig; /** *

* A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the * Bytes parameter. *

* * @param text * A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use * the Bytes parameter. */ public void setText(String text) { this.text = text; } /** *

* A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the * Bytes parameter. *

* * @return A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not * use the Bytes parameter. */ public String getText() { return this.text; } /** *

* A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the * Bytes parameter. *

* * @param text * A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use * the Bytes parameter. * @return Returns a reference to this object so that method calls can be chained together. */ public DetectEntitiesRequest withText(String text) { setText(text); return this; } /** *

* The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. * If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language * of your custom model, and it ignores any language code that you specify here. *

*

* All input documents must be in the same language. *

* * @param languageCode * The language of the input documents. You can specify any of the primary languages supported by Amazon * Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend * uses the language of your custom model, and it ignores any language code that you specify here.

*

* All input documents must be in the same language. * @see LanguageCode */ public void setLanguageCode(String languageCode) { this.languageCode = languageCode; } /** *

* The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. * If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language * of your custom model, and it ignores any language code that you specify here. *

*

* All input documents must be in the same language. *

* * @return The language of the input documents. You can specify any of the primary languages supported by Amazon * Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon * Comprehend uses the language of your custom model, and it ignores any language code that you specify * here.

*

* All input documents must be in the same language. * @see LanguageCode */ public String getLanguageCode() { return this.languageCode; } /** *

* The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. * If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language * of your custom model, and it ignores any language code that you specify here. *

*

* All input documents must be in the same language. *

* * @param languageCode * The language of the input documents. You can specify any of the primary languages supported by Amazon * Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend * uses the language of your custom model, and it ignores any language code that you specify here.

*

* All input documents must be in the same language. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public DetectEntitiesRequest withLanguageCode(String languageCode) { setLanguageCode(languageCode); return this; } /** *

* The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. * If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language * of your custom model, and it ignores any language code that you specify here. *

*

* All input documents must be in the same language. *

* * @param languageCode * The language of the input documents. You can specify any of the primary languages supported by Amazon * Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend * uses the language of your custom model, and it ignores any language code that you specify here.

*

* All input documents must be in the same language. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public DetectEntitiesRequest withLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** *

* The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an * endpoint if you want to detect entities by using your own custom model instead of the default model that is used * by Amazon Comprehend. *

*

* If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language * code that you provide in your request. *

*

* For information about endpoints, see Managing endpoints. *

* * @param endpointArn * The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide * an endpoint if you want to detect entities by using your own custom model instead of the default model * that is used by Amazon Comprehend.

*

* If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any * language code that you provide in your request. *

*

* For information about endpoints, see Managing endpoints. */ public void setEndpointArn(String endpointArn) { this.endpointArn = endpointArn; } /** *

* The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an * endpoint if you want to detect entities by using your own custom model instead of the default model that is used * by Amazon Comprehend. *

*

* If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language * code that you provide in your request. *

*

* For information about endpoints, see Managing endpoints. *

* * @return The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. * Provide an endpoint if you want to detect entities by using your own custom model instead of the default * model that is used by Amazon Comprehend.

*

* If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any * language code that you provide in your request. *

*

* For information about endpoints, see Managing endpoints. */ public String getEndpointArn() { return this.endpointArn; } /** *

* The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an * endpoint if you want to detect entities by using your own custom model instead of the default model that is used * by Amazon Comprehend. *

*

* If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language * code that you provide in your request. *

*

* For information about endpoints, see Managing endpoints. *

* * @param endpointArn * The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide * an endpoint if you want to detect entities by using your own custom model instead of the default model * that is used by Amazon Comprehend.

*

* If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any * language code that you provide in your request. *

*

* For information about endpoints, see Managing endpoints. * @return Returns a reference to this object so that method calls can be chained together. */ public DetectEntitiesRequest withEndpointArn(String endpointArn) { setEndpointArn(endpointArn); return this; } /** *

* This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For * other cases, enter your text input in the Text field. *

*

* Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the * Bytes parameter is equivelent to using the Text parameter (the Entities * field in the response is identical). *

*

* You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or * AnalyzeDocument output file. *

*

* Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to * detect entities, the SDK may encode the document file bytes for you. *

*

* The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom * analysis in the Comprehend Developer Guide. *

*

* If you use the Bytes parameter, do not use the Text parameter. *

*

* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. * Users of the SDK should not perform Base64 encoding on this field. *

*

* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will * be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or * ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future * major version of the SDK. *

* * @param bytes * This field applies only when you use a custom entity recognition model that was trained with PDF * annotations. For other cases, enter your text input in the Text field.

*

* Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in * the Bytes parameter is equivelent to using the Text parameter (the * Entities field in the response is identical). *

*

* You can also use the Bytes parameter to input an Amazon Textract * DetectDocumentText or AnalyzeDocument output file. *

*

* Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services * SDK to detect entities, the SDK may encode the document file bytes for you. *

*

* The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom * analysis in the Comprehend Developer Guide. *

*

* If you use the Bytes parameter, do not use the Text parameter. */ public void setBytes(java.nio.ByteBuffer bytes) { this.bytes = bytes; } /** *

* This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For * other cases, enter your text input in the Text field. *

*

* Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the * Bytes parameter is equivelent to using the Text parameter (the Entities * field in the response is identical). *

*

* You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or * AnalyzeDocument output file. *

*

* Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to * detect entities, the SDK may encode the document file bytes for you. *

*

* The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom * analysis in the Comprehend Developer Guide. *

*

* If you use the Bytes parameter, do not use the Text parameter. *

*

* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend * using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent * {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. * Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the * {@code position}. *

* * @return This field applies only when you use a custom entity recognition model that was trained with PDF * annotations. For other cases, enter your text input in the Text field.

*

* Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in * the Bytes parameter is equivelent to using the Text parameter (the * Entities field in the response is identical). *

*

* You can also use the Bytes parameter to input an Amazon Textract * DetectDocumentText or AnalyzeDocument output file. *

*

* Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web * Services SDK to detect entities, the SDK may encode the document file bytes for you. *

*

* The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom * analysis in the Comprehend Developer Guide. *

*

* If you use the Bytes parameter, do not use the Text parameter. */ public java.nio.ByteBuffer getBytes() { return this.bytes; } /** *

* This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For * other cases, enter your text input in the Text field. *

*

* Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the * Bytes parameter is equivelent to using the Text parameter (the Entities * field in the response is identical). *

*

* You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or * AnalyzeDocument output file. *

*

* Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to * detect entities, the SDK may encode the document file bytes for you. *

*

* The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom * analysis in the Comprehend Developer Guide. *

*

* If you use the Bytes parameter, do not use the Text parameter. *

*

* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. * Users of the SDK should not perform Base64 encoding on this field. *

*

* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will * be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or * ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future * major version of the SDK. *

* * @param bytes * This field applies only when you use a custom entity recognition model that was trained with PDF * annotations. For other cases, enter your text input in the Text field.

*

* Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in * the Bytes parameter is equivelent to using the Text parameter (the * Entities field in the response is identical). *

*

* You can also use the Bytes parameter to input an Amazon Textract * DetectDocumentText or AnalyzeDocument output file. *

*

* Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services * SDK to detect entities, the SDK may encode the document file bytes for you. *

*

* The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom * analysis in the Comprehend Developer Guide. *

*

* If you use the Bytes parameter, do not use the Text parameter. * @return Returns a reference to this object so that method calls can be chained together. */ public DetectEntitiesRequest withBytes(java.nio.ByteBuffer bytes) { setBytes(bytes); 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 DetectEntitiesRequest 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 (getText() != null) sb.append("Text: ").append("***Sensitive Data Redacted***").append(","); if (getLanguageCode() != null) sb.append("LanguageCode: ").append(getLanguageCode()).append(","); if (getEndpointArn() != null) sb.append("EndpointArn: ").append(getEndpointArn()).append(","); if (getBytes() != null) sb.append("Bytes: ").append(getBytes()).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 DetectEntitiesRequest == false) return false; DetectEntitiesRequest other = (DetectEntitiesRequest) obj; if (other.getText() == null ^ this.getText() == null) return false; if (other.getText() != null && other.getText().equals(this.getText()) == false) return false; if (other.getLanguageCode() == null ^ this.getLanguageCode() == null) return false; if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false) return false; if (other.getEndpointArn() == null ^ this.getEndpointArn() == null) return false; if (other.getEndpointArn() != null && other.getEndpointArn().equals(this.getEndpointArn()) == false) return false; if (other.getBytes() == null ^ this.getBytes() == null) return false; if (other.getBytes() != null && other.getBytes().equals(this.getBytes()) == 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 + ((getText() == null) ? 0 : getText().hashCode()); hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode()); hashCode = prime * hashCode + ((getEndpointArn() == null) ? 0 : getEndpointArn().hashCode()); hashCode = prime * hashCode + ((getBytes() == null) ? 0 : getBytes().hashCode()); hashCode = prime * hashCode + ((getDocumentReaderConfig() == null) ? 0 : getDocumentReaderConfig().hashCode()); return hashCode; } @Override public DetectEntitiesRequest clone() { return (DetectEntitiesRequest) super.clone(); } }