Package com.azure.ai.openai.models

Class BatchErrorDatum

java.lang.Object
com.azure.ai.openai.models.BatchErrorDatum
All Implemented Interfaces:
com.azure.json.JsonSerializable<BatchErrorDatum>
public final class BatchErrorDatum extends Object implements com.azure.json.JsonSerializable<BatchErrorDatum>
A Datum containing information about a Batch Error.

  • Method Summary

    Modifier and Type
    Method
    Description
    static BatchErrorDatum
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of BatchErrorDatum from the JsonReader.
    String
    getCode()
    Get the code property: An error code identifying the error type.
    Integer
    getLine()
    Get the line property: The line number of the input file where the error occurred, if applicable.
    String
    getMessage()
    Get the message property: A human-readable message providing more details about the error.
    String
    getParam()
    Get the param property: The name of the parameter that caused the error, if applicable.
    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 String getCode()
      Get the code property: An error code identifying the error type.
      Returns:
      the code value.

    • getMessage

      public String getMessage()
      Get the message property: A human-readable message providing more details about the error.
      Returns:
      the message value.

    • getParam

      public String getParam()
      Get the param property: The name of the parameter that caused the error, if applicable.
      Returns:
      the param value.

    • getLine

      public Integer getLine()
      Get the line property: The line number of the input file where the error occurred, if applicable.
      Returns:
      the line value.

    • toJson

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

    • fromJson

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