Share via

FaceAPI Interface

  • Reference
Package:
com.microsoft.azure.cognitiveservices.vision.faceapi

public interface FaceAPI

The interface for FaceAPI class.

Method Summary

Modifier and Type Method and Description
String acceptLanguage()

Gets Gets or sets the preferred language for the response..
AzureRegions azureRegion()

Gets Supported Azure regions for Cognitive Services endpoints. Possible values include: 'westus', 'westeurope', 'southeastasia', 'eastus2', 'westcentralus', 'westus2', 'eastus', 'southcentralus', 'northeurope', 'eastasia', 'australiaeast', 'brazilsouth'.
FaceLists faceLists()

Gets the FaceLists object to access its operations.

Faces faces()

Gets the Faces object to access its operations.

boolean generateClientRequestId()

Gets When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true..
AzureClient getAzureClient()

Gets the AzureClient used for long running operations.

int longRunningOperationRetryTimeout()

Gets Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30..
PersonGroupPersons personGroupPersons()

Gets the PersonGroupPersons object to access its operations.

PersonGroups personGroups()

Gets the PersonGroups object to access its operations.

RestClient restClient()

Gets the REST client.
String userAgent()

Gets the User-Agent header for the client.
FaceAPI withAcceptLanguage(String acceptLanguage)

Sets Gets or sets the preferred language for the response..
FaceAPI withAzureRegion(AzureRegions azureRegion)

Sets Supported Azure regions for Cognitive Services endpoints. Possible values include: 'westus', 'westeurope', 'southeastasia', 'eastus2', 'westcentralus', 'westus2', 'eastus', 'southcentralus', 'northeurope', 'eastasia', 'australiaeast', 'brazilsouth'.
FaceAPI withGenerateClientRequestId(boolean generateClientRequestId)

Sets When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true..
FaceAPI withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)

Sets Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30..

Method Details

acceptLanguage

public String acceptLanguage()

Gets Gets or sets the preferred language for the response..

Returns:

the acceptLanguage value.

azureRegion

public AzureRegions azureRegion()

Gets Supported Azure regions for Cognitive Services endpoints. Possible values include: 'westus', 'westeurope', 'southeastasia', 'eastus2', 'westcentralus', 'westus2', 'eastus', 'southcentralus', 'northeurope', 'eastasia', 'australiaeast', 'brazilsouth'.

Returns:

the azureRegion value.

faceLists

public FaceLists faceLists()

Gets the FaceLists object to access its operations.

Returns:

the FaceLists object.

faces

public Faces faces()

Gets the Faces object to access its operations.

Returns:

the Faces object.

generateClientRequestId

public boolean generateClientRequestId()

Gets When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true..

Returns:

the generateClientRequestId value.

getAzureClient

public AzureClient getAzureClient()

Gets the AzureClient used for long running operations.

Returns:

the azure client;

longRunningOperationRetryTimeout

public int longRunningOperationRetryTimeout()

Gets Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30..

Returns:

the longRunningOperationRetryTimeout value.

personGroupPersons

public PersonGroupPersons personGroupPersons()

Gets the PersonGroupPersons object to access its operations.

Returns:

the PersonGroupPersons object.

personGroups

public PersonGroups personGroups()

Gets the PersonGroups object to access its operations.

Returns:

the PersonGroups object.

restClient

public RestClient restClient()

Gets the REST client.

Returns:

the RestClient object.

userAgent

public String userAgent()

Gets the User-Agent header for the client.

Returns:

the user agent string.

withAcceptLanguage

public FaceAPI withAcceptLanguage(String acceptLanguage)

Sets Gets or sets the preferred language for the response..

Parameters:

acceptLanguage - the acceptLanguage value.

Returns:

the service client itself

withAzureRegion

public FaceAPI withAzureRegion(AzureRegions azureRegion)

Sets Supported Azure regions for Cognitive Services endpoints. Possible values include: 'westus', 'westeurope', 'southeastasia', 'eastus2', 'westcentralus', 'westus2', 'eastus', 'southcentralus', 'northeurope', 'eastasia', 'australiaeast', 'brazilsouth'.

Parameters:

azureRegion - the azureRegion value.

Returns:

the service client itself

withGenerateClientRequestId

public FaceAPI withGenerateClientRequestId(boolean generateClientRequestId)

Sets When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true..

Parameters:

generateClientRequestId - the generateClientRequestId value.

Returns:

the service client itself

withLongRunningOperationRetryTimeout

public FaceAPI withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)

Sets Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30..

Parameters:

longRunningOperationRetryTimeout - the longRunningOperationRetryTimeout value.

Returns:

the service client itself

Applies to