BingWebSearchAPI Interface

  • Reference
Package:
com.microsoft.azure.cognitiveservices.search.websearch

public interface BingWebSearchAPI

The interface for BingWebSearchAPI class.

Method Summary

Modifier and Type Method and Description
String acceptLanguage()

Gets Gets or sets the preferred language for the response..
BingWebSearch bingWebs()

Gets the BingWebSearch 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.
BingWebSearchAPI withAcceptLanguage(String acceptLanguage)

Sets Gets or sets the preferred language for the response..
BingWebSearchAPI 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..
BingWebSearchAPI 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.

bingWebs

public BingWebSearch bingWebs()

Gets the BingWebSearch object to access its operations.

Returns:

the BingWebSearch 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 BingWebSearchAPI 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 BingWebSearchAPI 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 BingWebSearchAPI 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