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

Class IndexFacesRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.rekognition.model.IndexFacesRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<IndexFacesRequest.Builder,IndexFacesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IndexFacesRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static IndexFacesRequest.Builder	builder()
String	collectionId()	The ID of an existing collection to which you want to add the faces that are detected in the input images.
List<String>	detectionAttributes()	An array of facial attributes that you want to be returned.
boolean	equals(Object obj)
String	externalImageId()	ID you want to assign to all the faces detected in the image.
int	hashCode()
Image	image()	The input image as bytes or an S3 object.
static Class<? extends IndexFacesRequest.Builder>	serializableBuilderClass()
IndexFacesRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

collectionId

public String collectionId()

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Returns:

The ID of an existing collection to which you want to add the faces that are detected in the input images.

image

public Image image()

The input image as bytes or an S3 object.

Returns:

The input image as bytes or an S3 object.

externalImageId

public String externalImageId()

ID you want to assign to all the faces detected in the image.

Returns:

ID you want to assign to all the faces detected in the image.

detectionAttributes

public List<String> detectionAttributes()

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality and Landmarks. If you provide ["ALL"], all facial attributes are returned but the operation will take longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Returns:

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality and Landmarks. If you provide ["ALL"], all facial attributes are returned but the operation will take longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

See Also:

Attribute

toBuilder

public IndexFacesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<IndexFacesRequest.Builder,IndexFacesRequest>

Returns:

a builder for type T

builder

public static IndexFacesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends IndexFacesRequest.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()

Overrides:

toString in class Object