com.amazonaws.services.textract.model.Query Maven / Gradle / Ivy
Show all versions of aws-java-sdk-textract Show documentation
/*
* Copyright 2019-2024 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.textract.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Each query contains the question you want to ask in the Text and the alias you want to associate.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Query implements Serializable, Cloneable, StructuredPojo {
/**
*
* Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
*
*/
private String text;
/**
*
* Alias attached to the query, for ease of location.
*
*/
private String alias;
/**
*
* Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of
* rules for using this parameter.
*
*
* -
*
* If a page is not specified, it is set to ["1"] by default.
*
*
* -
*
* The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No
* whitespace is allowed.
*
*
* -
*
* When using * to indicate all pages, it must be the only element in the list.
*
*
* -
*
* You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page
* of document.
*
*
* -
*
* Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
*
*
*
*/
private java.util.List pages;
/**
*
* Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
*
*
* @param text
* Question that Amazon Textract will apply to the document. An example would be
* "What is the customer's SSN?"
*/
public void setText(String text) {
this.text = text;
}
/**
*
* Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
*
*
* @return Question that Amazon Textract will apply to the document. An example would be
* "What is the customer's SSN?"
*/
public String getText() {
return this.text;
}
/**
*
* Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
*
*
* @param text
* Question that Amazon Textract will apply to the document. An example would be
* "What is the customer's SSN?"
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Query withText(String text) {
setText(text);
return this;
}
/**
*
* Alias attached to the query, for ease of location.
*
*
* @param alias
* Alias attached to the query, for ease of location.
*/
public void setAlias(String alias) {
this.alias = alias;
}
/**
*
* Alias attached to the query, for ease of location.
*
*
* @return Alias attached to the query, for ease of location.
*/
public String getAlias() {
return this.alias;
}
/**
*
* Alias attached to the query, for ease of location.
*
*
* @param alias
* Alias attached to the query, for ease of location.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Query withAlias(String alias) {
setAlias(alias);
return this;
}
/**
*
* Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of
* rules for using this parameter.
*
*
* -
*
* If a page is not specified, it is set to ["1"] by default.
*
*
* -
*
* The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No
* whitespace is allowed.
*
*
* -
*
* When using * to indicate all pages, it must be the only element in the list.
*
*
* -
*
* You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page
* of document.
*
*
* -
*
* Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
*
*
*
*
* @return Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a
* list of rules for using this parameter.
*
* -
*
* If a page is not specified, it is set to ["1"] by default.
*
*
* -
*
* The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No
* whitespace is allowed.
*
*
* -
*
* When using * to indicate all pages, it must be the only element in the list.
*
*
* -
*
* You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates
* last page of document.
*
*
* -
*
* Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
*
*
*/
public java.util.List getPages() {
return pages;
}
/**
*
* Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of
* rules for using this parameter.
*
*
* -
*
* If a page is not specified, it is set to ["1"] by default.
*
*
* -
*
* The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No
* whitespace is allowed.
*
*
* -
*
* When using * to indicate all pages, it must be the only element in the list.
*
*
* -
*
* You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page
* of document.
*
*
* -
*
* Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
*
*
*
*
* @param pages
* Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a
* list of rules for using this parameter.
*
* -
*
* If a page is not specified, it is set to ["1"] by default.
*
*
* -
*
* The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No
* whitespace is allowed.
*
*
* -
*
* When using * to indicate all pages, it must be the only element in the list.
*
*
* -
*
* You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates
* last page of document.
*
*
* -
*
* Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
*
*
*/
public void setPages(java.util.Collection pages) {
if (pages == null) {
this.pages = null;
return;
}
this.pages = new java.util.ArrayList(pages);
}
/**
*
* Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of
* rules for using this parameter.
*
*
* -
*
* If a page is not specified, it is set to ["1"] by default.
*
*
* -
*
* The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No
* whitespace is allowed.
*
*
* -
*
* When using * to indicate all pages, it must be the only element in the list.
*
*
* -
*
* You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page
* of document.
*
*
* -
*
* Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPages(java.util.Collection)} or {@link #withPages(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param pages
* Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a
* list of rules for using this parameter.
*
* -
*
* If a page is not specified, it is set to ["1"] by default.
*
*
* -
*
* The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No
* whitespace is allowed.
*
*
* -
*
* When using * to indicate all pages, it must be the only element in the list.
*
*
* -
*
* You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates
* last page of document.
*
*
* -
*
* Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Query withPages(String... pages) {
if (this.pages == null) {
setPages(new java.util.ArrayList(pages.length));
}
for (String ele : pages) {
this.pages.add(ele);
}
return this;
}
/**
*
* Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of
* rules for using this parameter.
*
*
* -
*
* If a page is not specified, it is set to ["1"] by default.
*
*
* -
*
* The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No
* whitespace is allowed.
*
*
* -
*
* When using * to indicate all pages, it must be the only element in the list.
*
*
* -
*
* You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page
* of document.
*
*
* -
*
* Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
*
*
*
*
* @param pages
* Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a
* list of rules for using this parameter.
*
* -
*
* If a page is not specified, it is set to ["1"] by default.
*
*
* -
*
* The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No
* whitespace is allowed.
*
*
* -
*
* When using * to indicate all pages, it must be the only element in the list.
*
*
* -
*
* You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates
* last page of document.
*
*
* -
*
* Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Query withPages(java.util.Collection pages) {
setPages(pages);
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(getText()).append(",");
if (getAlias() != null)
sb.append("Alias: ").append(getAlias()).append(",");
if (getPages() != null)
sb.append("Pages: ").append(getPages());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Query == false)
return false;
Query other = (Query) obj;
if (other.getText() == null ^ this.getText() == null)
return false;
if (other.getText() != null && other.getText().equals(this.getText()) == false)
return false;
if (other.getAlias() == null ^ this.getAlias() == null)
return false;
if (other.getAlias() != null && other.getAlias().equals(this.getAlias()) == false)
return false;
if (other.getPages() == null ^ this.getPages() == null)
return false;
if (other.getPages() != null && other.getPages().equals(this.getPages()) == 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 + ((getAlias() == null) ? 0 : getAlias().hashCode());
hashCode = prime * hashCode + ((getPages() == null) ? 0 : getPages().hashCode());
return hashCode;
}
@Override
public Query clone() {
try {
return (Query) 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.textract.model.transform.QueryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}