Class ImageEditStreamEvent
-
- All Implemented Interfaces:
public final class ImageEditStreamEventEmitted when a partial image is available during image editing streaming.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceImageEditStreamEvent.VisitorAn interface that defines how to map each variant of ImageEditStreamEvent to a value of type T.
-
Method Summary
Modifier and Type Method Description final Optional<ImageEditPartialImageEvent>partialImage()Emitted when a partial image is available during image editing streaming. final Optional<ImageEditCompletedEvent>completed()Emitted when image editing has completed and the final image is available. final BooleanisPartialImage()final BooleanisCompleted()final ImageEditPartialImageEventasPartialImage()Emitted when a partial image is available during image editing streaming. final ImageEditCompletedEventasCompleted()Emitted when image editing has completed and the final image is available. final Optional<JsonValue>_json()final <T extends Any> Taccept(ImageEditStreamEvent.Visitor<T> visitor)Maps this instance's current variant to a value of type T using the given visitor. final ImageEditStreamEventvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ImageEditStreamEventofPartialImage(ImageEditPartialImageEvent partialImage)Emitted when a partial image is available during image editing streaming. final static ImageEditStreamEventofCompleted(ImageEditCompletedEvent completed)Emitted when image editing has completed and the final image is available. -
-
Method Detail
-
partialImage
final Optional<ImageEditPartialImageEvent> partialImage()
Emitted when a partial image is available during image editing streaming.
-
completed
final Optional<ImageEditCompletedEvent> completed()
Emitted when image editing has completed and the final image is available.
-
isPartialImage
final Boolean isPartialImage()
-
isCompleted
final Boolean isCompleted()
-
asPartialImage
final ImageEditPartialImageEvent asPartialImage()
Emitted when a partial image is available during image editing streaming.
-
asCompleted
final ImageEditCompletedEvent asCompleted()
Emitted when image editing has completed and the final image is available.
-
accept
final <T extends Any> T accept(ImageEditStreamEvent.Visitor<T> visitor)
Maps this instance's current variant to a value of type T using the given visitor.
Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:
import com.openai.core.JsonValue; import java.util.Optional; Optional<String> result = imageEditStreamEvent.accept(new ImageEditStreamEvent.Visitor<Optional<String>>() { @Override public Optional<String> visitPartialImage(ImageEditPartialImageEvent partialImage) { return Optional.of(partialImage.toString()); } // ... @Override public Optional<String> unknown(JsonValue json) { // Or inspect the `json`. return Optional.empty(); } });
-
validate
final ImageEditStreamEvent validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
ofPartialImage
final static ImageEditStreamEvent ofPartialImage(ImageEditPartialImageEvent partialImage)
Emitted when a partial image is available during image editing streaming.
-
ofCompleted
final static ImageEditStreamEvent ofCompleted(ImageEditCompletedEvent completed)
Emitted when image editing has completed and the final image is available.
-
-
-
-