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

Interface IndexFacesRequest.Builder

All Superinterfaces:

CopyableBuilder<IndexFacesRequest.Builder,IndexFacesRequest>, SdkBuilder<IndexFacesRequest.Builder,IndexFacesRequest>

Enclosing class:

IndexFacesRequest

public static interface IndexFacesRequest.Builder
extends CopyableBuilder<IndexFacesRequest.Builder,IndexFacesRequest>

Method Summary

Modifier and Type	Method	Description
IndexFacesRequest.Builder	collectionId(String collectionId)	The ID of an existing collection to which you want to add the faces that are detected in the input images.
IndexFacesRequest.Builder	detectionAttributes(String... detectionAttributes)	An array of facial attributes that you want to be returned.
IndexFacesRequest.Builder	detectionAttributes(Collection<String> detectionAttributes)	An array of facial attributes that you want to be returned.
IndexFacesRequest.Builder	detectionAttributes(Attribute... detectionAttributes)	An array of facial attributes that you want to be returned.
IndexFacesRequest.Builder	externalImageId(String externalImageId)	ID you want to assign to all the faces detected in the image.
IndexFacesRequest.Builder	image(Image image)	The input image as bytes or an S3 object.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

collectionId

IndexFacesRequest.Builder collectionId(String collectionId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

image

IndexFacesRequest.Builder image(Image image)

The input image as bytes or an S3 object.

Parameters:

image - The input image as bytes or an S3 object.

Returns:

Returns a reference to this object so that method calls can be chained together.

externalImageId

IndexFacesRequest.Builder externalImageId(String externalImageId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

detectionAttributes

IndexFacesRequest.Builder detectionAttributes(Collection<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).

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

Attribute

detectionAttributes

IndexFacesRequest.Builder detectionAttributes(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).

NOTE: This method appends the values to the existing list (if any). Use #setDetectionAttributes(java.util.Collection) or #withDetectionAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

Attribute

detectionAttributes

IndexFacesRequest.Builder detectionAttributes(Attribute... 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).

NOTE: This method appends the values to the existing list (if any). Use #setDetectionAttributes(java.util.Collection) or #withDetectionAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

Attribute