Share via

UploadPart 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.UploadPart

Implements

JsonSerializable<UploadPart>

public final class UploadPart
implements JsonSerializable<UploadPart>

The upload Part represents a chunk of bytes we can add to an Upload object.

Method Summary

Modifier and Type Method and Description
static UploadPart fromJson(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.
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 UploadPart fromJson(JsonReader jsonReader)

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:

IOException

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

getAzureBlockId

public String getAzureBlockId()

Get the azureBlockId property: Azure only field.

Returns:

the azureBlockId value.

getCreatedAt

public OffsetDateTime getCreatedAt()

Get the createdAt property: The Unix timestamp (in seconds) for when the Part was created.

Returns:

the createdAt value.

getId

public String getId()

Get the id property: The upload Part unique identifier, which can be referenced in API endpoints.

Returns:

the id value.

getObject

public String getObject()

Get the object property: The object type, which is always `upload.part`.

Returns:

the object 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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to