* Gets the label detection results of a Amazon Rekognition Video analysis * started by StartLabelDetection. *
*
* The label detection operation is started by a call to
* StartLabelDetection which returns a job identifier (JobId
* ). When the label detection operation finishes, Amazon Rekognition publishes
* a completion status to the Amazon Simple Notification Service topic
* registered in the initial call to StartlabelDetection.
*
* To get the results of the label detection operation, first check that the
* status value published to the Amazon SNS topic is SUCCEEDED. If
* so, call GetLabelDetection and pass the job identifier (
* JobId) from the initial call to StartLabelDetection
* .
*
* GetLabelDetection returns an array of detected labels (
* Labels) sorted by the time the labels were detected. You can
* also sort by the label name by specifying NAME for the
* SortBy input parameter. If there is no NAME
* specified, the default sort is by timestamp.
*
* You can select how results are aggregated by using the
* AggregateBy input parameter. The default aggregation method is
* TIMESTAMPS. You can also aggregate by SEGMENTS,
* which aggregates all instances of labels detected in a given segment.
*
* The returned Labels array may include the following attributes: *
** Name - The name of the detected label. *
** Confidence - The level of confidence in the label assigned to a detected * object. *
** Parents - The ancestor labels for a detected label. GetLabelDetection returns * a hierarchical taxonomy of detected labels. For example, a detected car might * be assigned the label car. The label car has two parent labels: Vehicle (its * parent) and Transportation (its grandparent). The response includes the all * ancestors for a label, where every ancestor is a unique label. In the * previous example, Car, Vehicle, and Transportation are returned as unique * labels in the response. *
** Aliases - Possible Aliases for the label. *
** Categories - The label categories that the detected label belongs to. *
** BoundingBox — Bounding boxes are described for all instances of detected * common object labels, returned in an array of Instance objects. An Instance * object contains a BoundingBox object, describing the location of the label on * the input image. It also includes the confidence for the accuracy of the * detected bounding box. *
*
* Timestamp - Time, in milliseconds from the start of the video, that the label
* was detected. For aggregation by SEGMENTS, the
* StartTimestampMillis, EndTimestampMillis, and
* DurationMillis structures are what define a segment. Although
* the “Timestamp” structure is still returned with each label, its value is set
* to be the same as StartTimestampMillis.
*
* Timestamp and Bounding box information are returned for detected Instances,
* only if aggregation is done by TIMESTAMPS. If aggregating by
* SEGMENTS, information about detected instances isn’t returned.
*
* The version of the label model used for the detection is also returned. *
*
* Note DominantColors isn't returned for Instances
* , although it is shown as part of the response in the sample seen below.
*
* Use MaxResults parameter to limit the number of labels 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 GetlabelDetection and populate the
* NextToken request parameter with the token value returned from
* the previous call to GetLabelDetection.
*
* Job identifier for the label detection operation for which you want
* results returned. You get the job identifer from an initial call to
* StartlabelDetection.
*
* 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 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 * labels. *
*
* Constraints:
* Length: - 255
*/
private String nextToken;
/**
*
* Sort to use for elements in the Labels array. Use
* TIMESTAMP to sort array elements by the time labels are
* detected. Use NAME to alphabetically group elements for a
* label together. Within each label group, the array element are sorted by
* detection confidence. The default sort is by TIMESTAMP.
*
* Constraints:
* Allowed Values: NAME, TIMESTAMP
*/
private String sortBy;
/**
*
* Defines how to aggregate the returned results. Results can be aggregated * by timestamps or segments. *
*
* Constraints:
* Allowed Values: TIMESTAMPS, SEGMENTS
*/
private String aggregateBy;
/**
*
* Job identifier for the label detection operation for which you want
* results returned. You get the job identifer from an initial call to
* StartlabelDetection.
*
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*
* @return
* Job identifier for the label detection operation for which you
* want results returned. You get the job identifer from an initial
* call to StartlabelDetection.
*
* Job identifier for the label detection operation for which you want
* results returned. You get the job identifer from an initial call to
* StartlabelDetection.
*
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*
* @param jobId
* Job identifier for the label detection operation for which you
* want results returned. You get the job identifer from an
* initial call to StartlabelDetection.
*
* Job identifier for the label detection operation for which you want
* results returned. You get the job identifer from an initial call to
* StartlabelDetection.
*
* 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 label detection operation for which you
* want results returned. You get the job identifer from an
* initial call to StartlabelDetection.
*
* 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 GetLabelDetectionRequest 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 * labels. *
*
* 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 labels. *
*/ 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 * labels. *
*
* 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 labels. *
*/ 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 * labels. *
** 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 labels. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetLabelDetectionRequest withNextToken(String nextToken) { this.nextToken = nextToken; return this; } /** *
* Sort to use for elements in the Labels array. Use
* TIMESTAMP to sort array elements by the time labels are
* detected. Use NAME to alphabetically group elements for a
* label together. Within each label group, the array element are sorted by
* detection confidence. The default sort is by TIMESTAMP.
*
* Constraints:
* Allowed Values: NAME, TIMESTAMP
*
* @return
* Sort to use for elements in the Labels array. Use
* TIMESTAMP to sort array elements by the time labels
* are detected. Use NAME to alphabetically group
* elements for a label together. Within each label group, the array
* element are sorted by detection confidence. The default sort is
* by TIMESTAMP.
*
* Sort to use for elements in the Labels array. Use
* TIMESTAMP to sort array elements by the time labels are
* detected. Use NAME to alphabetically group elements for a
* label together. Within each label group, the array element are sorted by
* detection confidence. The default sort is by TIMESTAMP.
*
* Constraints:
* Allowed Values: NAME, TIMESTAMP
*
* @param sortBy
* Sort to use for elements in the Labels array. Use
* TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically
* group elements for a label together. Within each label group,
* the array element are sorted by detection confidence. The
* default sort is by TIMESTAMP.
*
* Sort to use for elements in the Labels array. Use
* TIMESTAMP to sort array elements by the time labels are
* detected. Use NAME to alphabetically group elements for a
* label together. Within each label group, the array element 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: NAME, TIMESTAMP
*
* @param sortBy
* Sort to use for elements in the Labels array. Use
* TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically
* group elements for a label together. Within each label group,
* the array element are sorted by detection confidence. The
* default sort is by TIMESTAMP.
*
* Sort to use for elements in the Labels array. Use
* TIMESTAMP to sort array elements by the time labels are
* detected. Use NAME to alphabetically group elements for a
* label together. Within each label group, the array element are sorted by
* detection confidence. The default sort is by TIMESTAMP.
*
* Constraints:
* Allowed Values: NAME, TIMESTAMP
*
* @param sortBy
* Sort to use for elements in the Labels array. Use
* TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically
* group elements for a label together. Within each label group,
* the array element are sorted by detection confidence. The
* default sort is by TIMESTAMP.
*
* Sort to use for elements in the Labels array. Use
* TIMESTAMP to sort array elements by the time labels are
* detected. Use NAME to alphabetically group elements for a
* label together. Within each label group, the array element 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: NAME, TIMESTAMP
*
* @param sortBy
* Sort to use for elements in the Labels array. Use
* TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically
* group elements for a label together. Within each label group,
* the array element are sorted by detection confidence. The
* default sort is by TIMESTAMP.
*
* Defines how to aggregate the returned results. Results can be aggregated * by timestamps or segments. *
*
* Constraints:
* Allowed Values: TIMESTAMPS, SEGMENTS
*
* @return
* Defines how to aggregate the returned results. Results can be * aggregated by timestamps or segments. *
* @see LabelDetectionAggregateBy */ public String getAggregateBy() { return aggregateBy; } /** ** Defines how to aggregate the returned results. Results can be aggregated * by timestamps or segments. *
*
* Constraints:
* Allowed Values: TIMESTAMPS, SEGMENTS
*
* @param aggregateBy
* Defines how to aggregate the returned results. Results can be * aggregated by timestamps or segments. *
* @see LabelDetectionAggregateBy */ public void setAggregateBy(String aggregateBy) { this.aggregateBy = aggregateBy; } /** ** Defines how to aggregate the returned results. Results can be aggregated * by timestamps or segments. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: TIMESTAMPS, SEGMENTS
*
* @param aggregateBy
* Defines how to aggregate the returned results. Results can be * aggregated by timestamps or segments. *
* @return A reference to this updated object so that method calls can be * chained together. * @see LabelDetectionAggregateBy */ public GetLabelDetectionRequest withAggregateBy(String aggregateBy) { this.aggregateBy = aggregateBy; return this; } /** ** Defines how to aggregate the returned results. Results can be aggregated * by timestamps or segments. *
*
* Constraints:
* Allowed Values: TIMESTAMPS, SEGMENTS
*
* @param aggregateBy
* Defines how to aggregate the returned results. Results can be * aggregated by timestamps or segments. *
* @see LabelDetectionAggregateBy */ public void setAggregateBy(LabelDetectionAggregateBy aggregateBy) { this.aggregateBy = aggregateBy.toString(); } /** ** Defines how to aggregate the returned results. Results can be aggregated * by timestamps or segments. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: TIMESTAMPS, SEGMENTS
*
* @param aggregateBy
* Defines how to aggregate the returned results. Results can be * aggregated by timestamps or segments. *
* @return A reference to this updated object so that method calls can be * chained together. * @see LabelDetectionAggregateBy */ public GetLabelDetectionRequest withAggregateBy(LabelDetectionAggregateBy aggregateBy) { this.aggregateBy = aggregateBy.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() + ","); if (getAggregateBy() != null) sb.append("AggregateBy: " + getAggregateBy()); 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()); hashCode = prime * hashCode + ((getAggregateBy() == null) ? 0 : getAggregateBy().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetLabelDetectionRequest == false) return false; GetLabelDetectionRequest other = (GetLabelDetectionRequest) 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; if (other.getAggregateBy() == null ^ this.getAggregateBy() == null) return false; if (other.getAggregateBy() != null && other.getAggregateBy().equals(this.getAggregateBy()) == false) return false; return true; } }