software.amazon.awssdk.services.rekognition.model

Interface IndexFacesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<IndexFacesRequest.Builder,IndexFacesRequest>, RekognitionRequest.Builder, SdkBuilder<IndexFacesRequest.Builder,IndexFacesRequest>, SdkRequest.Builder

Enclosing class:

IndexFacesRequest

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

Method Summary

Modifier and Type	Method and 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(Attribute... detectionAttributes) An array of facial attributes that you want to be returned.
IndexFacesRequest.Builder	detectionAttributes(Collection<Attribute> detectionAttributes) An array of facial attributes that you want to be returned.
IndexFacesRequest.Builder	detectionAttributesWithStrings(Collection<String> detectionAttributes) An array of facial attributes that you want to be returned.
IndexFacesRequest.Builder	detectionAttributesWithStrings(String... 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.
default IndexFacesRequest.Builder	image(Consumer<Image.Builder> image) The input image as bytes or an S3 object.
IndexFacesRequest.Builder	image(Image image) The input image as bytes or an S3 object.
IndexFacesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
IndexFacesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.rekognition.model.RekognitionRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

applyMutation, 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.

image

default IndexFacesRequest.Builder image(Consumer<Image.Builder> image)

The input image as bytes or an S3 object.

This is a convenience that creates an instance of the Image.Builder avoiding the need to create one manually via Image.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to image(Image).

Parameters:

image - a consumer that will call methods on Image.Builder

Returns:

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

See Also:

image(Image)

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.

detectionAttributesWithStrings

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

detectionAttributesWithStrings

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

detectionAttributes

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

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.

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

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.

overrideConfiguration

IndexFacesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

IndexFacesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.