com.amazonaws.services.rekognition.model

Class AssociateFacesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.AssociateFacesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AssociateFacesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AssociateFacesRequest()

Method Summary

Modifier and Type	Method and Description
AssociateFacesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() Idempotent token used to identify the request to AssociateFaces.
String	getCollectionId() The ID of an existing collection containing the UserID.
List<String>	getFaceIds() An array of FaceIDs to associate with the UserID.
String	getUserId() The ID for the existing UserID.
Float	getUserMatchThreshold() An optional value specifying the minimum confidence in the UserID match to return.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) Idempotent token used to identify the request to AssociateFaces.
void	setCollectionId(String collectionId) The ID of an existing collection containing the UserID.
void	setFaceIds(Collection<String> faceIds) An array of FaceIDs to associate with the UserID.
void	setUserId(String userId) The ID for the existing UserID.
void	setUserMatchThreshold(Float userMatchThreshold) An optional value specifying the minimum confidence in the UserID match to return.
String	toString() Returns a string representation of this object.
AssociateFacesRequest	withClientRequestToken(String clientRequestToken) Idempotent token used to identify the request to AssociateFaces.
AssociateFacesRequest	withCollectionId(String collectionId) The ID of an existing collection containing the UserID.
AssociateFacesRequest	withFaceIds(Collection<String> faceIds) An array of FaceIDs to associate with the UserID.
AssociateFacesRequest	withFaceIds(String... faceIds) An array of FaceIDs to associate with the UserID.
AssociateFacesRequest	withUserId(String userId) The ID for the existing UserID.
AssociateFacesRequest	withUserMatchThreshold(Float userMatchThreshold) An optional value specifying the minimum confidence in the UserID match to return.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AssociateFacesRequest

public AssociateFacesRequest()

Method Detail

setCollectionId

public void setCollectionId(String collectionId)

The ID of an existing collection containing the UserID.

Parameters:

collectionId - The ID of an existing collection containing the UserID.

getCollectionId

public String getCollectionId()

The ID of an existing collection containing the UserID.

Returns:

The ID of an existing collection containing the UserID.

withCollectionId

public AssociateFacesRequest withCollectionId(String collectionId)

The ID of an existing collection containing the UserID.

Parameters:

collectionId - The ID of an existing collection containing the UserID.

Returns:

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

setUserId

public void setUserId(String userId)

The ID for the existing UserID.

Parameters:

userId - The ID for the existing UserID.

getUserId

public String getUserId()

The ID for the existing UserID.

Returns:

The ID for the existing UserID.

withUserId

public AssociateFacesRequest withUserId(String userId)

The ID for the existing UserID.

Parameters:

userId - The ID for the existing UserID.

Returns:

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

getFaceIds

public List<String> getFaceIds()

An array of FaceIDs to associate with the UserID.

Returns:

An array of FaceIDs to associate with the UserID.

setFaceIds

public void setFaceIds(Collection<String> faceIds)

An array of FaceIDs to associate with the UserID.

Parameters:

faceIds - An array of FaceIDs to associate with the UserID.

withFaceIds

public AssociateFacesRequest withFaceIds(String... faceIds)

An array of FaceIDs to associate with the UserID.

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

Parameters:

faceIds - An array of FaceIDs to associate with the UserID.

Returns:

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

withFaceIds

public AssociateFacesRequest withFaceIds(Collection<String> faceIds)

An array of FaceIDs to associate with the UserID.

Parameters:

faceIds - An array of FaceIDs to associate with the UserID.

Returns:

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

setUserMatchThreshold

public void setUserMatchThreshold(Float userMatchThreshold)

An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.

Parameters:

userMatchThreshold - An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.

getUserMatchThreshold

public Float getUserMatchThreshold()

An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.

Returns:

An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.

withUserMatchThreshold

public AssociateFacesRequest withUserMatchThreshold(Float userMatchThreshold)

An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.

Parameters:

userMatchThreshold - An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.

Returns:

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

setClientRequestToken

public void setClientRequestToken(String clientRequestToken)

Idempotent token used to identify the request to AssociateFaces. If you use the same token with multiple AssociateFaces requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

Parameters:

clientRequestToken - Idempotent token used to identify the request to AssociateFaces. If you use the same token with multiple AssociateFaces requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

getClientRequestToken

public String getClientRequestToken()

Idempotent token used to identify the request to AssociateFaces. If you use the same token with multiple AssociateFaces requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

Returns:

Idempotent token used to identify the request to AssociateFaces. If you use the same token with multiple AssociateFaces requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

withClientRequestToken

public AssociateFacesRequest withClientRequestToken(String clientRequestToken)

Idempotent token used to identify the request to AssociateFaces. If you use the same token with multiple AssociateFaces requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

Parameters:

clientRequestToken - Idempotent token used to identify the request to AssociateFaces. If you use the same token with multiple AssociateFaces requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

Returns:

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

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AssociateFacesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()