Package com.azure.ai.openai.models

Class ImageGenerations

java.lang.Object

com.azure.ai.openai.models.ImageGenerations

All Implemented Interfaces:

com.azure.json.JsonSerializable<ImageGenerations>

public final class ImageGenerations
extends Object
implements com.azure.json.JsonSerializable<ImageGenerations>

The result of a successful image generation operation.

Method Summary

Modifier and Type	Method	Description
static ImageGenerations	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ImageGenerations from the JsonReader.
OffsetDateTime	getCreatedAt()	Get the createdAt property: A timestamp representing when this operation was started.
List<ImageGenerationData>	getData()	Get the data property: The images generated by the operation.
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

getCreatedAt

public OffsetDateTime getCreatedAt()

Get the createdAt property: A timestamp representing when this operation was started. Expressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000.

Returns:

the createdAt value.

getData

public List<ImageGenerationData> getData()

Get the data property: The images generated by the operation.

Returns:

the data value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<ImageGenerations>

Throws:

IOException

fromJson

public static ImageGenerations fromJson(com.azure.json.JsonReader jsonReader)
                                 throws IOException

Reads an instance of ImageGenerations from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ImageGenerations 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 ImageGenerations.