Package com.microsoft.azure.cognitiveservices.search.customsearch.implementation

Class BingCustomSearchAPIImpl

java.lang.Object

com.microsoft.rest.ServiceClient

com.microsoft.azure.AzureServiceClient

com.microsoft.azure.cognitiveservices.search.customsearch.implementation.BingCustomSearchAPIImpl

All Implemented Interfaces:

BingCustomSearchAPI

public class BingCustomSearchAPIImpl
extends com.microsoft.azure.AzureServiceClient
implements BingCustomSearchAPI

Initializes a new instance of the BingCustomSearchAPIImpl class.

Constructor Summary

Constructors

Constructor	Description
BingCustomSearchAPIImpl(com.microsoft.rest.credentials.ServiceClientCredentials credentials)	Initializes an instance of BingCustomSearchAPI client.
BingCustomSearchAPIImpl(com.microsoft.rest.RestClient restClient)	Initializes an instance of BingCustomSearchAPI client.
BingCustomSearchAPIImpl(String baseUrl, com.microsoft.rest.credentials.ServiceClientCredentials credentials)	Initializes an instance of BingCustomSearchAPI client.

Method Summary

Modifier and Type	Method	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.
com.microsoft.azure.AzureClient	getAzureClient()	Gets the AzureClient used for long running operations.
protected void	initialize()
int	longRunningOperationRetryTimeout()	Gets Gets or sets the retry timeout in seconds for Long Running Operations.
String	userAgent()	Gets the User-Agent header for the client.
BingCustomSearchAPIImpl	withAcceptLanguage(String acceptLanguage)	Sets Gets or sets the preferred language for the response.
BingCustomSearchAPIImpl	withGenerateClientRequestId(boolean generateClientRequestId)	Sets When set to true a unique x-ms-client-request-id value is generated and included in each request.
BingCustomSearchAPIImpl	withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)	Sets Gets or sets the retry timeout in seconds for Long Running Operations.

Methods inherited from class com.microsoft.rest.ServiceClient

httpClient, restClient, retrofit, serializerAdapter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microsoft.azure.cognitiveservices.search.customsearch.BingCustomSearchAPI

restClient

Constructor Detail

BingCustomSearchAPIImpl

public BingCustomSearchAPIImpl(com.microsoft.rest.credentials.ServiceClientCredentials credentials)

Initializes an instance of BingCustomSearchAPI client.

Parameters:

credentials - the management credentials for Azure

BingCustomSearchAPIImpl

public BingCustomSearchAPIImpl(String baseUrl,
                               com.microsoft.rest.credentials.ServiceClientCredentials credentials)

Initializes an instance of BingCustomSearchAPI client.

Parameters:

baseUrl - the base URL of the host

credentials - the management credentials for Azure

BingCustomSearchAPIImpl

public BingCustomSearchAPIImpl(com.microsoft.rest.RestClient restClient)

Initializes an instance of BingCustomSearchAPI client.

Parameters:

restClient - the REST client to connect to Azure.

Method Detail

getAzureClient

public com.microsoft.azure.AzureClient getAzureClient()

Gets the AzureClient used for long running operations.

Specified by:

getAzureClient in interface BingCustomSearchAPI

Returns:

the azure client;

acceptLanguage

public String acceptLanguage()

Gets Gets or sets the preferred language for the response.

Specified by:

acceptLanguage in interface BingCustomSearchAPI

Returns:

the acceptLanguage value.

withAcceptLanguage

public BingCustomSearchAPIImpl withAcceptLanguage(String acceptLanguage)

Sets Gets or sets the preferred language for the response.

Specified by:

withAcceptLanguage in interface BingCustomSearchAPI

Parameters:

acceptLanguage - the acceptLanguage value.

Returns:

the service client itself

longRunningOperationRetryTimeout

public int longRunningOperationRetryTimeout()

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

Specified by:

longRunningOperationRetryTimeout in interface BingCustomSearchAPI

Returns:

the longRunningOperationRetryTimeout value.

withLongRunningOperationRetryTimeout

public BingCustomSearchAPIImpl withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)

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

Specified by:

withLongRunningOperationRetryTimeout in interface BingCustomSearchAPI

Parameters:

longRunningOperationRetryTimeout - the longRunningOperationRetryTimeout value.

Returns:

the service client itself

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.

Specified by:

generateClientRequestId in interface BingCustomSearchAPI

Returns:

the generateClientRequestId value.

withGenerateClientRequestId

public BingCustomSearchAPIImpl 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.

Specified by:

withGenerateClientRequestId in interface BingCustomSearchAPI

Parameters:

generateClientRequestId - the generateClientRequestId value.

Returns:

the service client itself

bingCustomInstances

public BingCustomInstances bingCustomInstances()

Gets the BingCustomInstances object to access its operations.

Specified by:

bingCustomInstances in interface BingCustomSearchAPI

Returns:

the BingCustomInstances object.

initialize

protected void initialize()

userAgent

public String userAgent()

Gets the User-Agent header for the client.

Specified by:

userAgent in interface BingCustomSearchAPI

Overrides:

userAgent in class com.microsoft.azure.AzureServiceClient

Returns:

the user agent string.