ImagenModelFutures

@PublicPreviewAPI
public abstract classImagenModelFutures


Wrapper class providing Java compatible methods forImagenModel.

See also
ImagenModel

Summary

Nested types

public static classImagenModelFutures.Companion

Public methods

abstract @NonNullListenableFuture<@NonNullImagenGenerationResponse<@NonNullImagenInlineImage>>
editImage(
    @NonNullList<@NonNullImagenReferenceImage> referenceImages,
    @NonNullString prompt
)

Generates an image from a single or set of base images, returning the result directly to the caller.

abstract @NonNullListenableFuture<@NonNullImagenGenerationResponse<@NonNullImagenInlineImage>>
editImage(
    @NonNullList<@NonNullImagenReferenceImage> referenceImages,
    @NonNullString prompt,
    ImagenEditingConfig config
)

Generates an image from a single or set of base images, returning the result directly to the caller.

static final @NonNullImagenModelFutures
abstract @NonNullListenableFuture<@NonNullImagenGenerationResponse<@NonNullImagenInlineImage>>

Generates an image, returning the result directly to the caller.

abstract @NonNullImagenModel

Returns theImagenModel object wrapped by this object.

abstract @NonNullListenableFuture<@NonNullImagenGenerationResponse<@NonNullImagenInlineImage>>
inpaintImage(
    @NonNullImagenInlineImage image,
    @NonNullString prompt,
    @NonNullImagenMaskReference mask,
    @NonNullImagenEditingConfig config
)

Generates an image by inpainting a masked off part of a base image.

abstract @NonNullListenableFuture<@NonNullImagenGenerationResponse<@NonNullImagenInlineImage>>
outpaintImage(
    @NonNullImagenInlineImage image,
    @NonNullDimensions newDimensions,
    @NonNullImagenImagePlacement newPosition,
    @NonNullString prompt,
    ImagenEditingConfig config
)

Generates an image by outpainting the image, extending its borders

Public methods

editImage

public abstract @NonNullListenableFuture<@NonNullImagenGenerationResponse<@NonNullImagenInlineImage>> editImage(
    @NonNullList<@NonNullImagenReferenceImage> referenceImages,
    @NonNullString prompt
)

Generates an image from a single or set of base images, returning the result directly to the caller.

Parameters
@NonNullList<@NonNullImagenReferenceImage> referenceImages

the image inputs given to the model as a prompt

@NonNullString prompt

the text input given to the model as a prompt

editImage

public abstract @NonNullListenableFuture<@NonNullImagenGenerationResponse<@NonNullImagenInlineImage>> editImage(
    @NonNullList<@NonNullImagenReferenceImage> referenceImages,
    @NonNullString prompt,
    ImagenEditingConfig config
)

Generates an image from a single or set of base images, returning the result directly to the caller.

Parameters
@NonNullList<@NonNullImagenReferenceImage> referenceImages

the image inputs given to the model as a prompt

@NonNullString prompt

the text input given to the model as a prompt

ImagenEditingConfig config

the editing configuration settings

from

public static final @NonNullImagenModelFutures from(@NonNullImagenModel model)
Returns
@NonNullImagenModelFutures

aImagenModelFutures created around the providedImagenModel

generateImages

public abstract @NonNullListenableFuture<@NonNullImagenGenerationResponse<@NonNullImagenInlineImage>> generateImages(@NonNullString prompt)

Generates an image, returning the result directly to the caller.

Parameters
@NonNullString prompt

The main text prompt from which the image is generated.

getImageModel

public abstract @NonNullImagenModel getImageModel()

Returns theImagenModel object wrapped by this object.

inpaintImage

public abstract @NonNullListenableFuture<@NonNullImagenGenerationResponse<@NonNullImagenInlineImage>> inpaintImage(
    @NonNullImagenInlineImage image,
    @NonNullString prompt,
    @NonNullImagenMaskReference mask,
    @NonNullImagenEditingConfig config
)

Generates an image by inpainting a masked off part of a base image.

Parameters
@NonNullImagenInlineImage image

the base image

@NonNullString prompt

the text input given to the model as a prompt

@NonNullImagenMaskReference mask

the mask which defines where in the image can be painted by imagen.

@NonNullImagenEditingConfig config

the editing configuration settings, it should include anImagenEditMode

outpaintImage

public abstract @NonNullListenableFuture<@NonNullImagenGenerationResponse<@NonNullImagenInlineImage>> outpaintImage(
    @NonNullImagenInlineImage image,
    @NonNullDimensions newDimensions,
    @NonNullImagenImagePlacement newPosition,
    @NonNullString prompt,
    ImagenEditingConfig config
)

Generates an image by outpainting the image, extending its borders

Parameters
@NonNullImagenInlineImage image

the base image

@NonNullDimensions newDimensions

the new dimensions for the image,must be larger than the original image.

@NonNullImagenImagePlacement newPosition

the placement of the base image within the new image. This can either be coordinates (0,0 is the top left corner) or an alignment (ex:ImagenImagePlacement.BOTTOM_CENTER)

@NonNullString prompt

optional, but can be used to specify the background generated if context is insufficient

ImagenEditingConfig config

the editing configuration settings

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-08-08 UTC.