OnYourDataEncodedApiKeyAuthenticationOptions (Azure SDK for Java Reference Documentation)

java.lang.Object

com.azure.ai.openai.models.OnYourDataAuthenticationOptions

com.azure.ai.openai.models.OnYourDataEncodedApiKeyAuthenticationOptions

public final class OnYourDataEncodedApiKeyAuthenticationOptions extends OnYourDataAuthenticationOptions

The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.

Constructor Summary

Constructors

Constructor

Description

OnYourDataEncodedApiKeyAuthenticationOptions(String encodedApiKey)

Creates an instance of OnYourDataEncodedApiKeyAuthenticationOptions class.
Method Summary

Modifier and Type

Method

Description

String

getEncodedApiKey()

Get the encodedApiKey property: The encoded API key to use for authentication.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- OnYourDataEncodedApiKeyAuthenticationOptions
  
  public OnYourDataEncodedApiKeyAuthenticationOptions(String encodedApiKey)
  
  Creates an instance of OnYourDataEncodedApiKeyAuthenticationOptions class.
  
  Parameters:
  
  encodedApiKey - the encodedApiKey value to set.
Method Details
- getEncodedApiKey
  
  public String getEncodedApiKey()
  
  Get the encodedApiKey property: The encoded API key to use for authentication.
  
  Returns:
  
  the encodedApiKey value.