com.amazonaws.services.rekognition.model

Class SearchUsersByImageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.SearchUsersByImageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchUsersByImageRequest
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
SearchUsersByImageRequest()

Method Summary

Modifier and Type	Method and Description
SearchUsersByImageRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCollectionId() The ID of an existing collection containing the UserID.
Image	getImage()
Integer	getMaxUsers() Maximum number of UserIDs to return.
String	getQualityFilter() A filter that specifies a quality bar for how much filtering is done to identify faces.
Float	getUserMatchThreshold() Specifies the minimum confidence in the UserID match to return.
int	hashCode()
void	setCollectionId(String collectionId) The ID of an existing collection containing the UserID.
void	setImage(Image image)
void	setMaxUsers(Integer maxUsers) Maximum number of UserIDs to return.
void	setQualityFilter(String qualityFilter) A filter that specifies a quality bar for how much filtering is done to identify faces.
void	setUserMatchThreshold(Float userMatchThreshold) Specifies the minimum confidence in the UserID match to return.
String	toString() Returns a string representation of this object.
SearchUsersByImageRequest	withCollectionId(String collectionId) The ID of an existing collection containing the UserID.
SearchUsersByImageRequest	withImage(Image image)
SearchUsersByImageRequest	withMaxUsers(Integer maxUsers) Maximum number of UserIDs to return.
SearchUsersByImageRequest	withQualityFilter(QualityFilter qualityFilter) A filter that specifies a quality bar for how much filtering is done to identify faces.
SearchUsersByImageRequest	withQualityFilter(String qualityFilter) A filter that specifies a quality bar for how much filtering is done to identify faces.
SearchUsersByImageRequest	withUserMatchThreshold(Float userMatchThreshold) Specifies 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

SearchUsersByImageRequest

public SearchUsersByImageRequest()

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

setImage

public void setImage(Image image)

Parameters:

image -

getImage

public Image getImage()

Returns:

withImage

public SearchUsersByImageRequest withImage(Image image)

Parameters:

image -

Returns:

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

setUserMatchThreshold

public void setUserMatchThreshold(Float userMatchThreshold)

Specifies the minimum confidence in the UserID match to return. Default value is 80.

Parameters:

userMatchThreshold - Specifies the minimum confidence in the UserID match to return. Default value is 80.

getUserMatchThreshold

public Float getUserMatchThreshold()

Specifies the minimum confidence in the UserID match to return. Default value is 80.

Returns:

Specifies the minimum confidence in the UserID match to return. Default value is 80.

withUserMatchThreshold

public SearchUsersByImageRequest withUserMatchThreshold(Float userMatchThreshold)

Specifies the minimum confidence in the UserID match to return. Default value is 80.

Parameters:

userMatchThreshold - Specifies the minimum confidence in the UserID match to return. Default value is 80.

Returns:

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

setMaxUsers

public void setMaxUsers(Integer maxUsers)

Maximum number of UserIDs to return.

Parameters:

maxUsers - Maximum number of UserIDs to return.

getMaxUsers

public Integer getMaxUsers()

Maximum number of UserIDs to return.

Returns:

Maximum number of UserIDs to return.

withMaxUsers

public SearchUsersByImageRequest withMaxUsers(Integer maxUsers)

Maximum number of UserIDs to return.

Parameters:

maxUsers - Maximum number of UserIDs to return.

Returns:

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

setQualityFilter

public void setQualityFilter(String qualityFilter)

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

Parameters:

qualityFilter - A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

See Also:

QualityFilter

getQualityFilter

public String getQualityFilter()

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

Returns:

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

See Also:

QualityFilter

withQualityFilter

public SearchUsersByImageRequest withQualityFilter(String qualityFilter)

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

Parameters:

qualityFilter - A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

Returns:

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

See Also:

QualityFilter

withQualityFilter

public SearchUsersByImageRequest withQualityFilter(QualityFilter qualityFilter)

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

Parameters:

qualityFilter - A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

Returns:

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

See Also:

QualityFilter

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 SearchUsersByImageRequest 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()