Package com.google.genai.types

Class GenerateImagesConfig.Builder

java.lang.Object
com.google.genai.types.GenerateImagesConfig.Builder
Enclosing class:
GenerateImagesConfig
public abstract static class GenerateImagesConfig.Builder extends Object
Builder for GenerateImagesConfig.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • httpOptions

      public abstract GenerateImagesConfig.Builder httpOptions(HttpOptions httpOptions)
      Setter for httpOptions.

      httpOptions: Used to override HTTP request options.

    • httpOptions

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder httpOptions(HttpOptions.Builder httpOptionsBuilder)
      Setter for httpOptions builder.

      httpOptions: Used to override HTTP request options.

    • clearHttpOptions

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearHttpOptions()
      Clears the value of httpOptions field.

    • outputGcsUri

      public abstract GenerateImagesConfig.Builder outputGcsUri(String outputGcsUri)
      Setter for outputGcsUri.

      outputGcsUri: Cloud Storage URI used to store the generated images.

    • clearOutputGcsUri

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearOutputGcsUri()
      Clears the value of outputGcsUri field.

    • negativePrompt

      public abstract GenerateImagesConfig.Builder negativePrompt(String negativePrompt)
      Setter for negativePrompt.

      negativePrompt: Description of what to discourage in the generated images.

    • clearNegativePrompt

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearNegativePrompt()
      Clears the value of negativePrompt field.

    • numberOfImages

      public abstract GenerateImagesConfig.Builder numberOfImages(Integer numberOfImages)
      Setter for numberOfImages.

      numberOfImages: Number of images to generate.

    • clearNumberOfImages

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearNumberOfImages()
      Clears the value of numberOfImages field.

    • aspectRatio

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

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

    • clearAspectRatio

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearAspectRatio()
      Clears the value of aspectRatio field.

    • guidanceScale

      public abstract GenerateImagesConfig.Builder guidanceScale(Float guidanceScale)
      Setter for guidanceScale.

      guidanceScale: Controls how much the model adheres to the text prompt. Large values increase output and prompt alignment, but may compromise image quality.

    • clearGuidanceScale

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearGuidanceScale()
      Clears the value of guidanceScale field.

    • seed

      public abstract GenerateImagesConfig.Builder seed(Integer seed)
      Setter for seed.

      seed: Random seed for image generation. This is not available when ``add_watermark`` is set to true.

    • clearSeed

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearSeed()
      Clears the value of seed field.

    • safetyFilterLevel

      public abstract GenerateImagesConfig.Builder safetyFilterLevel(SafetyFilterLevel safetyFilterLevel)
      Setter for safetyFilterLevel.

      safetyFilterLevel: Filter level for safety filtering.

    • clearSafetyFilterLevel

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearSafetyFilterLevel()
      Clears the value of safetyFilterLevel field.

    • safetyFilterLevel

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder safetyFilterLevel(SafetyFilterLevel.Known knownType)
      Setter for safetyFilterLevel given a known enum.

      safetyFilterLevel: Filter level for safety filtering.

    • safetyFilterLevel

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder safetyFilterLevel(String safetyFilterLevel)
      Setter for safetyFilterLevel given a string.

      safetyFilterLevel: Filter level for safety filtering.

    • personGeneration

      public abstract GenerateImagesConfig.Builder personGeneration(PersonGeneration personGeneration)
      Setter for personGeneration.

      personGeneration: Allows generation of people by the model.

    • clearPersonGeneration

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearPersonGeneration()
      Clears the value of personGeneration field.

    • personGeneration

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder personGeneration(PersonGeneration.Known knownType)
      Setter for personGeneration given a known enum.

      personGeneration: Allows generation of people by the model.

    • personGeneration

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder personGeneration(String personGeneration)
      Setter for personGeneration given a string.

      personGeneration: Allows generation of people by the model.

    • includeSafetyAttributes

      public abstract GenerateImagesConfig.Builder includeSafetyAttributes(boolean includeSafetyAttributes)
      Setter for includeSafetyAttributes.

      includeSafetyAttributes: Whether to report the safety scores of each generated image and the positive prompt in the response.

    • clearIncludeSafetyAttributes

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearIncludeSafetyAttributes()
      Clears the value of includeSafetyAttributes field.

    • includeRaiReason

      public abstract GenerateImagesConfig.Builder includeRaiReason(boolean includeRaiReason)
      Setter for includeRaiReason.

      includeRaiReason: Whether to include the Responsible AI filter reason if the image is filtered out of the response.

    • clearIncludeRaiReason

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearIncludeRaiReason()
      Clears the value of includeRaiReason field.

    • language

      public abstract GenerateImagesConfig.Builder language(ImagePromptLanguage language)
      Setter for language.

      language: Language of the text in the prompt.

    • clearLanguage

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearLanguage()
      Clears the value of language field.

    • language

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder language(ImagePromptLanguage.Known knownType)
      Setter for language given a known enum.

      language: Language of the text in the prompt.

    • language

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder language(String language)
      Setter for language given a string.

      language: Language of the text in the prompt.

    • outputMimeType

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

      outputMimeType: MIME type of the generated image.

    • clearOutputMimeType

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearOutputMimeType()
      Clears the value of outputMimeType field.

    • outputCompressionQuality

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

      outputCompressionQuality: Compression quality of the generated image (for ``image/jpeg`` only).

    • clearOutputCompressionQuality

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearOutputCompressionQuality()
      Clears the value of outputCompressionQuality field.

    • addWatermark

      public abstract GenerateImagesConfig.Builder addWatermark(boolean addWatermark)
      Setter for addWatermark.

      addWatermark: Whether to add a watermark to the generated images.

    • clearAddWatermark

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearAddWatermark()
      Clears the value of addWatermark field.

    • labels

      public abstract GenerateImagesConfig.Builder labels(Map<String,String> labels)
      Setter for labels.

      labels: User specified labels to track billing usage.

    • clearLabels

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearLabels()
      Clears the value of labels field.

    • imageSize

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

      imageSize: The size of the largest dimension of the generated image. Supported sizes are 1K and 2K (not supported for Imagen 3 models).

    • clearImageSize

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearImageSize()
      Clears the value of imageSize field.

    • enhancePrompt

      public abstract GenerateImagesConfig.Builder enhancePrompt(boolean enhancePrompt)
      Setter for enhancePrompt.

      enhancePrompt: Whether to use the prompt rewriting logic.

    • clearEnhancePrompt

      @CanIgnoreReturnValue public GenerateImagesConfig.Builder clearEnhancePrompt()
      Clears the value of enhancePrompt field.

    • build

      public abstract GenerateImagesConfig build()