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(value="software.amazon.awssdk:codegen")
public final class GetLabelDetectionRequest
extends RekognitionRequest
implements ToCopyableBuilder<GetLabelDetectionRequest.Builder,GetLabelDetectionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetLabelDetectionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetLabelDetectionRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

jobId

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

toBuilder

public GetLabelDetectionRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetLabelDetectionRequest.Builder,GetLabelDetectionRequest>

Specified by:

toBuilder in class RekognitionRequest

Returns:

a builder for type T

builder

public static GetLabelDetectionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.