com.amazonaws.services.comprehend.model.DetectEntitiesRequest Maven / Gradle / Ivy
/*
* Copyright 2017-2022 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. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
*
*/
private String text;
/**
*
* The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend.
* All documents must be in the same language.
*
*
* 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.
*
*/
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.
*
*/
private String endpointArn;
/**
*
* A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
*
*
* @param text
* A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
*/
public void setText(String text) {
this.text = text;
}
/**
*
* A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
*
*
* @return A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
*/
public String getText() {
return this.text;
}
/**
*
* A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
*
*
* @param text
* A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
* @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.
* All documents must be in the same language.
*
*
* 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.
*
*
* @param languageCode
* The language of the input documents. You can specify any of the primary languages supported by Amazon
* Comprehend. All documents must be in the same language.
*
* 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.
* @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.
* All documents must be in the same language.
*
*
* 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.
*
*
* @return The language of the input documents. You can specify any of the primary languages supported by Amazon
* Comprehend. All documents must be in the same language.
*
* 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.
* @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.
* All documents must be in the same language.
*
*
* 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.
*
*
* @param languageCode
* The language of the input documents. You can specify any of the primary languages supported by Amazon
* Comprehend. All documents must be in the same language.
*
* 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.
* @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.
* All documents must be in the same language.
*
*
* 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.
*
*
* @param languageCode
* The language of the input documents. You can specify any of the primary languages supported by Amazon
* Comprehend. All documents must be in the same language.
*
* 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.
* @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.
*
*
* @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.
*/
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.
*
*
* @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.
*/
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.
*
*
* @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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DetectEntitiesRequest withEndpointArn(String endpointArn) {
setEndpointArn(endpointArn);
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());
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;
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());
return hashCode;
}
@Override
public DetectEntitiesRequest clone() {
return (DetectEntitiesRequest) super.clone();
}
}