/* * 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 path tracking results of a Amazon Rekognition Video analysis started * by StartPersonTracking. *

*

* The person path tracking operation is started by a call to * StartPersonTracking which returns a job identifier ( * JobId). When the operation finishes, Amazon Rekognition Video * publishes a completion status to the Amazon Simple Notification Service topic * registered in the initial call to StartPersonTracking. *

*

* To get the results of the person path tracking operation, first check that * the status value published to the Amazon SNS topic is SUCCEEDED. * If so, call GetPersonTracking and pass the job identifier ( * JobId) from the initial call to StartPersonTracking * . *

*

* GetPersonTracking returns an array, Persons, of * tracked persons and the time(s) their paths were tracked in the video. *

* *

* GetPersonTracking only returns the default facial attributes ( * BoundingBox, Confidence, Landmarks, * Pose, and Quality). The other facial attributes * listed in the Face object of the following response syntax are * not returned. *

*

* For more information, see FaceDetail in the Amazon Rekognition Developer * Guide. *

* *

* By default, the array is sorted by the time(s) a person's path is tracked in * the video. You can sort by tracked persons by specifying INDEX * for the SortBy input parameter. *

*

* Use the MaxResults parameter to limit the number of items * 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 GetPersonTracking and populate the * NextToken request parameter with the token value returned from * the previous call to GetPersonTracking. *

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

* The identifier for a job that tracks persons in a video. You get the * JobId from a call to StartPersonTracking. *

*

* 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. If you specify a value greater than 1000, a * maximum of 1000 results is returned. The default value is 1000. *

*

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

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

*

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

* Sort to use for elements in the Persons array. Use * TIMESTAMP to sort array elements by the time persons are * detected. Use INDEX to sort by the tracked persons. If you * sort by INDEX, the array elements for each person are sorted * by detection confidence. The default sort is by TIMESTAMP. *

*

* Constraints:
* Allowed Values: INDEX, TIMESTAMP */ private String sortBy; /** *

* The identifier for a job that tracks persons in a video. You get the * JobId from a call to StartPersonTracking. *

*

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

* The identifier for a job that tracks persons in a video. You get * the JobId from a call to * StartPersonTracking. *

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

* The identifier for a job that tracks persons in a video. You get the * JobId from a call to StartPersonTracking. *

*

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

* The identifier for a job that tracks persons in a video. You * get the JobId from a call to * StartPersonTracking. *

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

* The identifier for a job that tracks persons in a video. You get the * JobId from a call to StartPersonTracking. *

*

* 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

* The identifier for a job that tracks persons in a video. You * get the JobId from a call to * StartPersonTracking. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetPersonTrackingRequest 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. If you specify a value greater than 1000, a * maximum of 1000 results is returned. The default value is 1000. *

*

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

* Maximum number of results to return per paginated call. The * largest value you can specify is 1000. If you specify a value * greater than 1000, a maximum of 1000 results is returned. The * default value is 1000. *

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

* Maximum number of results to return per paginated call. The largest value * you can specify is 1000. If you specify a value greater than 1000, a * maximum of 1000 results is returned. The default value is 1000. *

*

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

* Maximum number of results to return per paginated call. The * largest value you can specify is 1000. If you specify a value * greater than 1000, a maximum of 1000 results is returned. The * default value 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. If you specify a value greater than 1000, a * maximum of 1000 results is returned. The default value 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. If you specify a value * greater than 1000, a maximum of 1000 results is returned. The * default value is 1000. *

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

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

*

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

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

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

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

*

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

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

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

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

*

* 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 persons to retrieve), Amazon Rekognition Video returns a * pagination token in the response. You can use this pagination * token to retrieve the next set of persons. *

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

* Sort to use for elements in the Persons array. Use * TIMESTAMP to sort array elements by the time persons are * detected. Use INDEX to sort by the tracked persons. If you * sort by INDEX, the array elements for each person are sorted * by detection confidence. The default sort is by TIMESTAMP. *

*

* Constraints:
* Allowed Values: INDEX, TIMESTAMP * * @return

* Sort to use for elements in the Persons array. Use * TIMESTAMP to sort array elements by the time persons * are detected. Use INDEX to sort by the tracked * persons. If you sort by INDEX, the array elements * for each person are sorted by detection confidence. The default * sort is by TIMESTAMP. *

* @see PersonTrackingSortBy */ public String getSortBy() { return sortBy; } /** *

* Sort to use for elements in the Persons array. Use * TIMESTAMP to sort array elements by the time persons are * detected. Use INDEX to sort by the tracked persons. If you * sort by INDEX, the array elements for each person are sorted * by detection confidence. The default sort is by TIMESTAMP. *

*

* Constraints:
* Allowed Values: INDEX, TIMESTAMP * * @param sortBy

* Sort to use for elements in the Persons array. * Use TIMESTAMP to sort array elements by the time * persons are detected. Use INDEX to sort by the * tracked persons. If you sort by INDEX, the array * elements for each person are sorted by detection confidence. * The default sort is by TIMESTAMP. *

* @see PersonTrackingSortBy */ public void setSortBy(String sortBy) { this.sortBy = sortBy; } /** *

* Sort to use for elements in the Persons array. Use * TIMESTAMP to sort array elements by the time persons are * detected. Use INDEX to sort by the tracked persons. If you * sort by INDEX, the array elements for each person are sorted * by detection confidence. The default sort is by TIMESTAMP. *

*

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

* Constraints:
* Allowed Values: INDEX, TIMESTAMP * * @param sortBy

* Sort to use for elements in the Persons array. * Use TIMESTAMP to sort array elements by the time * persons are detected. Use INDEX to sort by the * tracked persons. If you sort by INDEX, the array * elements for each person are sorted by detection confidence. * The default sort is by TIMESTAMP. *

* @return A reference to this updated object so that method calls can be * chained together. * @see PersonTrackingSortBy */ public GetPersonTrackingRequest withSortBy(String sortBy) { this.sortBy = sortBy; return this; } /** *

* Sort to use for elements in the Persons array. Use * TIMESTAMP to sort array elements by the time persons are * detected. Use INDEX to sort by the tracked persons. If you * sort by INDEX, the array elements for each person are sorted * by detection confidence. The default sort is by TIMESTAMP. *

*

* Constraints:
* Allowed Values: INDEX, TIMESTAMP * * @param sortBy

* Sort to use for elements in the Persons array. * Use TIMESTAMP to sort array elements by the time * persons are detected. Use INDEX to sort by the * tracked persons. If you sort by INDEX, the array * elements for each person are sorted by detection confidence. * The default sort is by TIMESTAMP. *

* @see PersonTrackingSortBy */ public void setSortBy(PersonTrackingSortBy sortBy) { this.sortBy = sortBy.toString(); } /** *

* Sort to use for elements in the Persons array. Use * TIMESTAMP to sort array elements by the time persons are * detected. Use INDEX to sort by the tracked persons. If you * sort by INDEX, the array elements for each person are sorted * by detection confidence. The default sort is by TIMESTAMP. *

*

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

* Constraints:
* Allowed Values: INDEX, TIMESTAMP * * @param sortBy

* Sort to use for elements in the Persons array. * Use TIMESTAMP to sort array elements by the time * persons are detected. Use INDEX to sort by the * tracked persons. If you sort by INDEX, the array * elements for each person are sorted by detection confidence. * The default sort is by TIMESTAMP. *

* @return A reference to this updated object so that method calls can be * chained together. * @see PersonTrackingSortBy */ public GetPersonTrackingRequest withSortBy(PersonTrackingSortBy sortBy) { this.sortBy = sortBy.toString(); 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() + ","); if (getSortBy() != null) sb.append("SortBy: " + getSortBy()); 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()); hashCode = prime * hashCode + ((getSortBy() == null) ? 0 : getSortBy().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetPersonTrackingRequest == false) return false; GetPersonTrackingRequest other = (GetPersonTrackingRequest) 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; if (other.getSortBy() == null ^ this.getSortBy() == null) return false; if (other.getSortBy() != null && other.getSortBy().equals(this.getSortBy()) == false) return false; return true; } }