com.microsoft.azure.cognitiveservices.vision.faceapi.models.FindSimilarOptionalParameter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-cognitiveservices-faceapi Show documentation
This package contains Microsoft Cognitive Service Face API SDK.
There is a newer version: 1.0.1-beta
Show newest version
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 *
 * Code generated by Microsoft (R) AutoRest Code Generator.
 */

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

import java.util.List;
import java.util.UUID;

/**
 * The optional parameters class for "findSimilar" method.
 */
public class FindSimilarOptionalParameter {
    /**
    * An existing user-specified unique candidate face list, created in Face List - Create a Face List. Face list contains a
    * set of persistedFaceIds which are persisted and will never expire. Parameter faceListId and faceIds should not be
    * provided at the same time.
    */
    private String faceListId;

    /**
    * An array of candidate faceIds. All of them are created by Face - Detect and the faceIds will expire 24 hours after the
    * detection call.
    */
    private List faceIds;

    /**
    * The number of top similar faces returned. The valid range is [1, 1000].
    */
    private Integer maxNumOfCandidatesReturned;

    /**
    * Similar face searching mode. It can be "matchPerson" or "matchFace". Possible values include: 'matchPerson',
    * 'matchFace'.
    */
    private FindSimilarMatchMode mode;

    /**
    * Get the faceListId value.
    *
    * @return the faceListId value
    */
    public String faceListId() {
        return this.faceListId;
    }

    /**
    * Get the faceIds value.
    *
    * @return the faceIds value
    */
    public List faceIds() {
        return this.faceIds;
    }

    /**
    * Get the maxNumOfCandidatesReturned value.
    *
    * @return the maxNumOfCandidatesReturned value
    */
    public Integer maxNumOfCandidatesReturned() {
        return this.maxNumOfCandidatesReturned;
    }

    /**
    * Get the mode value.
    *
    * @return the mode value
    */
    public FindSimilarMatchMode mode() {
        return this.mode;
    }

    /**
    * Set the faceListId value.
    * 
    * An existing user-specified unique candidate face list, created in Face List - Create a Face List. Face list contains a
    * set of persistedFaceIds which are persisted and will never expire. Parameter faceListId and faceIds should not be
    * provided at the same time.
    *
    * @param faceListId the faceListId value to set
    * @return the findSimilarOptionalParameter object itself.
    */
    public FindSimilarOptionalParameter withFaceListId(String faceListId) {
        this.faceListId = faceListId;
        return this;
    }

    /**
    * Set the faceIds value.
    * 

    * An array of candidate faceIds. All of them are created by Face - Detect and the faceIds will expire 24 hours after the
    * detection call.
    *
    * @param faceIds the faceIds value to set
    * @return the findSimilarOptionalParameter object itself.
    */
    public FindSimilarOptionalParameter withFaceIds(List faceIds) {
        this.faceIds = faceIds;
        return this;
    }

    /**
    * Set the maxNumOfCandidatesReturned value.
    * 

    * The number of top similar faces returned. The valid range is [1, 1000].
    *
    * @param maxNumOfCandidatesReturned the maxNumOfCandidatesReturned value to set
    * @return the findSimilarOptionalParameter object itself.
    */
    public FindSimilarOptionalParameter withMaxNumOfCandidatesReturned(int maxNumOfCandidatesReturned) {
        this.maxNumOfCandidatesReturned = maxNumOfCandidatesReturned;
        return this;
    }

    /**
    * Set the mode value.
    * 
    * Similar face searching mode. It can be "matchPerson" or "matchFace". Possible values include: 'matchPerson',
    * 'matchFace'.
    *
    * @param mode the mode value to set
    * @return the findSimilarOptionalParameter object itself.
    */
    public FindSimilarOptionalParameter withMode(FindSimilarMatchMode mode) {
        this.mode = mode;
        return this;
    }

    }