software.amazon.awssdk.services.rekognition.model

Class ListFacesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListFacesRequest.Builder,ListFacesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListFacesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListFacesRequest.Builder	builder()
String	collectionId() ID of the collection from which to list the faces.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	faceIds() An array of face IDs to filter results with when listing faces in a collection.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFaceIds() For responses, this returns true if the service returned a value for the FaceIds property.
int	hashCode()
Integer	maxResults() Maximum number of faces to return.
String	nextToken() If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends ListFacesRequest.Builder>	serializableBuilderClass()
ListFacesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userId() An array of user IDs to filter results with when listing faces in a collection.

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

collectionId

public final String collectionId()

ID of the collection from which to list the faces.

Returns:

ID of the collection from which to list the faces.

nextToken

public final String nextToken()

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

Returns:

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

maxResults

public final Integer maxResults()

Maximum number of faces to return.

Returns:

Maximum number of faces to return.

userId

public final String userId()

An array of user IDs to filter results with when listing faces in a collection.

Returns:

An array of user IDs to filter results with when listing faces in a collection.

hasFaceIds

public final boolean hasFaceIds()

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

faceIds

public final List<String> faceIds()

An array of face IDs to filter results with when listing faces in a collection.

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

Returns:

An array of face IDs to filter results with when listing faces in a collection.

toBuilder

public ListFacesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListFacesRequest.Builder,ListFacesRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static ListFacesRequest.Builder builder()

serializableBuilderClass

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