software.amazon.awssdk.services.rekognition.model

Class GetCelebrityRecognitionRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetCelebrityRecognitionRequest.Builder,GetCelebrityRecognitionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetCelebrityRecognitionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetCelebrityRecognitionRequest.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 required celebrity recognition analysis.
Integer	maxResults() Maximum number of results to return per paginated call.
String	nextToken() If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends GetCelebrityRecognitionRequest.Builder>	serializableBuilderClass()
CelebrityRecognitionSortBy	sortBy() Sort to use for celebrities returned in Celebrities field.
String	sortByAsString() Sort to use for celebrities returned in Celebrities field.
GetCelebrityRecognitionRequest.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 required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition.

Returns:

Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition.

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 is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities.

Returns:

If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities.

sortBy

public final CelebrityRecognitionSortBy sortBy()

Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.

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

Returns:

Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.

See Also:

CelebrityRecognitionSortBy

sortByAsString

public final String sortByAsString()

Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.

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

Returns:

Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.

See Also:

CelebrityRecognitionSortBy

toBuilder

public GetCelebrityRecognitionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetCelebrityRecognitionRequest.Builder,GetCelebrityRecognitionRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static GetCelebrityRecognitionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetCelebrityRecognitionRequest.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