Share via

FileDeletionStatus Class

  • Reference
Package:
com.azure.ai.openai.models
Maven Artifact:
com.azure:azure-ai-openai:1.0.0-beta.12
  • java.lang.Object
    • com.azure.ai.openai.models.FileDeletionStatus

Implements

JsonSerializable<FileDeletionStatus>

public final class FileDeletionStatus
implements JsonSerializable<FileDeletionStatus>

A status response from a file deletion operation.

Method Summary

Modifier and Type Method and Description
static FileDeletionStatus fromJson(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.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static FileDeletionStatus fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

getId

public String getId()

Get the id property: The ID of the resource specified for deletion.

Returns:

the id value.

getObject

public String getObject()

Get the object property: The object type, which is always 'file'.

Returns:

the object value.

isDeleted

public boolean isDeleted()

Get the deleted property: A value indicating whether deletion was successful.

Returns:

the deleted value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to