Package com.azure.ai.openai.responses.models

Class ResponsesStreamEventError

java.lang.Object
com.azure.ai.openai.responses.models.ResponsesStreamEvent
com.azure.ai.openai.responses.models.ResponsesStreamEventError
All Implemented Interfaces:
com.azure.json.JsonSerializable<ResponsesStreamEvent>
public final class ResponsesStreamEventError extends ResponsesStreamEvent
Emitted when an error has occurred.

  • Method Details

    • getType

      public ResponsesStreamEventType getType()
      Get the type property: The type property.
      Overrides:
      getType in class ResponsesStreamEvent
      Returns:
      the type value.

    • getMessage

      public String getMessage()
      Get the message property: The error message.
      Returns:
      the message value.

    • getCode

      public String getCode()
      Get the code property: The error code, if applicable.
      Returns:
      the code value.

    • getParam

      public String getParam()
      Get the param property: The parameter the error applies to, if applicable.
      Returns:
      the param value.

    • toJson

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

    • fromJson

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