com.amazonaws.services.rekognition.model

Class GetLabelDetectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.GetLabelDetectionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetLabelDetectionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetLabelDetectionRequest()

Method Summary

Modifier and Type	Method and Description
GetLabelDetectionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAggregateBy() Defines how to aggregate the returned results.
String	getJobId() Job identifier for the label detection operation for which you want results returned.
Integer	getMaxResults() Maximum number of results to return per paginated call.
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.
String	getSortBy() Sort to use for elements in the Labels array.
int	hashCode()
void	setAggregateBy(String aggregateBy) Defines how to aggregate the returned results.
void	setJobId(String jobId) Job identifier for the label detection operation for which you want results returned.
void	setMaxResults(Integer maxResults) Maximum number of results to return per paginated call.
void	setNextToken(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(String sortBy) Sort to use for elements in the Labels array.
String	toString() Returns a string representation of this object.
GetLabelDetectionRequest	withAggregateBy(LabelDetectionAggregateBy aggregateBy) Defines how to aggregate the returned results.
GetLabelDetectionRequest	withAggregateBy(String aggregateBy) Defines how to aggregate the returned results.
GetLabelDetectionRequest	withJobId(String jobId) Job identifier for the label detection operation for which you want results returned.
GetLabelDetectionRequest	withMaxResults(Integer maxResults) Maximum number of results to return per paginated call.
GetLabelDetectionRequest	withNextToken(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(String sortBy) Sort to use for elements in the Labels array.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetLabelDetectionRequest

public GetLabelDetectionRequest()

Method Detail

setJobId

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

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.

getJobId

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

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.

withJobId

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

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:

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

setMaxResults

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

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.

getMaxResults

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

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.

withMaxResults

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

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:

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

setNextToken

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

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.

getNextToken

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

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.

withNextToken

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

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:

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

setSortBy

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

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

getSortBy

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

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

withSortBy

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

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:

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

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.

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:

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

See Also:

LabelDetectionSortBy

setAggregateBy

public void setAggregateBy(String aggregateBy)

Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.

Parameters:

aggregateBy - Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.

See Also:

LabelDetectionAggregateBy

getAggregateBy

public String getAggregateBy()

Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.

Returns:

Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.

See Also:

LabelDetectionAggregateBy

withAggregateBy

public GetLabelDetectionRequest withAggregateBy(String aggregateBy)

Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.

Parameters:

aggregateBy - Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.

Returns:

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

See Also:

LabelDetectionAggregateBy

withAggregateBy

public GetLabelDetectionRequest withAggregateBy(LabelDetectionAggregateBy aggregateBy)

Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.

Parameters:

aggregateBy - Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.

Returns:

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

See Also:

LabelDetectionAggregateBy

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetLabelDetectionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()