Class GenerateProductTextSuggestionsRequest (0.2.0)

public final class GenerateProductTextSuggestionsRequest extends GeneratedMessageV3 implements GenerateProductTextSuggestionsRequestOrBuilder

Request message for the GenerateProductTextSuggestions method.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GenerateProductTextSuggestionsRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_SPEC_FIELD_NUMBER

public static final int OUTPUT_SPEC_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_INFO_FIELD_NUMBER

public static final int PRODUCT_INFO_FIELD_NUMBER
Field Value
Type Description
int

TITLE_EXAMPLES_FIELD_NUMBER

public static final int TITLE_EXAMPLES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GenerateProductTextSuggestionsRequest getDefaultInstance()
Returns
Type Description
GenerateProductTextSuggestionsRequest

getDescriptor()

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

newBuilder()

public static GenerateProductTextSuggestionsRequest.Builder newBuilder()
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

newBuilder(GenerateProductTextSuggestionsRequest prototype)

public static GenerateProductTextSuggestionsRequest.Builder newBuilder(GenerateProductTextSuggestionsRequest prototype)
Parameter
Name Description
prototype GenerateProductTextSuggestionsRequest
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

parseDelimitedFrom(InputStream input)

public static GenerateProductTextSuggestionsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GenerateProductTextSuggestionsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateProductTextSuggestionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateProductTextSuggestionsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GenerateProductTextSuggestionsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GenerateProductTextSuggestionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GenerateProductTextSuggestionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateProductTextSuggestionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GenerateProductTextSuggestionsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GenerateProductTextSuggestionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GenerateProductTextSuggestionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateProductTextSuggestionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GenerateProductTextSuggestionsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GenerateProductTextSuggestionsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateProductTextSuggestionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateProductTextSuggestionsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GenerateProductTextSuggestionsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GenerateProductTextSuggestionsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateProductTextSuggestionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateProductTextSuggestionsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GenerateProductTextSuggestionsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GenerateProductTextSuggestionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GenerateProductTextSuggestionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateProductTextSuggestionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GenerateProductTextSuggestionsRequest> parser()
Returns
Type Description
Parser<GenerateProductTextSuggestionsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public GenerateProductTextSuggestionsRequest getDefaultInstanceForType()
Returns
Type Description
GenerateProductTextSuggestionsRequest

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.

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

getParserForType()

public Parser<GenerateProductTextSuggestionsRequest> getParserForType()
Returns
Type Description
Parser<GenerateProductTextSuggestionsRequest>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GenerateProductTextSuggestionsRequest.Builder newBuilderForType()
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GenerateProductTextSuggestionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GenerateProductTextSuggestionsRequest.Builder toBuilder()
Returns
Type Description
GenerateProductTextSuggestionsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException