software.amazon.awssdk.services.rekognition.model

Class ListFacesResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListFacesResponse.Builder,ListFacesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListFacesResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ListFacesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	faceModelVersion() Latest face model being used with the collection.
List<Face>	faces() An array of Face objects.
<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	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.
List<SdkField<?>>	sdkFields()
static Class<? extends ListFacesResponse.Builder>	serializableBuilderClass()
ListFacesResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

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<Face> faces()

An array of Face objects.

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 Face objects.

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.

faceModelVersion

public final String faceModelVersion()

Latest face model being used with the collection. For more information, see Model versioning.

Returns:

Latest face model being used with the collection. For more information, see Model versioning.

toBuilder

public ListFacesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListFacesResponse.Builder,ListFacesResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static ListFacesResponse.Builder builder()

serializableBuilderClass

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