Package com.azure.ai.openai.assistants.models

Class RequiredAction

java.lang.Object
com.azure.ai.openai.assistants.models.RequiredAction
All Implemented Interfaces:
com.azure.json.JsonSerializable<RequiredAction>
Direct Known Subclasses:
SubmitToolOutputsAction
public class RequiredAction extends Object implements com.azure.json.JsonSerializable<RequiredAction>
An abstract representation of a required action for an assistant thread run to continue.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    RequiredAction()
    Creates an instance of RequiredAction class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RequiredAction
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of RequiredAction from the JsonReader.
    String
    getType()
    Get the type property: The object type.
    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

    • RequiredAction

      protected RequiredAction()
      Creates an instance of RequiredAction class.

  • Method Details

    • toJson

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

    • fromJson

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

    • getType

      public String getType()
      Get the type property: The object type.
      Returns:
      the type value.