com.microsoft.azure.cognitiveservices.vision.faceapi.models.DetectWithStreamOptionalParameter 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;

/**
 * The optional parameters class for "detectWithStream" method.
 */
public class DetectWithStreamOptionalParameter {
    /**
    * A value indicating whether the operation should return faceIds of detected faces.
    */
    private Boolean returnFaceId;

    /**
    * A value indicating whether the operation should return landmarks of the detected faces.
    */
    private Boolean returnFaceLandmarks;

    /**
    * Analyze and return the one or more specified face attributes in the comma-separated string like
    * "returnFaceAttributes=age,gender". Supported face attributes include age, gender, headPose, smile, facialHair, glasses
    * and emotion. Note that each face attribute analysis has additional computational and time cost.
    */
    private List returnFaceAttributes;

    /**
    * Get the returnFaceId value.
    *
    * @return the returnFaceId value
    */
    public Boolean returnFaceId() {
        return this.returnFaceId;
    }

    /**
    * Get the returnFaceLandmarks value.
    *
    * @return the returnFaceLandmarks value
    */
    public Boolean returnFaceLandmarks() {
        return this.returnFaceLandmarks;
    }

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

    /**
    * Set the returnFaceId value.
    * 
    * A value indicating whether the operation should return faceIds of detected faces.
    *
    * @param returnFaceId the returnFaceId value to set
    * @return the detectWithStreamOptionalParameter object itself.
    */
    public DetectWithStreamOptionalParameter withReturnFaceId(boolean returnFaceId) {
        this.returnFaceId = returnFaceId;
        return this;
    }

    /**
    * Set the returnFaceLandmarks value.
    * 

    * A value indicating whether the operation should return landmarks of the detected faces.
    *
    * @param returnFaceLandmarks the returnFaceLandmarks value to set
    * @return the detectWithStreamOptionalParameter object itself.
    */
    public DetectWithStreamOptionalParameter withReturnFaceLandmarks(boolean returnFaceLandmarks) {
        this.returnFaceLandmarks = returnFaceLandmarks;
        return this;
    }

    /**
    * Set the returnFaceAttributes value.
    * 
    * Analyze and return the one or more specified face attributes in the comma-separated string like
    * "returnFaceAttributes=age,gender". Supported face attributes include age, gender, headPose, smile, facialHair, glasses
    * and emotion. Note that each face attribute analysis has additional computational and time cost.
    *
    * @param returnFaceAttributes the returnFaceAttributes value to set
    * @return the detectWithStreamOptionalParameter object itself.
    */
    public DetectWithStreamOptionalParameter withReturnFaceAttributes(List returnFaceAttributes) {
        this.returnFaceAttributes = returnFaceAttributes;
        return this;
    }

    }