Package software.amazon.awssdk.services.rekognition.model

Class GetLabelDetectionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rekognition.model.RekognitionRequest

software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetLabelDetectionRequest.Builder,GetLabelDetectionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetLabelDetectionRequest
extends RekognitionRequest
implements ToCopyableBuilder<GetLabelDetectionRequest.Builder,GetLabelDetectionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetLabelDetectionRequest.Builder

Method Summary

Modifier and Type	Method	Description
LabelDetectionAggregateBy	aggregateBy()	Defines how to aggregate the returned results.
String	aggregateByAsString()	Defines how to aggregate the returned results.
static GetLabelDetectionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobId()	Job identifier for the label detection operation for which you want results returned.
Integer	maxResults()	Maximum number of results to return per paginated call.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends GetLabelDetectionRequest.Builder>	serializableBuilderClass()
LabelDetectionSortBy	sortBy()	Sort to use for elements in the Labels array.
String	sortByAsString()	Sort to use for elements in the Labels array.
GetLabelDetectionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

jobId

public final 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:

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

maxResults

public final 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:

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.

nextToken

public final 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:

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.

sortBy

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

If the service returns an enum value that is not available in the current SDK version, sortBy will return LabelDetectionSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

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

sortByAsString

public final String sortByAsString()

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.

If the service returns an enum value that is not available in the current SDK version, sortBy will return LabelDetectionSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

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

aggregateBy

public final LabelDetectionAggregateBy aggregateBy()

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

If the service returns an enum value that is not available in the current SDK version, aggregateBy will return LabelDetectionAggregateBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregateByAsString().

Returns:

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

See Also:

LabelDetectionAggregateBy

aggregateByAsString

public final String aggregateByAsString()

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

If the service returns an enum value that is not available in the current SDK version, aggregateBy will return LabelDetectionAggregateBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregateByAsString().

Returns:

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

See Also:

LabelDetectionAggregateBy

toBuilder

public GetLabelDetectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetLabelDetectionRequest.Builder,GetLabelDetectionRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static GetLabelDetectionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetLabelDetectionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo