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

Class GetFaceDetectionResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetFaceDetectionResponse.Builder,GetFaceDetectionResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetFaceDetectionResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetFaceDetectionResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FaceDetection>	faces()	An array of faces detected in the video.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFaces()	For responses, this returns true if the service returned a value for the Faces property.
int	hashCode()
String	jobId()	Job identifier for the face detection operation for which you want to obtain results.
VideoJobStatus	jobStatus()	The current status of the face detection job.
String	jobStatusAsString()	The current status of the face detection job.
String	jobTag()	A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
String	nextToken()	If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetFaceDetectionResponse.Builder>	serializableBuilderClass()
String	statusMessage()	If the job fails, StatusMessage provides a descriptive error message.
GetFaceDetectionResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Video	video()	Returns the value of the Video property for this object.
VideoMetadata	videoMetadata()	Information about a video that Amazon Rekognition Video 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 detection 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 detection job.

See Also:

VideoJobStatus

jobStatusAsString

public final String jobStatusAsString()

The current status of the face detection 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 detection 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.

videoMetadata

public final VideoMetadata videoMetadata()

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

Returns:

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

nextToken

public final String nextToken()

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

Returns:

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

hasFaces

public final boolean hasFaces()

For responses, this returns true if the service returned a value for the Faces 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.

faces

public final List<FaceDetection> faces()

An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.

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 hasFaces() method.

Returns:

An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.

jobId

public final String jobId()

Job identifier for the face detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceDetection.

Returns:

Job identifier for the face detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceDetection.

video

public final Video video()

Returns the value of the Video property for this object.

Returns:

The value of the Video property for this object.

jobTag

public final String jobTag()

A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

Returns:

A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

toBuilder

public GetFaceDetectionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetFaceDetectionResponse.Builder,GetFaceDetectionResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetFaceDetectionResponse.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo