com.amazonaws.services.rekognition.model

Class GetFaceSearchRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.GetFaceSearchRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
GetFaceSearchRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getJobId() The job identifer for the search request.
Integer	getMaxResults() Maximum number of results to return per paginated call.
String	getNextToken() If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response.
String	getSortBy() Sort to use for grouping faces in the response.
int	hashCode()
void	setJobId(String jobId) The job identifer for the search request.
void	setMaxResults(Integer maxResults) Maximum number of results to return per paginated call.
void	setNextToken(String nextToken) If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response.
void	setSortBy(String sortBy) Sort to use for grouping faces in the response.
String	toString() Returns a string representation of this object.
GetFaceSearchRequest	withJobId(String jobId) The job identifer for the search request.
GetFaceSearchRequest	withMaxResults(Integer maxResults) Maximum number of results to return per paginated call.
GetFaceSearchRequest	withNextToken(String nextToken) If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response.
GetFaceSearchRequest	withSortBy(FaceSearchSortBy sortBy) Sort to use for grouping faces in the response.
GetFaceSearchRequest	withSortBy(String sortBy) Sort to use for grouping faces in the response.

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

GetFaceSearchRequest

public GetFaceSearchRequest()

Method Detail

setJobId

public void setJobId(String jobId)

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Parameters:

jobId - The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

getJobId

public String getJobId()

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Returns:

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

withJobId

public GetFaceSearchRequest withJobId(String jobId)

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Parameters:

jobId - The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Parameters:

maxResults - Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

getMaxResults

public Integer getMaxResults()

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Returns:

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

withMaxResults

public GetFaceSearchRequest withMaxResults(Integer maxResults)

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Parameters:

maxResults - Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Parameters:

nextToken - If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

getNextToken

public String getNextToken()

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Returns:

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

withNextToken

public GetFaceSearchRequest withNextToken(String nextToken)

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Parameters:

nextToken - If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Returns:

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

setSortBy

public void setSortBy(String sortBy)

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Parameters:

sortBy - Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

See Also:

FaceSearchSortBy

getSortBy

public String getSortBy()

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Returns:

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

See Also:

FaceSearchSortBy

withSortBy

public GetFaceSearchRequest withSortBy(String sortBy)

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Parameters:

sortBy - Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Returns:

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

See Also:

FaceSearchSortBy

withSortBy

public GetFaceSearchRequest withSortBy(FaceSearchSortBy sortBy)

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Parameters:

sortBy - Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Returns:

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

See Also:

FaceSearchSortBy

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