com.amazonaws.services.rekognition.model

Class GetLabelDetectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.GetLabelDetectionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetLabelDetectionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

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.

The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.

The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection.

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetLabelDetectionRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getJobId() Job identifier for the label detection operation for which you want results returned.
java.lang.Integer	getMaxResults() Maximum number of results to return per paginated call.
java.lang.String	getNextToken() If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response.
java.lang.String	getSortBy() Sort to use for elements in the Labels array.
int	hashCode()
void	setJobId(java.lang.String jobId) Job identifier for the label detection operation for which you want results returned.
void	setMaxResults(java.lang.Integer maxResults) Maximum number of results to return per paginated call.
void	setNextToken(java.lang.String nextToken) If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response.
void	setSortBy(LabelDetectionSortBy sortBy) Sort to use for elements in the Labels array.
void	setSortBy(java.lang.String sortBy) Sort to use for elements in the Labels array.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetLabelDetectionRequest	withJobId(java.lang.String jobId) Job identifier for the label detection operation for which you want results returned.
GetLabelDetectionRequest	withMaxResults(java.lang.Integer maxResults) Maximum number of results to return per paginated call.
GetLabelDetectionRequest	withNextToken(java.lang.String nextToken) If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response.
GetLabelDetectionRequest	withSortBy(LabelDetectionSortBy sortBy) Sort to use for elements in the Labels array.
GetLabelDetectionRequest	withSortBy(java.lang.String sortBy) Sort to use for elements in the Labels array.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetLabelDetectionRequest

public GetLabelDetectionRequest()

Method Detail

getJobId

public java.lang.String getJobId()

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-_]+$

Returns:

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

setJobId

public void setJobId(java.lang.String 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.

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

Parameters:

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.

withJobId

public GetLabelDetectionRequest withJobId(java.lang.String 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.

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

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

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public java.lang.Integer getMaxResults()

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 -

Returns:

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.

setMaxResults

public void setMaxResults(java.lang.Integer 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 -

Parameters:

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.

withMaxResults

public GetLabelDetectionRequest withMaxResults(java.lang.Integer 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 -

Parameters:

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 updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()

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

Returns:

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.

setNextToken

public void setNextToken(java.lang.String 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

Parameters:

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.

withNextToken

public GetLabelDetectionRequest withNextToken(java.lang.String 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

Parameters:

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 updated object so that method calls can be chained together.

getSortBy

public java.lang.String getSortBy()

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

Returns:

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.

See Also:

LabelDetectionSortBy

setSortBy

public void setSortBy(java.lang.String 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.

Constraints:
Allowed Values: NAME, TIMESTAMP

Parameters:

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.

See Also:

LabelDetectionSortBy

withSortBy

public GetLabelDetectionRequest withSortBy(java.lang.String 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.

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

Constraints:
Allowed Values: NAME, TIMESTAMP

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LabelDetectionSortBy

setSortBy

public void setSortBy(LabelDetectionSortBy 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.

Constraints:
Allowed Values: NAME, TIMESTAMP

Parameters:

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.

See Also:

LabelDetectionSortBy

withSortBy

public GetLabelDetectionRequest withSortBy(LabelDetectionSortBy 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.

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

Constraints:
Allowed Values: NAME, TIMESTAMP

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LabelDetectionSortBy

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object