com.amazonaws.services.rekognition.model.GetTextDetectionResult Maven / Gradle / Ivy
/*
* 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.rekognition.model;
import java.io.Serializable;
import javax.annotation.Generated;
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetTextDetectionResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* Current status of the text detection job.
*
*/
private String jobStatus;
/**
*
* If the job fails, StatusMessage provides a descriptive error message.
*
*/
private String statusMessage;
private VideoMetadata videoMetadata;
/**
*
* An array of text detected in the video. Each element contains the detected text, the time in milliseconds from
* the start of the video that the text was detected, and where it was detected on the screen.
*
*/
private java.util.List textDetections;
/**
*
* If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent
* request to retrieve the next set of text.
*
*/
private String nextToken;
/**
*
* Version number of the text detection model that was used to detect text.
*
*/
private String textModelVersion;
/**
*
* Job identifier for the text detection operation for which you want to obtain results. The job identifer is
* returned by an initial call to StartTextDetection.
*
*/
private String jobId;
private Video video;
/**
*
* A job identifier specified in the call to StartTextDetection and returned in the job completion notification sent
* to your Amazon Simple Notification Service topic.
*
*/
private String jobTag;
/**
*
* Current status of the text detection job.
*
*
* @param jobStatus
* Current status of the text detection job.
* @see VideoJobStatus
*/
public void setJobStatus(String jobStatus) {
this.jobStatus = jobStatus;
}
/**
*
* Current status of the text detection job.
*
*
* @return Current status of the text detection job.
* @see VideoJobStatus
*/
public String getJobStatus() {
return this.jobStatus;
}
/**
*
* Current status of the text detection job.
*
*
* @param jobStatus
* Current status of the text detection job.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VideoJobStatus
*/
public GetTextDetectionResult withJobStatus(String jobStatus) {
setJobStatus(jobStatus);
return this;
}
/**
*
* Current status of the text detection job.
*
*
* @param jobStatus
* Current status of the text detection job.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VideoJobStatus
*/
public GetTextDetectionResult withJobStatus(VideoJobStatus jobStatus) {
this.jobStatus = jobStatus.toString();
return this;
}
/**
*
* If the job fails, StatusMessage provides a descriptive error message.
*
*
* @param statusMessage
* If the job fails, StatusMessage provides a descriptive error message.
*/
public void setStatusMessage(String statusMessage) {
this.statusMessage = statusMessage;
}
/**
*
* If the job fails, StatusMessage provides a descriptive error message.
*
*
* @return If the job fails, StatusMessage provides a descriptive error message.
*/
public String getStatusMessage() {
return this.statusMessage;
}
/**
*
* If the job fails, StatusMessage provides a descriptive error message.
*
*
* @param statusMessage
* If the job fails, StatusMessage provides a descriptive error message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTextDetectionResult withStatusMessage(String statusMessage) {
setStatusMessage(statusMessage);
return this;
}
/**
* @param videoMetadata
*/
public void setVideoMetadata(VideoMetadata videoMetadata) {
this.videoMetadata = videoMetadata;
}
/**
* @return
*/
public VideoMetadata getVideoMetadata() {
return this.videoMetadata;
}
/**
* @param videoMetadata
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTextDetectionResult withVideoMetadata(VideoMetadata videoMetadata) {
setVideoMetadata(videoMetadata);
return this;
}
/**
*
* An array of text detected in the video. Each element contains the detected text, the time in milliseconds from
* the start of the video that the text was detected, and where it was detected on the screen.
*
*
* @return An array of text detected in the video. Each element contains the detected text, the time in milliseconds
* from the start of the video that the text was detected, and where it was detected on the screen.
*/
public java.util.List getTextDetections() {
return textDetections;
}
/**
*
* An array of text detected in the video. Each element contains the detected text, the time in milliseconds from
* the start of the video that the text was detected, and where it was detected on the screen.
*
*
* @param textDetections
* An array of text detected in the video. Each element contains the detected text, the time in milliseconds
* from the start of the video that the text was detected, and where it was detected on the screen.
*/
public void setTextDetections(java.util.Collection textDetections) {
if (textDetections == null) {
this.textDetections = null;
return;
}
this.textDetections = new java.util.ArrayList(textDetections);
}
/**
*
* An array of text detected in the video. Each element contains the detected text, the time in milliseconds from
* the start of the video that the text was detected, and where it was detected on the screen.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTextDetections(java.util.Collection)} or {@link #withTextDetections(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param textDetections
* An array of text detected in the video. Each element contains the detected text, the time in milliseconds
* from the start of the video that the text was detected, and where it was detected on the screen.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTextDetectionResult withTextDetections(TextDetectionResult... textDetections) {
if (this.textDetections == null) {
setTextDetections(new java.util.ArrayList(textDetections.length));
}
for (TextDetectionResult ele : textDetections) {
this.textDetections.add(ele);
}
return this;
}
/**
*
* An array of text detected in the video. Each element contains the detected text, the time in milliseconds from
* the start of the video that the text was detected, and where it was detected on the screen.
*
*
* @param textDetections
* An array of text detected in the video. Each element contains the detected text, the time in milliseconds
* from the start of the video that the text was detected, and where it was detected on the screen.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTextDetectionResult withTextDetections(java.util.Collection textDetections) {
setTextDetections(textDetections);
return this;
}
/**
*
* If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent
* request to retrieve the next set of text.
*
*
* @param nextToken
* If the response is truncated, Amazon Rekognition Video returns this token that you can use in the
* subsequent request to retrieve the next set of text.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent
* request to retrieve the next set of text.
*
*
* @return If the response is truncated, Amazon Rekognition Video returns this token that you can use in the
* subsequent request to retrieve the next set of text.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent
* request to retrieve the next set of text.
*
*
* @param nextToken
* If the response is truncated, Amazon Rekognition Video returns this token that you can use in the
* subsequent request to retrieve the next set of text.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTextDetectionResult withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* Version number of the text detection model that was used to detect text.
*
*
* @param textModelVersion
* Version number of the text detection model that was used to detect text.
*/
public void setTextModelVersion(String textModelVersion) {
this.textModelVersion = textModelVersion;
}
/**
*
* Version number of the text detection model that was used to detect text.
*
*
* @return Version number of the text detection model that was used to detect text.
*/
public String getTextModelVersion() {
return this.textModelVersion;
}
/**
*
* Version number of the text detection model that was used to detect text.
*
*
* @param textModelVersion
* Version number of the text detection model that was used to detect text.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTextDetectionResult withTextModelVersion(String textModelVersion) {
setTextModelVersion(textModelVersion);
return this;
}
/**
*
* Job identifier for the text detection operation for which you want to obtain results. The job identifer is
* returned by an initial call to StartTextDetection.
*
*
* @param jobId
* Job identifier for the text detection operation for which you want to obtain results. The job identifer is
* returned by an initial call to StartTextDetection.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
*
* Job identifier for the text detection operation for which you want to obtain results. The job identifer is
* returned by an initial call to StartTextDetection.
*
*
* @return Job identifier for the text detection operation for which you want to obtain results. The job identifer
* is returned by an initial call to StartTextDetection.
*/
public String getJobId() {
return this.jobId;
}
/**
*
* Job identifier for the text detection operation for which you want to obtain results. The job identifer is
* returned by an initial call to StartTextDetection.
*
*
* @param jobId
* Job identifier for the text detection operation for which you want to obtain results. The job identifer is
* returned by an initial call to StartTextDetection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTextDetectionResult withJobId(String jobId) {
setJobId(jobId);
return this;
}
/**
* @param video
*/
public void setVideo(Video video) {
this.video = video;
}
/**
* @return
*/
public Video getVideo() {
return this.video;
}
/**
* @param video
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTextDetectionResult withVideo(Video video) {
setVideo(video);
return this;
}
/**
*
* A job identifier specified in the call to StartTextDetection and returned in the job completion notification sent
* to your Amazon Simple Notification Service topic.
*
*
* @param jobTag
* A job identifier specified in the call to StartTextDetection and returned in the job completion
* notification sent to your Amazon Simple Notification Service topic.
*/
public void setJobTag(String jobTag) {
this.jobTag = jobTag;
}
/**
*
* A job identifier specified in the call to StartTextDetection and returned in the job completion notification sent
* to your Amazon Simple Notification Service topic.
*
*
* @return A job identifier specified in the call to StartTextDetection and returned in the job completion
* notification sent to your Amazon Simple Notification Service topic.
*/
public String getJobTag() {
return this.jobTag;
}
/**
*
* A job identifier specified in the call to StartTextDetection and returned in the job completion notification sent
* to your Amazon Simple Notification Service topic.
*
*
* @param jobTag
* A job identifier specified in the call to StartTextDetection and returned in the job completion
* notification sent to your Amazon Simple Notification Service topic.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTextDetectionResult withJobTag(String jobTag) {
setJobTag(jobTag);
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 (getJobStatus() != null)
sb.append("JobStatus: ").append(getJobStatus()).append(",");
if (getStatusMessage() != null)
sb.append("StatusMessage: ").append(getStatusMessage()).append(",");
if (getVideoMetadata() != null)
sb.append("VideoMetadata: ").append(getVideoMetadata()).append(",");
if (getTextDetections() != null)
sb.append("TextDetections: ").append(getTextDetections()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getTextModelVersion() != null)
sb.append("TextModelVersion: ").append(getTextModelVersion()).append(",");
if (getJobId() != null)
sb.append("JobId: ").append(getJobId()).append(",");
if (getVideo() != null)
sb.append("Video: ").append(getVideo()).append(",");
if (getJobTag() != null)
sb.append("JobTag: ").append(getJobTag());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetTextDetectionResult == false)
return false;
GetTextDetectionResult other = (GetTextDetectionResult) obj;
if (other.getJobStatus() == null ^ this.getJobStatus() == null)
return false;
if (other.getJobStatus() != null && other.getJobStatus().equals(this.getJobStatus()) == false)
return false;
if (other.getStatusMessage() == null ^ this.getStatusMessage() == null)
return false;
if (other.getStatusMessage() != null && other.getStatusMessage().equals(this.getStatusMessage()) == false)
return false;
if (other.getVideoMetadata() == null ^ this.getVideoMetadata() == null)
return false;
if (other.getVideoMetadata() != null && other.getVideoMetadata().equals(this.getVideoMetadata()) == false)
return false;
if (other.getTextDetections() == null ^ this.getTextDetections() == null)
return false;
if (other.getTextDetections() != null && other.getTextDetections().equals(this.getTextDetections()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getTextModelVersion() == null ^ this.getTextModelVersion() == null)
return false;
if (other.getTextModelVersion() != null && other.getTextModelVersion().equals(this.getTextModelVersion()) == false)
return false;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false)
return false;
if (other.getVideo() == null ^ this.getVideo() == null)
return false;
if (other.getVideo() != null && other.getVideo().equals(this.getVideo()) == false)
return false;
if (other.getJobTag() == null ^ this.getJobTag() == null)
return false;
if (other.getJobTag() != null && other.getJobTag().equals(this.getJobTag()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobStatus() == null) ? 0 : getJobStatus().hashCode());
hashCode = prime * hashCode + ((getStatusMessage() == null) ? 0 : getStatusMessage().hashCode());
hashCode = prime * hashCode + ((getVideoMetadata() == null) ? 0 : getVideoMetadata().hashCode());
hashCode = prime * hashCode + ((getTextDetections() == null) ? 0 : getTextDetections().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getTextModelVersion() == null) ? 0 : getTextModelVersion().hashCode());
hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode());
hashCode = prime * hashCode + ((getVideo() == null) ? 0 : getVideo().hashCode());
hashCode = prime * hashCode + ((getJobTag() == null) ? 0 : getJobTag().hashCode());
return hashCode;
}
@Override
public GetTextDetectionResult clone() {
try {
return (GetTextDetectionResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}