Class GenerateProductTextSuggestionsRequest.Builder (0.2.0)

public static final class GenerateProductTextSuggestionsRequest.Builder extends GeneratedMessageV3.Builder<GenerateProductTextSuggestionsRequest.Builder> implements GenerateProductTextSuggestionsRequestOrBuilder

Request message for the GenerateProductTextSuggestions method.

Protobuf type google.shopping.merchant.productstudio.v1alpha.GenerateProductTextSuggestionsRequest

Static Methods

getDescriptor()

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

Methods

addAllTitleExamples(Iterable<? extends TitleExample> values)

public GenerateProductTextSuggestionsRequest.Builder addAllTitleExamples(Iterable<? extends TitleExample> values)

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.shopping.merchant.productstudio.v1alpha.TitleExample>
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GenerateProductTextSuggestionsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder
Overrides

addTitleExamples(TitleExample value)

public GenerateProductTextSuggestionsRequest.Builder addTitleExamples(TitleExample value)

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value TitleExample
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

addTitleExamples(TitleExample.Builder builderForValue)

public GenerateProductTextSuggestionsRequest.Builder addTitleExamples(TitleExample.Builder builderForValue)

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue TitleExample.Builder
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

addTitleExamples(int index, TitleExample value)

public GenerateProductTextSuggestionsRequest.Builder addTitleExamples(int index, TitleExample value)

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value TitleExample
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

addTitleExamples(int index, TitleExample.Builder builderForValue)

public GenerateProductTextSuggestionsRequest.Builder addTitleExamples(int index, TitleExample.Builder builderForValue)

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue TitleExample.Builder
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

addTitleExamplesBuilder()

public TitleExample.Builder addTitleExamplesBuilder()

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TitleExample.Builder

addTitleExamplesBuilder(int index)

public TitleExample.Builder addTitleExamplesBuilder(int index)

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TitleExample.Builder

build()

public GenerateProductTextSuggestionsRequest build()
Returns
Type Description
GenerateProductTextSuggestionsRequest

buildPartial()

public GenerateProductTextSuggestionsRequest buildPartial()
Returns
Type Description
GenerateProductTextSuggestionsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

public GenerateProductTextSuggestionsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder
Overrides

clearName()

public GenerateProductTextSuggestionsRequest.Builder clearName()

Required. The name of the account to generate text suggestions for. This acts as a container for the request and does not affect the generation itself, as this is a stateless API. Format: accounts/{account}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GenerateProductTextSuggestionsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder
Overrides

clearOutputSpec()

public GenerateProductTextSuggestionsRequest.Builder clearOutputSpec()

Optional. Configuration parameters that directly influence what content is generated, and how that content is rendered in the final response.

optional .google.shopping.merchant.productstudio.v1alpha.OutputSpec output_spec = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

clearProductInfo()

public GenerateProductTextSuggestionsRequest.Builder clearProductInfo()

Required. Available information about the product. Used to inform the genAI models.

.google.shopping.merchant.productstudio.v1alpha.ProductInfo product_info = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

clearTitleExamples()

public GenerateProductTextSuggestionsRequest.Builder clearTitleExamples()

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

clone()

public GenerateProductTextSuggestionsRequest.Builder clone()
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder
Overrides

getDefaultInstanceForType()

public GenerateProductTextSuggestionsRequest getDefaultInstanceForType()
Returns
Type Description
GenerateProductTextSuggestionsRequest

getDescriptorForType()

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

getName()

public String getName()

Required. The name of the account to generate text suggestions for. This acts as a container for the request and does not affect the generation itself, as this is a stateless API. Format: accounts/{account}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the account to generate text suggestions for. This acts as a container for the request and does not affect the generation itself, as this is a stateless API. Format: accounts/{account}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getOutputSpec()

public OutputSpec getOutputSpec()

Optional. Configuration parameters that directly influence what content is generated, and how that content is rendered in the final response.

optional .google.shopping.merchant.productstudio.v1alpha.OutputSpec output_spec = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputSpec

The outputSpec.

getOutputSpecBuilder()

public OutputSpec.Builder getOutputSpecBuilder()

Optional. Configuration parameters that directly influence what content is generated, and how that content is rendered in the final response.

optional .google.shopping.merchant.productstudio.v1alpha.OutputSpec output_spec = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputSpec.Builder

getOutputSpecOrBuilder()

public OutputSpecOrBuilder getOutputSpecOrBuilder()

Optional. Configuration parameters that directly influence what content is generated, and how that content is rendered in the final response.

optional .google.shopping.merchant.productstudio.v1alpha.OutputSpec output_spec = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputSpecOrBuilder

getProductInfo()

public ProductInfo getProductInfo()

Required. Available information about the product. Used to inform the genAI models.

.google.shopping.merchant.productstudio.v1alpha.ProductInfo product_info = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProductInfo

The productInfo.

getProductInfoBuilder()

public ProductInfo.Builder getProductInfoBuilder()

Required. Available information about the product. Used to inform the genAI models.

.google.shopping.merchant.productstudio.v1alpha.ProductInfo product_info = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProductInfo.Builder

getProductInfoOrBuilder()

public ProductInfoOrBuilder getProductInfoOrBuilder()

Required. Available information about the product. Used to inform the genAI models.

.google.shopping.merchant.productstudio.v1alpha.ProductInfo product_info = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProductInfoOrBuilder

getTitleExamples(int index)

public TitleExample getTitleExamples(int index)

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TitleExample

getTitleExamplesBuilder(int index)

public TitleExample.Builder getTitleExamplesBuilder(int index)

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TitleExample.Builder

getTitleExamplesBuilderList()

public List<TitleExample.Builder> getTitleExamplesBuilderList()

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getTitleExamplesCount()

public int getTitleExamplesCount()

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getTitleExamplesList()

public List<TitleExample> getTitleExamplesList()

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<TitleExample>

getTitleExamplesOrBuilder(int index)

public TitleExampleOrBuilder getTitleExamplesOrBuilder(int index)

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TitleExampleOrBuilder

getTitleExamplesOrBuilderList()

public List<? extends TitleExampleOrBuilder> getTitleExamplesOrBuilderList()

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.shopping.merchant.productstudio.v1alpha.TitleExampleOrBuilder>

hasOutputSpec()

public boolean hasOutputSpec()

Optional. Configuration parameters that directly influence what content is generated, and how that content is rendered in the final response.

optional .google.shopping.merchant.productstudio.v1alpha.OutputSpec output_spec = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the outputSpec field is set.

hasProductInfo()

public boolean hasProductInfo()

Required. Available information about the product. Used to inform the genAI models.

.google.shopping.merchant.productstudio.v1alpha.ProductInfo product_info = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the productInfo field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(GenerateProductTextSuggestionsRequest other)

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

mergeOutputSpec(OutputSpec value)

public GenerateProductTextSuggestionsRequest.Builder mergeOutputSpec(OutputSpec value)

Optional. Configuration parameters that directly influence what content is generated, and how that content is rendered in the final response.

optional .google.shopping.merchant.productstudio.v1alpha.OutputSpec output_spec = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value OutputSpec
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

mergeProductInfo(ProductInfo value)

public GenerateProductTextSuggestionsRequest.Builder mergeProductInfo(ProductInfo value)

Required. Available information about the product. Used to inform the genAI models.

.google.shopping.merchant.productstudio.v1alpha.ProductInfo product_info = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ProductInfo
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GenerateProductTextSuggestionsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder
Overrides

removeTitleExamples(int index)

public GenerateProductTextSuggestionsRequest.Builder removeTitleExamples(int index)

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public GenerateProductTextSuggestionsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder
Overrides

setName(String value)

public GenerateProductTextSuggestionsRequest.Builder setName(String value)

Required. The name of the account to generate text suggestions for. This acts as a container for the request and does not affect the generation itself, as this is a stateless API. Format: accounts/{account}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GenerateProductTextSuggestionsRequest.Builder setNameBytes(ByteString value)

Required. The name of the account to generate text suggestions for. This acts as a container for the request and does not affect the generation itself, as this is a stateless API. Format: accounts/{account}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

This builder for chaining.

setOutputSpec(OutputSpec value)

public GenerateProductTextSuggestionsRequest.Builder setOutputSpec(OutputSpec value)

Optional. Configuration parameters that directly influence what content is generated, and how that content is rendered in the final response.

optional .google.shopping.merchant.productstudio.v1alpha.OutputSpec output_spec = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value OutputSpec
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

setOutputSpec(OutputSpec.Builder builderForValue)

public GenerateProductTextSuggestionsRequest.Builder setOutputSpec(OutputSpec.Builder builderForValue)

Optional. Configuration parameters that directly influence what content is generated, and how that content is rendered in the final response.

optional .google.shopping.merchant.productstudio.v1alpha.OutputSpec output_spec = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue OutputSpec.Builder
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

setProductInfo(ProductInfo value)

public GenerateProductTextSuggestionsRequest.Builder setProductInfo(ProductInfo value)

Required. Available information about the product. Used to inform the genAI models.

.google.shopping.merchant.productstudio.v1alpha.ProductInfo product_info = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ProductInfo
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

setProductInfo(ProductInfo.Builder builderForValue)

public GenerateProductTextSuggestionsRequest.Builder setProductInfo(ProductInfo.Builder builderForValue)

Required. Available information about the product. Used to inform the genAI models.

.google.shopping.merchant.productstudio.v1alpha.ProductInfo product_info = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue ProductInfo.Builder
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GenerateProductTextSuggestionsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder
Overrides

setTitleExamples(int index, TitleExample value)

public GenerateProductTextSuggestionsRequest.Builder setTitleExamples(int index, TitleExample value)

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value TitleExample
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

setTitleExamples(int index, TitleExample.Builder builderForValue)

public GenerateProductTextSuggestionsRequest.Builder setTitleExamples(int index, TitleExample.Builder builderForValue)

Optional. Provide some hand-crafted examples of title improvements that are unique to your use case. This is a general tool that handles multiple product categories, but your brand identity may require custom functionality. Feel free to specify that here.

repeated .google.shopping.merchant.productstudio.v1alpha.TitleExample title_examples = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue TitleExample.Builder
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final GenerateProductTextSuggestionsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder
Overrides