/* * 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; public class GetFaceDetectionResult implements Serializable { /** *

* The current status of the face detection job. *

*

* Constraints:
* Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED */ private String jobStatus; /** *

* If the job fails, StatusMessage provides a descriptive error * message. *

*/ private String statusMessage; /** *

* Information about a video that Amazon Rekognition Video analyzed. * Videometadata is returned in every page of paginated * responses from a Amazon Rekognition video operation. *

*/ private VideoMetadata videoMetadata; /** *

* If the response is truncated, Amazon Rekognition returns this token that * you can use in the subsequent request to retrieve the next set of faces. *

*

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

* An array of faces detected in the video. Each element contains a detected * face's details and the time, in milliseconds from the start of the video, * the face was detected. *

*/ private java.util.List faces; /** *

* Job identifier for the face detection operation for which you want to * obtain results. The job identifer is returned by an initial call to * StartFaceDetection. *

*

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

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

* A job identifier specified in the call to StartFaceDetection and returned * in the job completion notification sent to your Amazon Simple * Notification Service topic. *

*

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

* The current status of the face detection job. *

*

* Constraints:
* Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED * * @return

* The current status of the face detection job. *

* @see VideoJobStatus */ public String getJobStatus() { return jobStatus; } /** *

* The current status of the face detection job. *

*

* Constraints:
* Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED * * @param jobStatus

* The current status of the face detection job. *

* @see VideoJobStatus */ public void setJobStatus(String jobStatus) { this.jobStatus = jobStatus; } /** *

* The current status of the face detection job. *

*

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

* Constraints:
* Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED * * @param jobStatus

* The current status of the face detection job. *

* @return A reference to this updated object so that method calls can be * chained together. * @see VideoJobStatus */ public GetFaceDetectionResult withJobStatus(String jobStatus) { this.jobStatus = jobStatus; return this; } /** *

* The current status of the face detection job. *

*

* Constraints:
* Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED * * @param jobStatus

* The current status of the face detection job. *

* @see VideoJobStatus */ public void setJobStatus(VideoJobStatus jobStatus) { this.jobStatus = jobStatus.toString(); } /** *

* The current status of the face detection job. *

*

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

* Constraints:
* Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED * * @param jobStatus

* The current status of the face detection job. *

* @return A reference to this updated object so that method calls can be * chained together. * @see VideoJobStatus */ public GetFaceDetectionResult withJobStatus(VideoJobStatus jobStatus) { this.jobStatus = jobStatus.toString(); return this; } /** *

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

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

*

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

* If the job fails, StatusMessage provides a * descriptive error message. *

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

* Information about a video that Amazon Rekognition Video analyzed. * Videometadata is returned in every page of paginated * responses from a Amazon Rekognition video operation. *

* * @return

* Information about a video that Amazon Rekognition Video analyzed. * Videometadata is returned in every page of paginated * responses from a Amazon Rekognition video operation. *

*/ public VideoMetadata getVideoMetadata() { return videoMetadata; } /** *

* Information about a video that Amazon Rekognition Video analyzed. * Videometadata is returned in every page of paginated * responses from a Amazon Rekognition video operation. *

* * @param videoMetadata

* Information about a video that Amazon Rekognition Video * analyzed. Videometadata is returned in every page * of paginated responses from a Amazon Rekognition video * operation. *

*/ public void setVideoMetadata(VideoMetadata videoMetadata) { this.videoMetadata = videoMetadata; } /** *

* Information about a video that Amazon Rekognition Video analyzed. * Videometadata is returned in every page of paginated * responses from a Amazon Rekognition video operation. *

*

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

* Information about a video that Amazon Rekognition Video * analyzed. Videometadata is returned in every page * of paginated responses from a Amazon Rekognition video * operation. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetFaceDetectionResult withVideoMetadata(VideoMetadata videoMetadata) { this.videoMetadata = videoMetadata; return this; } /** *

* If the response is truncated, Amazon Rekognition returns this token that * you can use in the subsequent request to retrieve the next set of faces. *

*

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

* If the response is truncated, Amazon Rekognition returns this * token that you can use in the subsequent request to retrieve the * next set of faces. *

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

* If the response is truncated, Amazon Rekognition returns this token that * you can use in the subsequent request to retrieve the next set of faces. *

*

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

* If the response is truncated, Amazon Rekognition returns this * token that you can use in the subsequent request to retrieve * the next set of faces. *

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

* If the response is truncated, Amazon Rekognition returns this token that * you can use in the subsequent request to retrieve the next set of faces. *

*

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

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

* If the response is truncated, Amazon Rekognition returns this * token that you can use in the subsequent request to retrieve * the next set of faces. *

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

* An array of faces detected in the video. Each element contains a detected * face's details and the time, in milliseconds from the start of the video, * the face was detected. *

* * @return

* An array of faces detected in the video. Each element contains a * detected face's details and the time, in milliseconds from the * start of the video, the face was detected. *

*/ public java.util.List getFaces() { return faces; } /** *

* An array of faces detected in the video. Each element contains a detected * face's details and the time, in milliseconds from the start of the video, * the face was detected. *

* * @param faces

* An array of faces detected in the video. Each element contains * a detected face's details and the time, in milliseconds from * the start of the video, the face was detected. *

*/ public void setFaces(java.util.Collection faces) { if (faces == null) { this.faces = null; return; } this.faces = new java.util.ArrayList(faces); } /** *

* An array of faces detected in the video. Each element contains a detected * face's details and the time, in milliseconds from the start of the video, * the face was detected. *

*

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

* An array of faces detected in the video. Each element contains * a detected face's details and the time, in milliseconds from * the start of the video, the face was detected. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetFaceDetectionResult withFaces(FaceDetection... faces) { if (getFaces() == null) { this.faces = new java.util.ArrayList(faces.length); } for (FaceDetection value : faces) { this.faces.add(value); } return this; } /** *

* An array of faces detected in the video. Each element contains a detected * face's details and the time, in milliseconds from the start of the video, * the face was detected. *

*

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

* An array of faces detected in the video. Each element contains * a detected face's details and the time, in milliseconds from * the start of the video, the face was detected. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetFaceDetectionResult withFaces(java.util.Collection faces) { setFaces(faces); return this; } /** *

* Job identifier for the face detection operation for which you want to * obtain results. The job identifer is returned by an initial call to * StartFaceDetection. *

*

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

* Job identifier for the face detection operation for which you * want to obtain results. The job identifer is returned by an * initial call to StartFaceDetection. *

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

* Job identifier for the face detection operation for which you want to * obtain results. The job identifer is returned by an initial call to * StartFaceDetection. *

*

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

* Job identifier for the face detection operation for which you * want to obtain results. The job identifer is returned by an * initial call to StartFaceDetection. *

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

* Job identifier for the face detection operation for which you want to * obtain results. The job identifer is returned by an initial call to * StartFaceDetection. *

*

* 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 face detection operation for which you * want to obtain results. The job identifer is returned by an * initial call to StartFaceDetection. *

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

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

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

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

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

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

*

* Returns a reference to this object so that method calls can be chained * together. * * @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. *

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

* A job identifier specified in the call to StartFaceDetection and returned * in the job completion notification sent to your Amazon Simple * Notification Service topic. *

*

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

* A job identifier specified in the call to StartFaceDetection and * returned in the job completion notification sent to your Amazon * Simple Notification Service topic. *

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

* A job identifier specified in the call to StartFaceDetection and returned * in the job completion notification sent to your Amazon Simple * Notification Service topic. *

*

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

* A job identifier specified in the call to StartFaceDetection * 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 StartFaceDetection and returned * in the job completion notification sent to your Amazon Simple * Notification Service topic. *

*

* 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

* A job identifier specified in the call to StartFaceDetection * and returned in the job completion notification sent to your * Amazon Simple Notification Service topic. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetFaceDetectionResult withJobTag(String jobTag) { this.jobTag = jobTag; 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 (getJobStatus() != null) sb.append("JobStatus: " + getJobStatus() + ","); if (getStatusMessage() != null) sb.append("StatusMessage: " + getStatusMessage() + ","); if (getVideoMetadata() != null) sb.append("VideoMetadata: " + getVideoMetadata() + ","); if (getNextToken() != null) sb.append("NextToken: " + getNextToken() + ","); if (getFaces() != null) sb.append("Faces: " + getFaces() + ","); if (getJobId() != null) sb.append("JobId: " + getJobId() + ","); if (getVideo() != null) sb.append("Video: " + getVideo() + ","); if (getJobTag() != null) sb.append("JobTag: " + getJobTag()); sb.append("}"); return sb.toString(); } @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 + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getFaces() == null) ? 0 : getFaces().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 boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetFaceDetectionResult == false) return false; GetFaceDetectionResult other = (GetFaceDetectionResult) 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.getNextToken() == null ^ this.getNextToken() == null) return false; if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false; if (other.getFaces() == null ^ this.getFaces() == null) return false; if (other.getFaces() != null && other.getFaces().equals(this.getFaces()) == 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; } }