@Generated(value="software.amazon.awssdk:codegen") public final class IndexFacesRequest extends RekognitionRequest implements ToCopyableBuilder<IndexFacesRequest.Builder,IndexFacesRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
IndexFacesRequest.Builder |
Modifier and Type | Method and 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<Attribute> |
detectionAttributes()
An array of facial attributes that you want to be returned.
|
List<String> |
detectionAttributesAsStrings()
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.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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() |
overrideConfiguration
copy
public String collectionId()
The ID of an existing collection to which you want to add the faces that are detected in the input images.
public Image image()
The input image as bytes or an S3 object.
public String externalImageId()
ID you want to assign to all the faces detected in the image.
public List<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).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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).
public List<String> detectionAttributesAsStrings()
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).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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).
public IndexFacesRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<IndexFacesRequest.Builder,IndexFacesRequest>
toBuilder
in class RekognitionRequest
public static IndexFacesRequest.Builder builder()
public static Class<? extends IndexFacesRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.