Class OpenApiAuthDetails

java.lang.Object
com.azure.ai.agents.persistent.models.OpenApiAuthDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<OpenApiAuthDetails>
Direct Known Subclasses:
OpenApiAnonymousAuthDetails, OpenApiConnectionAuthDetails, OpenApiManagedAuthDetails

public class OpenApiAuthDetails extends Object implements com.azure.json.JsonSerializable<OpenApiAuthDetails>
authentication details for OpenApiFunctionDefinition.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an instance of OpenApiAuthDetails class.
  • Method Summary

    Modifier and Type
    Method
    Description
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of OpenApiAuthDetails from the JsonReader.
    Get the type property: The type of authentication, must be anonymous/connection/managed_identity.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString
  • Constructor Details

    • OpenApiAuthDetails

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

    • getType

      public OpenApiAuthType getType()
      Get the type property: The type of authentication, must be anonymous/connection/managed_identity.
      Returns:
      the type value.
    • toJson

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

      public static OpenApiAuthDetails fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of OpenApiAuthDetails from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of OpenApiAuthDetails 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 OpenApiAuthDetails.