Package com.azure.ai.agents.persistent.models

Class OpenApiConnectionAuthDetails

java.lang.Object
com.azure.ai.agents.persistent.models.OpenApiAuthDetails
com.azure.ai.agents.persistent.models.OpenApiConnectionAuthDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<OpenApiAuthDetails>
public final class OpenApiConnectionAuthDetails extends OpenApiAuthDetails
Security details for OpenApi connection authentication.

  • Constructor Details

    • OpenApiConnectionAuthDetails

      public OpenApiConnectionAuthDetails(OpenApiConnectionSecurityScheme securityScheme)
      Creates an instance of OpenApiConnectionAuthDetails class.
      Parameters:
      securityScheme - the securityScheme value to set.

  • Method Details

    • getType

      public OpenApiAuthType getType()
      Get the type property: The type of authentication, must be anonymous/connection/managed_identity.
      Overrides:
      getType in class OpenApiAuthDetails
      Returns:
      the type value.

    • getSecurityScheme

      public OpenApiConnectionSecurityScheme getSecurityScheme()
      Get the securityScheme property: Connection auth security details.
      Returns:
      the securityScheme 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>
      Overrides:
      toJson in class OpenApiAuthDetails
      Throws:
      IOException

    • fromJson

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