Class ImageConfig.Builder

java.lang.Object
com.google.genai.types.ImageConfig.Builder
Enclosing class:
ImageConfig

public abstract static class ImageConfig.Builder extends Object
Builder for ImageConfig.
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • aspectRatio

      public abstract ImageConfig.Builder aspectRatio(String aspectRatio)
      Setter for aspectRatio.

      aspectRatio: Aspect ratio of the generated images. Supported values are "1:1", "2:3", "3:2", "3:4", "4:3", "9:16", "16:9", and "21:9".

    • clearAspectRatio

      @CanIgnoreReturnValue public ImageConfig.Builder clearAspectRatio()
      Clears the value of aspectRatio field.
    • imageSize

      public abstract ImageConfig.Builder imageSize(String imageSize)
      Setter for imageSize.

      imageSize: Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.

    • clearImageSize

      @CanIgnoreReturnValue public ImageConfig.Builder clearImageSize()
      Clears the value of imageSize field.
    • personGeneration

      public abstract ImageConfig.Builder personGeneration(String personGeneration)
      Setter for personGeneration.

      personGeneration: Controls the generation of people. Supported values are: ALLOW_ALL, ALLOW_ADULT, ALLOW_NONE.

    • clearPersonGeneration

      @CanIgnoreReturnValue public ImageConfig.Builder clearPersonGeneration()
      Clears the value of personGeneration field.
    • prominentPeople

      public abstract ImageConfig.Builder prominentPeople(ProminentPeople prominentPeople)
      Setter for prominentPeople.

      prominentPeople: Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.

    • clearProminentPeople

      @CanIgnoreReturnValue public ImageConfig.Builder clearProminentPeople()
      Clears the value of prominentPeople field.
    • prominentPeople

      @CanIgnoreReturnValue public ImageConfig.Builder prominentPeople(ProminentPeople.Known knownType)
      Setter for prominentPeople given a known enum.

      prominentPeople: Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.

    • prominentPeople

      @CanIgnoreReturnValue public ImageConfig.Builder prominentPeople(String prominentPeople)
      Setter for prominentPeople given a string.

      prominentPeople: Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.

    • outputMimeType

      public abstract ImageConfig.Builder outputMimeType(String outputMimeType)
      Setter for outputMimeType.

      outputMimeType: MIME type of the generated image. This field is not supported in Gemini API.

    • clearOutputMimeType

      @CanIgnoreReturnValue public ImageConfig.Builder clearOutputMimeType()
      Clears the value of outputMimeType field.
    • outputCompressionQuality

      public abstract ImageConfig.Builder outputCompressionQuality(Integer outputCompressionQuality)
      Setter for outputCompressionQuality.

      outputCompressionQuality: Compression quality of the generated image (for ``image/jpeg`` only). This field is not supported in Gemini API.

    • clearOutputCompressionQuality

      @CanIgnoreReturnValue public ImageConfig.Builder clearOutputCompressionQuality()
      Clears the value of outputCompressionQuality field.
    • imageOutputOptions

      public abstract ImageConfig.Builder imageOutputOptions(ImageConfigImageOutputOptions imageOutputOptions)
      Setter for imageOutputOptions.

      imageOutputOptions: Optional. The image output format for generated images.

    • imageOutputOptions

      @CanIgnoreReturnValue public ImageConfig.Builder imageOutputOptions(ImageConfigImageOutputOptions.Builder imageOutputOptionsBuilder)
      Setter for imageOutputOptions builder.

      imageOutputOptions: Optional. The image output format for generated images.

    • clearImageOutputOptions

      @CanIgnoreReturnValue public ImageConfig.Builder clearImageOutputOptions()
      Clears the value of imageOutputOptions field.
    • build

      public abstract ImageConfig build()