diff --git a/sdk/search/azure-search/src/main/java/com/azure/search/ApiKeyCredentials.java b/sdk/search/azure-search/src/main/java/com/azure/search/ApiKeyCredentials.java index 8a55ee0763fd..f5a7e98ae816 100644 --- a/sdk/search/azure-search/src/main/java/com/azure/search/ApiKeyCredentials.java +++ b/sdk/search/azure-search/src/main/java/com/azure/search/ApiKeyCredentials.java @@ -3,13 +3,29 @@ package com.azure.search; +/** + * Credentials that authorize requests to Azure Cognitive Search. It uses content within the HTTP request to + * generate the correct "api-key" header value + * + * @see SearchIndexClientBuilder + * @see SearchServiceClientBuilder + */ public class ApiKeyCredentials { private final String apiKey; + /** + * Creates an instance that is able to authorize requests to Azure Cognitive Search. + * + * @param apiKey a query or admin API key + */ public ApiKeyCredentials(String apiKey) { this.apiKey = apiKey; } + /** + * Gets the API key + * @return the API key + */ public String getApiKey() { return apiKey; }