Class ImageConfig.Builder (3.86.0)

public static final class ImageConfig.Builder extends GeneratedMessage.Builder<ImageConfig.Builder> implements ImageConfigOrBuilder

Config for image generation features.

Protobuf type google.cloud.aiplatform.v1.ImageConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ImageConfig build()
Returns
Type Description
ImageConfig

buildPartial()

public ImageConfig buildPartial()
Returns
Type Description
ImageConfig

clear()

public ImageConfig.Builder clear()
Returns
Type Description
ImageConfig.Builder
Overrides

clearAspectRatio()

public ImageConfig.Builder clearAspectRatio()

Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported:

"1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"

optional string aspect_ratio = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImageConfig.Builder

This builder for chaining.

clearImageOutputOptions()

public ImageConfig.Builder clearImageOutputOptions()

Optional. The image output format for generated images.

optional .google.cloud.aiplatform.v1.ImageConfig.ImageOutputOptions image_output_options = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImageConfig.Builder

clearImageSize()

public ImageConfig.Builder clearImageSize()

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

optional string image_size = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImageConfig.Builder

This builder for chaining.

clearPersonGeneration()

public ImageConfig.Builder clearPersonGeneration()

Optional. Controls whether the model can generate people.

optional .google.cloud.aiplatform.v1.ImageConfig.PersonGeneration person_generation = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImageConfig.Builder

This builder for chaining.

getAspectRatio()

public String getAspectRatio()

Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported:

"1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"

optional string aspect_ratio = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The aspectRatio.

getAspectRatioBytes()

public ByteString getAspectRatioBytes()

Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported:

"1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"

optional string aspect_ratio = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for aspectRatio.

getDefaultInstanceForType()

public ImageConfig getDefaultInstanceForType()
Returns
Type Description
ImageConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getImageOutputOptions()

public ImageConfig.ImageOutputOptions getImageOutputOptions()

Optional. The image output format for generated images.

optional .google.cloud.aiplatform.v1.ImageConfig.ImageOutputOptions image_output_options = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImageConfig.ImageOutputOptions

The imageOutputOptions.

getImageOutputOptionsBuilder()

public ImageConfig.ImageOutputOptions.Builder getImageOutputOptionsBuilder()

Optional. The image output format for generated images.

optional .google.cloud.aiplatform.v1.ImageConfig.ImageOutputOptions image_output_options = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImageConfig.ImageOutputOptions.Builder

getImageOutputOptionsOrBuilder()

public ImageConfig.ImageOutputOptionsOrBuilder getImageOutputOptionsOrBuilder()

Optional. The image output format for generated images.

optional .google.cloud.aiplatform.v1.ImageConfig.ImageOutputOptions image_output_options = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImageConfig.ImageOutputOptionsOrBuilder

getImageSize()

public String getImageSize()

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

optional string image_size = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The imageSize.

getImageSizeBytes()

public ByteString getImageSizeBytes()

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

optional string image_size = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for imageSize.

getPersonGeneration()

public ImageConfig.PersonGeneration getPersonGeneration()

Optional. Controls whether the model can generate people.

optional .google.cloud.aiplatform.v1.ImageConfig.PersonGeneration person_generation = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImageConfig.PersonGeneration

The personGeneration.

getPersonGenerationValue()

public int getPersonGenerationValue()

Optional. Controls whether the model can generate people.

optional .google.cloud.aiplatform.v1.ImageConfig.PersonGeneration person_generation = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for personGeneration.

hasAspectRatio()

public boolean hasAspectRatio()

Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported:

"1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"

optional string aspect_ratio = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the aspectRatio field is set.

hasImageOutputOptions()

public boolean hasImageOutputOptions()

Optional. The image output format for generated images.

optional .google.cloud.aiplatform.v1.ImageConfig.ImageOutputOptions image_output_options = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the imageOutputOptions field is set.

hasImageSize()

public boolean hasImageSize()

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

optional string image_size = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the imageSize field is set.

hasPersonGeneration()

public boolean hasPersonGeneration()

Optional. Controls whether the model can generate people.

optional .google.cloud.aiplatform.v1.ImageConfig.PersonGeneration person_generation = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the personGeneration field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ImageConfig other)

public ImageConfig.Builder mergeFrom(ImageConfig other)
Parameter
Name Description
other ImageConfig
Returns
Type Description
ImageConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ImageConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImageConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ImageConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ImageConfig.Builder
Overrides

mergeImageOutputOptions(ImageConfig.ImageOutputOptions value)

public ImageConfig.Builder mergeImageOutputOptions(ImageConfig.ImageOutputOptions value)

Optional. The image output format for generated images.

optional .google.cloud.aiplatform.v1.ImageConfig.ImageOutputOptions image_output_options = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ImageConfig.ImageOutputOptions
Returns
Type Description
ImageConfig.Builder

setAspectRatio(String value)

public ImageConfig.Builder setAspectRatio(String value)

Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported:

"1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"

optional string aspect_ratio = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The aspectRatio to set.

Returns
Type Description
ImageConfig.Builder

This builder for chaining.

setAspectRatioBytes(ByteString value)

public ImageConfig.Builder setAspectRatioBytes(ByteString value)

Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported:

"1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"

optional string aspect_ratio = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for aspectRatio to set.

Returns
Type Description
ImageConfig.Builder

This builder for chaining.

setImageOutputOptions(ImageConfig.ImageOutputOptions value)

public ImageConfig.Builder setImageOutputOptions(ImageConfig.ImageOutputOptions value)

Optional. The image output format for generated images.

optional .google.cloud.aiplatform.v1.ImageConfig.ImageOutputOptions image_output_options = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ImageConfig.ImageOutputOptions
Returns
Type Description
ImageConfig.Builder

setImageOutputOptions(ImageConfig.ImageOutputOptions.Builder builderForValue)

public ImageConfig.Builder setImageOutputOptions(ImageConfig.ImageOutputOptions.Builder builderForValue)

Optional. The image output format for generated images.

optional .google.cloud.aiplatform.v1.ImageConfig.ImageOutputOptions image_output_options = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ImageConfig.ImageOutputOptions.Builder
Returns
Type Description
ImageConfig.Builder

setImageSize(String value)

public ImageConfig.Builder setImageSize(String value)

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

optional string image_size = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The imageSize to set.

Returns
Type Description
ImageConfig.Builder

This builder for chaining.

setImageSizeBytes(ByteString value)

public ImageConfig.Builder setImageSizeBytes(ByteString value)

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

optional string image_size = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for imageSize to set.

Returns
Type Description
ImageConfig.Builder

This builder for chaining.

setPersonGeneration(ImageConfig.PersonGeneration value)

public ImageConfig.Builder setPersonGeneration(ImageConfig.PersonGeneration value)

Optional. Controls whether the model can generate people.

optional .google.cloud.aiplatform.v1.ImageConfig.PersonGeneration person_generation = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ImageConfig.PersonGeneration

The personGeneration to set.

Returns
Type Description
ImageConfig.Builder

This builder for chaining.

setPersonGenerationValue(int value)

public ImageConfig.Builder setPersonGenerationValue(int value)

Optional. Controls whether the model can generate people.

optional .google.cloud.aiplatform.v1.ImageConfig.PersonGeneration person_generation = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for personGeneration to set.

Returns
Type Description
ImageConfig.Builder

This builder for chaining.