software.amazon.awssdk.services.rekognition.model

Class GetFaceSearchResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.rekognition.model.RekognitionResponse

software.amazon.awssdk.services.rekognition.model.GetFaceSearchResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetFaceSearchResponse.Builder,GetFaceSearchResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetFaceSearchResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetFaceSearchResponse.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 SdkResponse.
int	hashCode()
VideoJobStatus	jobStatus() The current status of the face search job.
String	jobStatusAsString() The current status of the face search job.
String	nextToken() If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.
List<PersonMatch>	persons() An array of persons, , in the video whose face(s) match the face(s) in an Amazon Rekognition collection.
List<SdkField<?>>	sdkFields()
static Class<? extends GetFaceSearchResponse.Builder>	serializableBuilderClass()
String	statusMessage() If the job fails, StatusMessage provides a descriptive error message.
GetFaceSearchResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
VideoMetadata	videoMetadata() Information about a video that Amazon Rekognition analyzed.

Methods inherited from class software.amazon.awssdk.services.rekognition.model.RekognitionResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

jobStatus

public VideoJobStatus jobStatus()

The current status of the face search job.

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

Returns:

The current status of the face search job.

See Also:

VideoJobStatus

jobStatusAsString

public String jobStatusAsString()

The current status of the face search job.

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

Returns:

The current status of the face search job.

See Also:

VideoJobStatus

statusMessage

public String statusMessage()

If the job fails, StatusMessage provides a descriptive error message.

Returns:

If the job fails, StatusMessage provides a descriptive error message.

nextToken

public String nextToken()

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

Returns:

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

videoMetadata

public VideoMetadata videoMetadata()

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

Returns:

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

persons

public List<PersonMatch> persons()

An array of persons, , in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

An array of persons, , in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

toBuilder

public GetFaceSearchResponse.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<GetFaceSearchResponse.Builder,GetFaceSearchResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetFaceSearchResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetFaceSearchResponse.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: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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.