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

Class RunStepError

java.lang.Object
com.azure.ai.agents.persistent.models.RunStepError
All Implemented Interfaces:
com.azure.json.JsonSerializable<RunStepError>
public final class RunStepError extends Object implements com.azure.json.JsonSerializable<RunStepError>
The error information associated with a failed run step.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RunStepError
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of RunStepError from the JsonReader.
    RunStepErrorCode
    getCode()
    Get the code property: The error code for this error.
    String
    getMessage()
    Get the message property: The human-readable text associated with this error.
    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

  • Method Details

    • getCode

      public RunStepErrorCode getCode()
      Get the code property: The error code for this error.
      Returns:
      the code value.

    • getMessage

      public String getMessage()
      Get the message property: The human-readable text associated with this error.
      Returns:
      the message value.

    • toJson

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

    • fromJson

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