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

Interface BingCustomSearchAPI

  • All Known Implementing Classes:
    BingCustomSearchAPIImpl
    public interface BingCustomSearchAPI
    The interface for BingCustomSearchAPI class.

    • Method Detail

      • restClient

        com.microsoft.rest.RestClient restClient()
        Gets the REST client.
        Returns:
        the RestClient object.

      • getAzureClient

        com.microsoft.azure.AzureClient getAzureClient()
        Gets the AzureClient used for long running operations.
        Returns:
        the azure client;

      • userAgent

        String userAgent()
        Gets the User-Agent header for the client.
        Returns:
        the user agent string.

      • acceptLanguage

        String acceptLanguage()
        Gets Gets or sets the preferred language for the response..
        Returns:
        the acceptLanguage value.

      • withAcceptLanguage

        BingCustomSearchAPI withAcceptLanguage​(String acceptLanguage)
        Sets Gets or sets the preferred language for the response..
        Parameters:
        acceptLanguage - the acceptLanguage value.
        Returns:
        the service client itself

      • longRunningOperationRetryTimeout

        int longRunningOperationRetryTimeout()
        Gets Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30..
        Returns:
        the longRunningOperationRetryTimeout value.

      • withLongRunningOperationRetryTimeout

        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

      • generateClientRequestId

        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.

      • withGenerateClientRequestId

        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

      • bingCustomInstances

        BingCustomInstances bingCustomInstances()
        Gets the BingCustomInstances object to access its operations.
        Returns:
        the BingCustomInstances object.