software.amazon.awssdk.services.rekognition.model

Class SearchFacesByImageRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchFacesByImageRequest.Builder,SearchFacesByImageRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchFacesByImageRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SearchFacesByImageRequest.Builder	builder()
String	collectionId() ID of the collection to search.
boolean	equals(Object obj)
Float	faceMatchThreshold() (Optional) Specifies the minimum confidence in the face match to return.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Image	image() The input image as base64-encoded bytes or an S3 object.
Integer	maxFaces() Maximum number of faces to return.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchFacesByImageRequest.Builder>	serializableBuilderClass()
SearchFacesByImageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

ID of the collection to search.

Returns:

ID of the collection to search.

image

public Image image()

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Returns:

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

maxFaces

public Integer maxFaces()

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Returns:

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

faceMatchThreshold

public Float faceMatchThreshold()

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

Returns:

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

toBuilder

public SearchFacesByImageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchFacesByImageRequest.Builder,SearchFacesByImageRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static SearchFacesByImageRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo