Class DataPlaneAadOrApiKeyAuthOption

java.lang.Object
com.azure.resourcemanager.search.models.DataPlaneAadOrApiKeyAuthOption
All Implemented Interfaces:
com.azure.json.JsonSerializable<DataPlaneAadOrApiKeyAuthOption>

public final class DataPlaneAadOrApiKeyAuthOption extends Object implements com.azure.json.JsonSerializable<DataPlaneAadOrApiKeyAuthOption>
Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.
  • Constructor Details

    • DataPlaneAadOrApiKeyAuthOption

      public DataPlaneAadOrApiKeyAuthOption()
      Creates an instance of DataPlaneAadOrApiKeyAuthOption class.
  • Method Details

    • aadAuthFailureMode

      public AadAuthFailureMode aadAuthFailureMode()
      Get the aadAuthFailureMode property: Describes what response the data plane API of a search service would send for requests that failed authentication.
      Returns:
      the aadAuthFailureMode value.
    • withAadAuthFailureMode

      public DataPlaneAadOrApiKeyAuthOption withAadAuthFailureMode(AadAuthFailureMode aadAuthFailureMode)
      Set the aadAuthFailureMode property: Describes what response the data plane API of a search service would send for requests that failed authentication.
      Parameters:
      aadAuthFailureMode - the aadAuthFailureMode value to set.
      Returns:
      the DataPlaneAadOrApiKeyAuthOption object itself.
    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.
    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<DataPlaneAadOrApiKeyAuthOption>
      Throws:
      IOException
    • fromJson

      public static DataPlaneAadOrApiKeyAuthOption fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DataPlaneAadOrApiKeyAuthOption from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DataPlaneAadOrApiKeyAuthOption if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the DataPlaneAadOrApiKeyAuthOption.