FindSimilarRequest Class

Package:

com.microsoft.azure.cognitiveservices.vision.faceapi.models

• java.lang.Object
• • com.microsoft.azure.cognitiveservices.vision.faceapi.models.FindSimilarRequest

public class FindSimilarRequest

Request body for find similar operation.

Method Summary

Modifier and Type	Method and Description
UUID	faceId() Get the faceId value.
List<UUID>	faceIds() Get the faceIds value.
String	faceListId() Get the faceListId value.
Integer	maxNumOfCandidatesReturned() Get the maxNumOfCandidatesReturned value.
FindSimilarMatchMode	mode() Get the mode value.
FindSimilarRequest	withFaceId(UUID faceId) Set the faceId value.
FindSimilarRequest	withFaceIds(List<UUID> faceIds) Set the faceIds value.
FindSimilarRequest	withFaceListId(String faceListId) Set the faceListId value.
FindSimilarRequest	withMaxNumOfCandidatesReturned(Integer maxNumOfCandidatesReturned) Set the maxNumOfCandidatesReturned value.
FindSimilarRequest	withMode(FindSimilarMatchMode mode) Set the mode value.

Method Details

faceId

public UUID faceId()

Get the faceId value.

Returns:

the faceId value

faceIds

public List faceIds()

Get the faceIds value.

Returns:

the faceIds value

faceListId

public String faceListId()

Get the faceListId value.

Returns:

the faceListId value

maxNumOfCandidatesReturned

public Integer maxNumOfCandidatesReturned()

Get the maxNumOfCandidatesReturned value.

Returns:

the maxNumOfCandidatesReturned value

mode

public FindSimilarMatchMode mode()

Get the mode value.

Returns:

the mode value

withFaceId

public FindSimilarRequest withFaceId(UUID faceId)

Set the faceId value.

Parameters:

faceId - the faceId value to set

Returns:

the FindSimilarRequest object itself.

withFaceIds

public FindSimilarRequest withFaceIds(List faceIds)

Set the faceIds value.

Parameters:

faceIds - the faceIds value to set

Returns:

the FindSimilarRequest object itself.

withFaceListId

public FindSimilarRequest withFaceListId(String faceListId)

Set the faceListId value.

Parameters:

faceListId - the faceListId value to set

Returns:

the FindSimilarRequest object itself.

withMaxNumOfCandidatesReturned

public FindSimilarRequest withMaxNumOfCandidatesReturned(Integer maxNumOfCandidatesReturned)

Set the maxNumOfCandidatesReturned value.

Parameters:

maxNumOfCandidatesReturned - the maxNumOfCandidatesReturned value to set

Returns:

the FindSimilarRequest object itself.

withMode

public FindSimilarRequest withMode(FindSimilarMatchMode mode)

Set the mode value.

Parameters:

mode - the mode value to set

Returns:

the FindSimilarRequest object itself.