BingCustomSearchAPI Interface

Package:

com.microsoft.azure.cognitiveservices.search.customsearch

public interface BingCustomSearchAPI

The interface for BingCustomSearchAPI class.

Method Summary

Modifier and Type	Method and Description
String	acceptLanguage() Gets Gets or sets the preferred language for the response..
BingCustomInstances	bingCustomInstances() Gets the BingCustomInstances 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..
RestClient	restClient() Gets the REST client.
String	userAgent() Gets the User-Agent header for the client.
BingCustomSearchAPI	withAcceptLanguage(String acceptLanguage) Sets Gets or sets the preferred language for the response..
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..
BingCustomSearchAPI	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.

bingCustomInstances

public BingCustomInstances bingCustomInstances()

Gets the BingCustomInstances object to access its operations.

Returns:

the BingCustomInstances 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.

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 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 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 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