@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SearchUsersRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
SearchUsersRequest() |
Modifier and Type | Method and Description |
---|---|
SearchUsersRequest |
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, used with a UserId or FaceId.
|
String |
getFaceId()
ID for the existing face.
|
Integer |
getMaxUsers()
Maximum number of identities to return.
|
String |
getUserId()
ID for the existing User.
|
Float |
getUserMatchThreshold()
Optional value that specifies the minimum confidence in the matched UserID to return.
|
int |
hashCode() |
void |
setCollectionId(String collectionId)
The ID of an existing collection containing the UserID, used with a UserId or FaceId.
|
void |
setFaceId(String faceId)
ID for the existing face.
|
void |
setMaxUsers(Integer maxUsers)
Maximum number of identities to return.
|
void |
setUserId(String userId)
ID for the existing User.
|
void |
setUserMatchThreshold(Float userMatchThreshold)
Optional value that specifies the minimum confidence in the matched UserID to return.
|
String |
toString()
Returns a string representation of this object.
|
SearchUsersRequest |
withCollectionId(String collectionId)
The ID of an existing collection containing the UserID, used with a UserId or FaceId.
|
SearchUsersRequest |
withFaceId(String faceId)
ID for the existing face.
|
SearchUsersRequest |
withMaxUsers(Integer maxUsers)
Maximum number of identities to return.
|
SearchUsersRequest |
withUserId(String userId)
ID for the existing User.
|
SearchUsersRequest |
withUserMatchThreshold(Float userMatchThreshold)
Optional value that specifies the minimum confidence in the matched UserID to return.
|
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
public void setCollectionId(String collectionId)
The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.
collectionId
- The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is
provided, UserId isn’t required to be present in the Collection.public String getCollectionId()
The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.
public SearchUsersRequest withCollectionId(String collectionId)
The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.
collectionId
- The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is
provided, UserId isn’t required to be present in the Collection.public void setUserId(String userId)
ID for the existing User.
userId
- ID for the existing User.public String getUserId()
ID for the existing User.
public SearchUsersRequest withUserId(String userId)
ID for the existing User.
userId
- ID for the existing User.public void setFaceId(String faceId)
ID for the existing face.
faceId
- ID for the existing face.public String getFaceId()
ID for the existing face.
public SearchUsersRequest withFaceId(String faceId)
ID for the existing face.
faceId
- ID for the existing face.public void setUserMatchThreshold(Float userMatchThreshold)
Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.
userMatchThreshold
- Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.public Float getUserMatchThreshold()
Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.
public SearchUsersRequest withUserMatchThreshold(Float userMatchThreshold)
Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.
userMatchThreshold
- Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.public void setMaxUsers(Integer maxUsers)
Maximum number of identities to return.
maxUsers
- Maximum number of identities to return.public Integer getMaxUsers()
Maximum number of identities to return.
public SearchUsersRequest withMaxUsers(Integer maxUsers)
Maximum number of identities to return.
maxUsers
- Maximum number of identities to return.public String toString()
toString
in class Object
Object.toString()
public SearchUsersRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()