Class OutputSpec.Builder (0.2.0) 

public static final class OutputSpec.Builder extends GeneratedMessageV3.Builder<OutputSpec.Builder> implements OutputSpecOrBuilder

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

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > OutputSpec.Builder

Implements

OutputSpecOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllAttributeOrder(Iterable<String> values)

public OutputSpec.Builder addAllAttributeOrder(Iterable<String> values)

Optional. The order that generated attributes should be placed in the generated title. Eg., if the attribute order is ["brand", "product", "size"], the generated title will have brand first, followed by the product name, and then size information after that.

repeated string attribute_order = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The attributeOrder to add.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.

addAttributeOrder(String value)

public OutputSpec.Builder addAttributeOrder(String value)

Optional. The order that generated attributes should be placed in the generated title. Eg., if the attribute order is ["brand", "product", "size"], the generated title will have brand first, followed by the product name, and then size information after that.

repeated string attribute_order = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The attributeOrder to add.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.

addAttributeOrderBytes(ByteString value)

public OutputSpec.Builder addAttributeOrderBytes(ByteString value)

Optional. The order that generated attributes should be placed in the generated title. Eg., if the attribute order is ["brand", "product", "size"], the generated title will have brand first, followed by the product name, and then size information after that.

repeated string attribute_order = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the attributeOrder to add.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public OutputSpec build()
Returns
Type Description
OutputSpec

buildPartial()

public OutputSpec buildPartial()
Returns
Type Description
OutputSpec

clear()

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

clearAttributeOrder()

public OutputSpec.Builder clearAttributeOrder()

Optional. The order that generated attributes should be placed in the generated title. Eg., if the attribute order is ["brand", "product", "size"], the generated title will have brand first, followed by the product name, and then size information after that.

repeated string attribute_order = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputSpec.Builder

This builder for chaining.

clearAttributeSeparator()

public OutputSpec.Builder clearAttributeSeparator()

Optional. Character used to separate attributes in the generated title. For example, '|', '-', ','.

optional string attribute_separator = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputSpec.Builder

This builder for chaining.

clearEditorialChanges()

public OutputSpec.Builder clearEditorialChanges()

Optional. Any editorial changes for the generated product data. For example, replace Small with "S", do not modify color if already present.

optional string editorial_changes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputSpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearTargetLanguage()

public OutputSpec.Builder clearTargetLanguage()

Optional. The language for output titles/descriptions. For example. 'German', 'es', 'FR'. Default is 'en'.

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

Returns
Type Description
OutputSpec.Builder

This builder for chaining.

clearTone()

public OutputSpec.Builder clearTone()

Optional. The tone of the output generated text. Supported tones are: "playful", "formal", "persuasive", and "conversational"

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

Returns
Type Description
OutputSpec.Builder

This builder for chaining.

clearWorkflowId()

public OutputSpec.Builder clearWorkflowId()

Optional. The workflow to execute for the provided product data. Workflows may populate the response's title, description, or both. Currently supported workflow_ids are: "title", "description", and "tide"

optional string workflow_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputSpec.Builder

This builder for chaining.

clone()

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

getAttributeOrder(int index)

public String getAttributeOrder(int index)

Optional. The order that generated attributes should be placed in the generated title. Eg., if the attribute order is ["brand", "product", "size"], the generated title will have brand first, followed by the product name, and then size information after that.

repeated string attribute_order = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The attributeOrder at the given index.

getAttributeOrderBytes(int index)

public ByteString getAttributeOrderBytes(int index)

Optional. The order that generated attributes should be placed in the generated title. Eg., if the attribute order is ["brand", "product", "size"], the generated title will have brand first, followed by the product name, and then size information after that.

repeated string attribute_order = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the attributeOrder at the given index.

getAttributeOrderCount()

public int getAttributeOrderCount()

Optional. The order that generated attributes should be placed in the generated title. Eg., if the attribute order is ["brand", "product", "size"], the generated title will have brand first, followed by the product name, and then size information after that.

repeated string attribute_order = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of attributeOrder.

getAttributeOrderList()

public ProtocolStringList getAttributeOrderList()

Optional. The order that generated attributes should be placed in the generated title. Eg., if the attribute order is ["brand", "product", "size"], the generated title will have brand first, followed by the product name, and then size information after that.

repeated string attribute_order = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the attributeOrder.

getAttributeSeparator()

public String getAttributeSeparator()

Optional. Character used to separate attributes in the generated title. For example, '|', '-', ','.

optional string attribute_separator = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The attributeSeparator.

getAttributeSeparatorBytes()

public ByteString getAttributeSeparatorBytes()

Optional. Character used to separate attributes in the generated title. For example, '|', '-', ','.

optional string attribute_separator = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for attributeSeparator.

getDefaultInstanceForType()

public OutputSpec getDefaultInstanceForType()
Returns
Type Description
OutputSpec

getDescriptorForType()

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

getEditorialChanges()

public String getEditorialChanges()

Optional. Any editorial changes for the generated product data. For example, replace Small with "S", do not modify color if already present.

optional string editorial_changes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The editorialChanges.

getEditorialChangesBytes()

public ByteString getEditorialChangesBytes()

Optional. Any editorial changes for the generated product data. For example, replace Small with "S", do not modify color if already present.

optional string editorial_changes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for editorialChanges.

getTargetLanguage()

public String getTargetLanguage()

Optional. The language for output titles/descriptions. For example. 'German', 'es', 'FR'. Default is 'en'.

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

Returns
Type Description
String

The targetLanguage.

getTargetLanguageBytes()

public ByteString getTargetLanguageBytes()

Optional. The language for output titles/descriptions. For example. 'German', 'es', 'FR'. Default is 'en'.

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

Returns
Type Description
ByteString

The bytes for targetLanguage.

getTone()

public String getTone()

Optional. The tone of the output generated text. Supported tones are: "playful", "formal", "persuasive", and "conversational"

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

Returns
Type Description
String

The tone.

getToneBytes()

public ByteString getToneBytes()

Optional. The tone of the output generated text. Supported tones are: "playful", "formal", "persuasive", and "conversational"

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

Returns
Type Description
ByteString

The bytes for tone.

getWorkflowId()

public String getWorkflowId()

Optional. The workflow to execute for the provided product data. Workflows may populate the response's title, description, or both. Currently supported workflow_ids are: "title", "description", and "tide"

optional string workflow_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The workflowId.

getWorkflowIdBytes()

public ByteString getWorkflowIdBytes()

Optional. The workflow to execute for the provided product data. Workflows may populate the response's title, description, or both. Currently supported workflow_ids are: "title", "description", and "tide"

optional string workflow_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for workflowId.

hasAttributeSeparator()

public boolean hasAttributeSeparator()

Optional. Character used to separate attributes in the generated title. For example, '|', '-', ','.

optional string attribute_separator = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the attributeSeparator field is set.

hasEditorialChanges()

public boolean hasEditorialChanges()

Optional. Any editorial changes for the generated product data. For example, replace Small with "S", do not modify color if already present.

optional string editorial_changes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the editorialChanges field is set.

hasTargetLanguage()

public boolean hasTargetLanguage()

Optional. The language for output titles/descriptions. For example. 'German', 'es', 'FR'. Default is 'en'.

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

Returns
Type Description
boolean

Whether the targetLanguage field is set.

hasTone()

public boolean hasTone()

Optional. The tone of the output generated text. Supported tones are: "playful", "formal", "persuasive", and "conversational"

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

Returns
Type Description
boolean

Whether the tone field is set.

hasWorkflowId()

public boolean hasWorkflowId()

Optional. The workflow to execute for the provided product data. Workflows may populate the response's title, description, or both. Currently supported workflow_ids are: "title", "description", and "tide"

optional string workflow_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the workflowId 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 OutputSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutputSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeFrom(OutputSpec other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAttributeOrder(int index, String value)

public OutputSpec.Builder setAttributeOrder(int index, String value)

Optional. The order that generated attributes should be placed in the generated title. Eg., if the attribute order is ["brand", "product", "size"], the generated title will have brand first, followed by the product name, and then size information after that.

repeated string attribute_order = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value String

The attributeOrder to set.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.

setAttributeSeparator(String value)

public OutputSpec.Builder setAttributeSeparator(String value)

Optional. Character used to separate attributes in the generated title. For example, '|', '-', ','.

optional string attribute_separator = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The attributeSeparator to set.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.

setAttributeSeparatorBytes(ByteString value)

public OutputSpec.Builder setAttributeSeparatorBytes(ByteString value)

Optional. Character used to separate attributes in the generated title. For example, '|', '-', ','.

optional string attribute_separator = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for attributeSeparator to set.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.

setEditorialChanges(String value)

public OutputSpec.Builder setEditorialChanges(String value)

Optional. Any editorial changes for the generated product data. For example, replace Small with "S", do not modify color if already present.

optional string editorial_changes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The editorialChanges to set.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.

setEditorialChangesBytes(ByteString value)

public OutputSpec.Builder setEditorialChangesBytes(ByteString value)

Optional. Any editorial changes for the generated product data. For example, replace Small with "S", do not modify color if already present.

optional string editorial_changes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for editorialChanges to set.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setTargetLanguage(String value)

public OutputSpec.Builder setTargetLanguage(String value)

Optional. The language for output titles/descriptions. For example. 'German', 'es', 'FR'. Default is 'en'.

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

Parameter
Name Description
value String

The targetLanguage to set.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.

setTargetLanguageBytes(ByteString value)

public OutputSpec.Builder setTargetLanguageBytes(ByteString value)

Optional. The language for output titles/descriptions. For example. 'German', 'es', 'FR'. Default is 'en'.

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

Parameter
Name Description
value ByteString

The bytes for targetLanguage to set.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.

setTone(String value)

public OutputSpec.Builder setTone(String value)

Optional. The tone of the output generated text. Supported tones are: "playful", "formal", "persuasive", and "conversational"

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

Parameter
Name Description
value String

The tone to set.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.

setToneBytes(ByteString value)

public OutputSpec.Builder setToneBytes(ByteString value)

Optional. The tone of the output generated text. Supported tones are: "playful", "formal", "persuasive", and "conversational"

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

Parameter
Name Description
value ByteString

The bytes for tone to set.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setWorkflowId(String value)

public OutputSpec.Builder setWorkflowId(String value)

Optional. The workflow to execute for the provided product data. Workflows may populate the response's title, description, or both. Currently supported workflow_ids are: "title", "description", and "tide"

optional string workflow_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The workflowId to set.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.

setWorkflowIdBytes(ByteString value)

public OutputSpec.Builder setWorkflowIdBytes(ByteString value)

Optional. The workflow to execute for the provided product data. Workflows may populate the response's title, description, or both. Currently supported workflow_ids are: "title", "description", and "tide"

optional string workflow_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for workflowId to set.
Returns
Type Description
OutputSpec.Builder

This builder for chaining.