/* * 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; /** *

* Starts asynchronous detection of text in a stored video. *

* Amazon Rekognition Video can detect text in a video stored in an Amazon S3 * bucket. Use Video to specify the bucket name and the filename of the * video. StartTextDetection returns a job identifier ( * JobId) which you use to get the results of the operation. When * text detection is finished, Amazon Rekognition Video publishes a completion * status to the Amazon Simple Notification Service topic that you specify in * NotificationChannel. *

* 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 to StartTextDetection. *

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

* Video file stored in an Amazon S3 bucket. Amazon Rekognition video start * operations such as StartLabelDetection use Video to * specify a video for analysis. The supported file formats are .mp4, .mov * and .avi. *

*/ private Video video; /** *

* Idempotent token used to identify the start request. If you use the same * token with multiple StartTextDetection requests, the same * JobId is returned. Use ClientRequestToken to * prevent the same job from being accidentaly started more than once. *

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

* The Amazon Simple Notification Service topic to which Amazon Rekognition * publishes the completion status of a video analysis operation. For more * information, see Calling Amazon Rekognition Video operations. Note that the Amazon * SNS topic must have a topic name that begins with * AmazonRekognition if you are using the * AmazonRekognitionServiceRole permissions policy to access the topic. For * more information, see Giving access to multiple Amazon SNS topics. *

*/ private NotificationChannel notificationChannel; /** *

* An identifier returned in the completion status published by your Amazon * Simple Notification Service topic. For example, you can use * JobTag to group related jobs and identify them in the * completion notification. *

* Constraints:
* Length: 1 - 1024
* Pattern: [a-zA-Z0-9_.\-:+=\/]+
*/ private String jobTag; /** *

* Optional parameters that let you set criteria the text must meet to be * included in your response. *

*/ private StartTextDetectionFilters filters; /** *

* * @return

* Video file stored in an Amazon S3 bucket. Amazon Rekognition * video start operations such as StartLabelDetection use * Video to specify a video for analysis. The supported * file formats are .mp4, .mov and .avi. *

*/ public Video getVideo() { return video; } /** *

* * @param video

* Video file stored in an Amazon S3 bucket. Amazon Rekognition * video start operations such as StartLabelDetection use * Video to specify a video for analysis. The * supported file formats are .mp4, .mov and .avi. *

*/ public void setVideo(Video video) { this.video = video; } /** *

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartTextDetectionRequest withVideo(Video video) { this.video = video; return this; } /** *

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

* Idempotent token used to identify the start request. If you use * the same token with multiple StartTextDetection * requests, the same JobId is returned. Use * ClientRequestToken to prevent the same job from * being accidentaly started more than once. *

*/ public String getClientRequestToken() { return clientRequestToken; } /** *

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

* Idempotent token used to identify the start request. If you * use the same token with multiple * StartTextDetection requests, the same * JobId is returned. Use * ClientRequestToken to prevent the same job from * being accidentaly started more than once. *

*/ public void setClientRequestToken(String clientRequestToken) { this.clientRequestToken = clientRequestToken; } /** *

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

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

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

* * @return

* The Amazon Simple Notification Service topic to which Amazon * Rekognition publishes the completion status of a video analysis * operation. For more information, see Calling Amazon Rekognition Video operations. Note that the * Amazon SNS topic must have a topic name that begins with * AmazonRekognition if you are using the * AmazonRekognitionServiceRole permissions policy to access the * topic. For more information, see Giving access to multiple Amazon SNS topics. *

*/ public NotificationChannel getNotificationChannel() { return notificationChannel; } /** *

* * @param notificationChannel

* The Amazon Simple Notification Service topic to which Amazon * Rekognition publishes the completion status of a video * analysis operation. For more information, see Calling Amazon Rekognition Video operations. Note that * the Amazon SNS topic must have a topic name that begins with * AmazonRekognition if you are using the * AmazonRekognitionServiceRole permissions policy to access the * topic. For more information, see Giving access to multiple Amazon SNS topics. *

*/ public void setNotificationChannel(NotificationChannel notificationChannel) { this.notificationChannel = notificationChannel; } /** *

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartTextDetectionRequest withNotificationChannel(NotificationChannel notificationChannel) { this.notificationChannel = notificationChannel; return this; } /** *

* Constraints:
* Length: 1 - 1024
* Pattern: [a-zA-Z0-9_.\-:+=\/]+
* * @return

* An identifier returned in the completion status published by your * Amazon Simple Notification Service topic. For example, you can * use JobTag to group related jobs and identify them * in the completion notification. *

*/ public String getJobTag() { return jobTag; } /** *

* Constraints:
* Length: 1 - 1024
* Pattern: [a-zA-Z0-9_.\-:+=\/]+
* * @param jobTag

* An identifier returned in the completion status published by * your Amazon Simple Notification Service topic. For example, * you can use JobTag to group related jobs and * identify them in the completion notification. *

*/ public void setJobTag(String jobTag) { this.jobTag = jobTag; } /** *

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

* Constraints:
* Length: 1 - 1024
* Pattern: [a-zA-Z0-9_.\-:+=\/]+
* * @param jobTag

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

* Optional parameters that let you set criteria the text must meet to be * included in your response. *

* * @return

* Optional parameters that let you set criteria the text must meet * to be included in your response. *

*/ public StartTextDetectionFilters getFilters() { return filters; } /** *

* Optional parameters that let you set criteria the text must meet to be * included in your response. *

* * @param filters

* Optional parameters that let you set criteria the text must * meet to be included in your response. *

*/ public void setFilters(StartTextDetectionFilters filters) { this.filters = filters; } /** *

* Optional parameters that let you set criteria the text must meet to be * included in your response. *

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

* Optional parameters that let you set criteria the text must * meet to be included in your response. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartTextDetectionRequest withFilters(StartTextDetectionFilters filters) { this.filters = filters; 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 (getVideo() != null) sb.append("Video: " + getVideo() + ","); if (getClientRequestToken() != null) sb.append("ClientRequestToken: " + getClientRequestToken() + ","); if (getNotificationChannel() != null) sb.append("NotificationChannel: " + getNotificationChannel() + ","); if (getJobTag() != null) sb.append("JobTag: " + getJobTag() + ","); if (getFilters() != null) sb.append("Filters: " + getFilters()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getVideo() == null) ? 0 : getVideo().hashCode()); hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode()); hashCode = prime * hashCode + ((getNotificationChannel() == null) ? 0 : getNotificationChannel().hashCode()); hashCode = prime * hashCode + ((getJobTag() == null) ? 0 : getJobTag().hashCode()); hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartTextDetectionRequest == false) return false; StartTextDetectionRequest other = (StartTextDetectionRequest) obj; if (other.getVideo() == null ^ this.getVideo() == null) return false; if (other.getVideo() != null && other.getVideo().equals(this.getVideo()) == false) return false; if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null) return false; if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false) return false; if (other.getNotificationChannel() == null ^ this.getNotificationChannel() == null) return false; if (other.getNotificationChannel() != null && other.getNotificationChannel().equals(this.getNotificationChannel()) == false) return false; if (other.getJobTag() == null ^ this.getJobTag() == null) return false; if (other.getJobTag() != null && other.getJobTag().equals(this.getJobTag()) == false) return false; if (other.getFilters() == null ^ this.getFilters() == null) return false; if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false; return true; } }