/* * Copyright 2010-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.rekognition.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Gets the text detection results of a Amazon Rekognition Video analysis * started by StartTextDetection. *

*

* Text detection with Amazon Rekognition Video is an asynchronous operation. * You start text detection by calling StartTextDetection which returns a * job identifier (JobId) When the text detection operation * finishes, Amazon Rekognition publishes a completion status to the Amazon * Simple Notification Service topic registered in the initial call to * StartTextDetection. To get the results of the text detection * operation, first check that the status value published to the Amazon SNS * topic is SUCCEEDED. if so, call GetTextDetection * and pass the job identifier (JobId) from the initial call of * StartLabelDetection. *

*

* GetTextDetection returns an array of detected text ( * TextDetections) sorted by the time the text was detected, up to * 50 words per frame of video. *

*

* Each element of the array includes the detected text, the precentage * confidence in the acuracy of the detected text, the time the text was * detected, bounding box information for where the text was located, and unique * identifiers for words and their lines. *

*

* Use MaxResults parameter to limit the number of text detections returned. If * there are more results than specified in MaxResults, the value * of NextToken in the operation response contains a pagination * token for getting the next set of results. To get the next page of results, * call GetTextDetection and populate the NextToken * request parameter with the token value returned from the previous call to * GetTextDetection. *

*/ public class GetTextDetectionRequest extends AmazonWebServiceRequest implements Serializable { /** *

* Job identifier for the text detection operation for which you want * results returned. You get the job identifer from an initial call to * StartTextDetection. *

*

* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*/ private String jobId; /** *

* Maximum number of results to return per paginated call. The largest value * you can specify is 1000. *

*

* Constraints:
* Range: 1 -
*/ private Integer maxResults; /** *

* If the previous response was incomplete (because there are more labels to * retrieve), Amazon Rekognition Video returns a pagination token in the * response. You can use this pagination token to retrieve the next set of * text. *

*

* Constraints:
* Length: - 255
*/ private String nextToken; /** *

* Job identifier for the text detection operation for which you want * results returned. You get the job identifer from an initial call to * StartTextDetection. *

*

* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
* * @return

* Job identifier for the text detection operation for which you * want results returned. You get the job identifer from an initial * call to StartTextDetection. *

*/ public String getJobId() { return jobId; } /** *

* Job identifier for the text detection operation for which you want * results returned. You get the job identifer from an initial call to * StartTextDetection. *

*

* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
* * @param jobId

* Job identifier for the text detection operation for which you * want results returned. You get the job identifer from an * initial call to StartTextDetection. *

*/ public void setJobId(String jobId) { this.jobId = jobId; } /** *

* Job identifier for the text detection operation for which you want * results returned. You get the job identifer from an initial call to * StartTextDetection. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
* * @param jobId

* Job identifier for the text detection operation for which you * want results returned. You get the job identifer from an * initial call to StartTextDetection. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetTextDetectionRequest withJobId(String jobId) { this.jobId = jobId; return this; } /** *

* Maximum number of results to return per paginated call. The largest value * you can specify is 1000. *

*

* Constraints:
* Range: 1 -
* * @return

* Maximum number of results to return per paginated call. The * largest value you can specify is 1000. *

*/ public Integer getMaxResults() { return maxResults; } /** *

* Maximum number of results to return per paginated call. The largest value * you can specify is 1000. *

*

* Constraints:
* Range: 1 -
* * @param maxResults

* Maximum number of results to return per paginated call. The * largest value you can specify is 1000. *

*/ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** *

* Maximum number of results to return per paginated call. The largest value * you can specify is 1000. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 1 -
* * @param maxResults

* Maximum number of results to return per paginated call. The * largest value you can specify is 1000. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetTextDetectionRequest withMaxResults(Integer maxResults) { this.maxResults = maxResults; return this; } /** *

* If the previous response was incomplete (because there are more labels to * retrieve), Amazon Rekognition Video returns a pagination token in the * response. You can use this pagination token to retrieve the next set of * text. *

*

* Constraints:
* Length: - 255
* * @return

* If the previous response was incomplete (because there are more * labels to retrieve), Amazon Rekognition Video returns a * pagination token in the response. You can use this pagination * token to retrieve the next set of text. *

*/ public String getNextToken() { return nextToken; } /** *

* If the previous response was incomplete (because there are more labels to * retrieve), Amazon Rekognition Video returns a pagination token in the * response. You can use this pagination token to retrieve the next set of * text. *

*

* Constraints:
* Length: - 255
* * @param nextToken

* If the previous response was incomplete (because there are * more labels to retrieve), Amazon Rekognition Video returns a * pagination token in the response. You can use this pagination * token to retrieve the next set of text. *

*/ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** *

* If the previous response was incomplete (because there are more labels to * retrieve), Amazon Rekognition Video returns a pagination token in the * response. You can use this pagination token to retrieve the next set of * text. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: - 255
* * @param nextToken

* If the previous response was incomplete (because there are * more labels to retrieve), Amazon Rekognition Video returns a * pagination token in the response. You can use this pagination * token to retrieve the next set of text. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetTextDetectionRequest withNextToken(String nextToken) { this.nextToken = nextToken; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @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: " + getJobId() + ","); if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults() + ","); if (getNextToken() != null) sb.append("NextToken: " + getNextToken()); sb.append("}"); return sb.toString(); } @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 boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetTextDetectionRequest == false) return false; GetTextDetectionRequest other = (GetTextDetectionRequest) 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; } }