software.amazon.awssdk.services.rekognition.model

Class AssociateFacesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssociateFacesRequest.Builder,AssociateFacesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AssociateFacesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static AssociateFacesRequest.Builder	builder()
String	clientRequestToken() Idempotent token used to identify the request to AssociateFaces.
String	collectionId() The ID of an existing collection containing the UserID.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	faceIds() An array of FaceIDs to associate with the UserID.
<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()
List<SdkField<?>>	sdkFields()
static Class<? extends AssociateFacesRequest.Builder>	serializableBuilderClass()
AssociateFacesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userId() The ID for the existing UserID.
Float	userMatchThreshold() An optional value specifying the minimum confidence in the UserID match to return.

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

The ID of an existing collection containing the UserID.

Returns:

The ID of an existing collection containing the UserID.

userId

public final String userId()

The ID for the existing UserID.

Returns:

The ID for the existing UserID.

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 FaceIDs to associate with the UserID.

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 FaceIDs to associate with the UserID.

userMatchThreshold

public final Float userMatchThreshold()

An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.

Returns:

An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.

clientRequestToken

public final String clientRequestToken()

Idempotent token used to identify the request to AssociateFaces. If you use the same token with multiple AssociateFaces requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

Returns:

Idempotent token used to identify the request to AssociateFaces. If you use the same token with multiple AssociateFaces requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

toBuilder

public AssociateFacesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssociateFacesRequest.Builder,AssociateFacesRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static AssociateFacesRequest.Builder builder()

serializableBuilderClass

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