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

Class FileDeletionStatus

java.lang.Object
com.azure.ai.openai.assistants.models.FileDeletionStatus
All Implemented Interfaces:
com.azure.json.JsonSerializable<FileDeletionStatus>
public final class FileDeletionStatus extends Object implements com.azure.json.JsonSerializable<FileDeletionStatus>
A status response from a file deletion operation.

  • Method Summary

    Modifier and Type
    Method
    Description
    static FileDeletionStatus
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of FileDeletionStatus from the JsonReader.
    String
    getId()
    Get the id property: The ID of the resource specified for deletion.
    String
    getObject()
    Get the object property: The object type, which is always 'file'.
    boolean
    isDeleted()
    Get the deleted property: A value indicating whether deletion was successful.
    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

    • getId

      public String getId()
      Get the id property: The ID of the resource specified for deletion.
      Returns:
      the id value.

    • isDeleted

      public boolean isDeleted()
      Get the deleted property: A value indicating whether deletion was successful.
      Returns:
      the deleted value.

    • getObject

      public String getObject()
      Get the object property: The object type, which is always 'file'.
      Returns:
      the object value.

    • toJson

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

    • fromJson

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