com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesRequest 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.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class BatchDetectKeyPhrasesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents.
* The maximum size of each document is 5 KB.
*
*/
private java.util.List textList;
/**
*
* 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.
*
*/
private String languageCode;
/**
*
* A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents.
* The maximum size of each document is 5 KB.
*
*
* @return A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25
* documents. The maximum size of each document is 5 KB.
*/
public java.util.List getTextList() {
return textList;
}
/**
*
* A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents.
* The maximum size of each document is 5 KB.
*
*
* @param textList
* A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25
* documents. The maximum size of each document is 5 KB.
*/
public void setTextList(java.util.Collection textList) {
if (textList == null) {
this.textList = null;
return;
}
this.textList = new java.util.ArrayList(textList);
}
/**
*
* A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents.
* The maximum size of each document is 5 KB.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTextList(java.util.Collection)} or {@link #withTextList(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param textList
* A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25
* documents. The maximum size of each document is 5 KB.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchDetectKeyPhrasesRequest withTextList(String... textList) {
if (this.textList == null) {
setTextList(new java.util.ArrayList(textList.length));
}
for (String ele : textList) {
this.textList.add(ele);
}
return this;
}
/**
*
* A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents.
* The maximum size of each document is 5 KB.
*
*
* @param textList
* A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25
* documents. The maximum size of each document is 5 KB.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchDetectKeyPhrasesRequest withTextList(java.util.Collection textList) {
setTextList(textList);
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.
*
*
* @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.
* @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.
*
*
* @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.
* @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.
*
*
* @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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public BatchDetectKeyPhrasesRequest 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.
*
*
* @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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public BatchDetectKeyPhrasesRequest withLanguageCode(LanguageCode languageCode) {
this.languageCode = languageCode.toString();
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 (getTextList() != null)
sb.append("TextList: ").append("***Sensitive Data Redacted***").append(",");
if (getLanguageCode() != null)
sb.append("LanguageCode: ").append(getLanguageCode());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof BatchDetectKeyPhrasesRequest == false)
return false;
BatchDetectKeyPhrasesRequest other = (BatchDetectKeyPhrasesRequest) obj;
if (other.getTextList() == null ^ this.getTextList() == null)
return false;
if (other.getTextList() != null && other.getTextList().equals(this.getTextList()) == false)
return false;
if (other.getLanguageCode() == null ^ this.getLanguageCode() == null)
return false;
if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTextList() == null) ? 0 : getTextList().hashCode());
hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode());
return hashCode;
}
@Override
public BatchDetectKeyPhrasesRequest clone() {
return (BatchDetectKeyPhrasesRequest) super.clone();
}
}