Constructor Detail

• GenerateImagesConfig.Builder

  GenerateImagesConfig.Builder()

Method Detail

• httpOptions

   abstract GenerateImagesConfig.Builder httpOptions(HttpOptions httpOptions)

  Setter for httpOptions.

  httpOptions: Used to override HTTP request options.

• httpOptions

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder httpOptions(HttpOptions.Builder httpOptionsBuilder)

  Setter for httpOptions builder.

  httpOptions: Used to override HTTP request options.

• clearHttpOptions

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder clearHttpOptions()

  Clears the value of httpOptions field.

• outputGcsUri

   abstract GenerateImagesConfig.Builder outputGcsUri(String outputGcsUri)

  Setter for outputGcsUri.

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

• clearOutputGcsUri

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder clearOutputGcsUri()

  Clears the value of outputGcsUri field.

• negativePrompt

   abstract GenerateImagesConfig.Builder negativePrompt(String negativePrompt)

  Setter for negativePrompt.

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

• clearNegativePrompt

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder clearNegativePrompt()

  Clears the value of negativePrompt field.

• numberOfImages

   abstract GenerateImagesConfig.Builder numberOfImages(Integer numberOfImages)

  Setter for numberOfImages.

  numberOfImages: Number of images to generate.

• clearNumberOfImages

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder clearNumberOfImages()

  Clears the value of numberOfImages field.

• aspectRatio

   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() GenerateImagesConfig.Builder clearAspectRatio()

  Clears the value of aspectRatio field.

• guidanceScale

   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() GenerateImagesConfig.Builder clearGuidanceScale()

  Clears the value of guidanceScale field.

• seed

   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() GenerateImagesConfig.Builder clearSeed()

  Clears the value of seed field.

• safetyFilterLevel

   abstract GenerateImagesConfig.Builder safetyFilterLevel(SafetyFilterLevel safetyFilterLevel)

  Setter for safetyFilterLevel.

  safetyFilterLevel: Filter level for safety filtering.

• clearSafetyFilterLevel

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder clearSafetyFilterLevel()

  Clears the value of safetyFilterLevel field.

• safetyFilterLevel

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder safetyFilterLevel(SafetyFilterLevel.Known knownType)

  Setter for safetyFilterLevel given a known enum.

  safetyFilterLevel: Filter level for safety filtering.

• safetyFilterLevel

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder safetyFilterLevel(String safetyFilterLevel)

  Setter for safetyFilterLevel given a string.

  safetyFilterLevel: Filter level for safety filtering.

• personGeneration

   abstract GenerateImagesConfig.Builder personGeneration(PersonGeneration personGeneration)

  Setter for personGeneration.

  personGeneration: Allows generation of people by the model.

• clearPersonGeneration

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder clearPersonGeneration()

  Clears the value of personGeneration field.

• personGeneration

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder personGeneration(PersonGeneration.Known knownType)

  Setter for personGeneration given a known enum.

  personGeneration: Allows generation of people by the model.

• personGeneration

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder personGeneration(String personGeneration)

  Setter for personGeneration given a string.

  personGeneration: Allows generation of people by the model.

• includeSafetyAttributes

   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() GenerateImagesConfig.Builder clearIncludeSafetyAttributes()

  Clears the value of includeSafetyAttributes field.

• includeRaiReason

   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() GenerateImagesConfig.Builder clearIncludeRaiReason()

  Clears the value of includeRaiReason field.

• language

   abstract GenerateImagesConfig.Builder language(ImagePromptLanguage language)

  Setter for language.

  language: Language of the text in the prompt.

• clearLanguage

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder clearLanguage()

  Clears the value of language field.

• language

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder language(ImagePromptLanguage.Known knownType)

  Setter for language given a known enum.

  language: Language of the text in the prompt.

• language

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder language(String language)

  Setter for language given a string.

  language: Language of the text in the prompt.

• outputMimeType

   abstract GenerateImagesConfig.Builder outputMimeType(String outputMimeType)

  Setter for outputMimeType.

  outputMimeType: MIME type of the generated image.

• clearOutputMimeType

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder clearOutputMimeType()

  Clears the value of outputMimeType field.

• outputCompressionQuality

   abstract GenerateImagesConfig.Builder outputCompressionQuality(Integer outputCompressionQuality)

  Setter for outputCompressionQuality.

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

• clearOutputCompressionQuality

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder clearOutputCompressionQuality()

  Clears the value of outputCompressionQuality field.

• addWatermark

   abstract GenerateImagesConfig.Builder addWatermark(boolean addWatermark)

  Setter for addWatermark.

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

• clearAddWatermark

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder clearAddWatermark()

  Clears the value of addWatermark field.

• labels

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

  Setter for labels.

  labels: User specified labels to track billing usage.

• clearLabels

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder clearLabels()

  Clears the value of labels field.

• imageSize

   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() GenerateImagesConfig.Builder clearImageSize()

  Clears the value of imageSize field.

• enhancePrompt

   abstract GenerateImagesConfig.Builder enhancePrompt(boolean enhancePrompt)

  Setter for enhancePrompt.

  enhancePrompt: Whether to use the prompt rewriting logic.

• clearEnhancePrompt

  @CanIgnoreReturnValue() GenerateImagesConfig.Builder clearEnhancePrompt()

  Clears the value of enhancePrompt field.

• build

   abstract GenerateImagesConfig build()