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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPersons() For responses, this returns true if the service returned a value for the Persons property.
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, PersonMatch, 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()
String	toString() Returns a string representation of this object.
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

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

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

copy

Method Detail

jobStatus

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

hasPersons

public final boolean hasPersons()

For responses, this returns true if the service returned a value for the Persons property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

persons

public final List<PersonMatch> persons()

An array of persons, PersonMatch, 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPersons() method.

Returns:

An array of persons, PersonMatch, 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()

Specified by:

toBuilder in interface ToCopyableBuilder<GetFaceSearchResponse.Builder,GetFaceSearchResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetFaceSearchResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo