BingCustomSearchAPI Interface

Package:

com.microsoft.azure.cognitiveservices.search.customsearch

Maven Artifact:

com.microsoft.azure.cognitiveservices:azure-cognitiveservices-customsearch:1.0.2

public interface BingCustomSearchAPI

The interface for BingCustomSearchAPI class.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	acceptLanguage() Gets Gets or sets the preferred language for the response..
abstract BingCustomInstances	bingCustomInstances() Gets the BingCustomInstances object to access its operations.
abstract boolean	generateClientRequestId() Gets When set to true a unique x-ms-client-request-id value is generated and included in each request.
abstract com.microsoft.azure.AzureClient	getAzureClient() Gets the AzureClient used for long running operations.
abstract int	longRunningOperationRetryTimeout() Gets Gets or sets the retry timeout in seconds for Long Running Operations.
abstract com.microsoft.rest.RestClient	restClient() Gets the REST client.
abstract java.lang.String	userAgent() Gets the User-Agent header for the client.
abstract BingCustomSearchAPI	withAcceptLanguage(String acceptLanguage) Sets Gets or sets the preferred language for the response..
abstract BingCustomSearchAPI	withGenerateClientRequestId(boolean generateClientRequestId) Sets When set to true a unique x-ms-client-request-id value is generated and included in each request.
abstract BingCustomSearchAPI	withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout) Sets Gets or sets the retry timeout in seconds for Long Running Operations.

Method Details

acceptLanguage

public abstract String acceptLanguage()

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

Returns:

the acceptLanguage value.

bingCustomInstances

public abstract BingCustomInstances bingCustomInstances()

Gets the BingCustomInstances object to access its operations.

Returns:

the BingCustomInstances object.

generateClientRequestId

public abstract 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 abstract AzureClient getAzureClient()

Gets the AzureClient used for long running operations.

Returns:

the azure client;

longRunningOperationRetryTimeout

public abstract int longRunningOperationRetryTimeout()

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

Returns:

the longRunningOperationRetryTimeout value.

restClient

public abstract RestClient restClient()

Gets the REST client.

Returns:

the RestClient object.

userAgent

public abstract String userAgent()

Gets the User-Agent header for the client.

Returns:

the user agent string.

withAcceptLanguage

public abstract BingCustomSearchAPI withAcceptLanguage(String acceptLanguage)

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

Parameters:

acceptLanguage - the acceptLanguage value.

Returns:

the service client itself

withGenerateClientRequestId

public abstract BingCustomSearchAPI 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 abstract BingCustomSearchAPI 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