Interface OutputSpecOrBuilder (0.2.0) 

public interface OutputSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAttributeOrder(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the attributeOrder.

getAttributeSeparator()

public abstract 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 abstract 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.

getEditorialChanges()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.