com.amazonaws.services.textract.model.GetDocumentTextDetectionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-textract Show documentation
/*
* Copyright 2014-2019 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.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetDocumentTextDetectionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique identifier for the text detection job. The JobId is returned from
* StartDocumentTextDetection.
*
*/
private String jobId;
/**
*
* The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you
* specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.
*
*/
private Integer maxResults;
/**
*
* If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a
* pagination token in the response. You can use this pagination token to retrieve the next set of blocks.
*
*/
private String nextToken;
/**
*
* A unique identifier for the text detection job. The JobId is returned from
* StartDocumentTextDetection.
*
*
* @param jobId
* A unique identifier for the text detection job. The JobId is returned from
* StartDocumentTextDetection.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
*
* A unique identifier for the text detection job. The JobId is returned from
* StartDocumentTextDetection.
*
*
* @return A unique identifier for the text detection job. The JobId is returned from
* StartDocumentTextDetection.
*/
public String getJobId() {
return this.jobId;
}
/**
*
* A unique identifier for the text detection job. The JobId is returned from
* StartDocumentTextDetection.
*
*
* @param jobId
* A unique identifier for the text detection job. The JobId is returned from
* StartDocumentTextDetection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentTextDetectionRequest withJobId(String jobId) {
setJobId(jobId);
return this;
}
/**
*
* The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you
* specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.
*
*
* @param maxResults
* The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If
* you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is
* 1,000.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you
* specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.
*
*
* @return The maximum number of results to return per paginated call. The largest value you can specify is 1,000.
* If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is
* 1,000.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you
* specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.
*
*
* @param maxResults
* The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If
* you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is
* 1,000.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentTextDetectionRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a
* pagination token in the response. You can use this pagination token to retrieve the next set of blocks.
*
*
* @param nextToken
* If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract
* returns a pagination token in the response. You can use this pagination token to retrieve the next set of
* blocks.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a
* pagination token in the response. You can use this pagination token to retrieve the next set of blocks.
*
*
* @return If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract
* returns a pagination token in the response. You can use this pagination token to retrieve the next set of
* blocks.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a
* pagination token in the response. You can use this pagination token to retrieve the next set of blocks.
*
*
* @param nextToken
* If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract
* returns a pagination token in the response. You can use this pagination token to retrieve the next set of
* blocks.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentTextDetectionRequest withNextToken(String nextToken) {
setNextToken(nextToken);
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 (getJobId() != null)
sb.append("JobId: ").append(getJobId()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetDocumentTextDetectionRequest == false)
return false;
GetDocumentTextDetectionRequest other = (GetDocumentTextDetectionRequest) obj;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public GetDocumentTextDetectionRequest clone() {
return (GetDocumentTextDetectionRequest) super.clone();
}
}