public final class OutputSpec extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ATTRIBUTE_ORDER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ATTRIBUTE_SEPARATOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EDITORIAL_CHANGES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TARGET_LANGUAGE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TONE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int WORKFLOW_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static OutputSpec getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static OutputSpec.Builder newBuilder()
public static OutputSpec.Builder newBuilder(OutputSpec prototype)
public static OutputSpec parseDelimitedFrom(InputStream input)
public static OutputSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static OutputSpec parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static OutputSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static OutputSpec parseFrom(ByteString data)
public static OutputSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static OutputSpec parseFrom(CodedInputStream input)
public static OutputSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static OutputSpec parseFrom(InputStream input)
public static OutputSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static OutputSpec parseFrom(ByteBuffer data)
public static OutputSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<OutputSpec> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
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.
|
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.
|
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];
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.
|
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.
|
public OutputSpec getDefaultInstanceForType()
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.
|
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.
|
public Parser<OutputSpec> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public OutputSpec.Builder newBuilderForType()
protected OutputSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public OutputSpec.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
