Package com.azure.ai.openai.models

Class UploadPart

java.lang.Object
com.azure.ai.openai.models.UploadPart
All Implemented Interfaces:
com.azure.json.JsonSerializable<UploadPart>
public final class UploadPart extends Object implements com.azure.json.JsonSerializable<UploadPart>
The upload Part represents a chunk of bytes we can add to an Upload object.

  • Method Summary

    Modifier and Type
    Method
    Description
    static UploadPart
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of UploadPart from the JsonReader.
    String
    getAzureBlockId()
    Get the azureBlockId property: Azure only field.
    OffsetDateTime
    getCreatedAt()
    Get the createdAt property: The Unix timestamp (in seconds) for when the Part was created.
    String
    getId()
    Get the id property: The upload Part unique identifier, which can be referenced in API endpoints.
    String
    getObject()
    Get the object property: The object type, which is always `upload.part`.
    String
    getUploadId()
    Get the uploadId property: The ID of the Upload object that this Part was added to.
    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 upload Part unique identifier, which can be referenced in API endpoints.
      Returns:
      the id value.

    • getCreatedAt

      public OffsetDateTime getCreatedAt()
      Get the createdAt property: The Unix timestamp (in seconds) for when the Part was created.
      Returns:
      the createdAt value.

    • getUploadId

      public String getUploadId()
      Get the uploadId property: The ID of the Upload object that this Part was added to.
      Returns:
      the uploadId value.

    • getObject

      public String getObject()
      Get the object property: The object type, which is always `upload.part`.
      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<UploadPart>
      Throws:
      IOException

    • fromJson

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

    • getAzureBlockId

      public String getAzureBlockId()
      Get the azureBlockId property: Azure only field.
      Returns:
      the azureBlockId value.