public static final class WidgetTool.DataMapping.Builder extends GeneratedMessage.Builder<WidgetTool.DataMapping.Builder> implements WidgetTool.DataMappingOrBuilderConfiguration for mapping data from a source tool to the widget's input parameters.
Protobuf type google.cloud.ces.v1.WidgetTool.DataMapping
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > WidgetTool.DataMapping.BuilderImplements
WidgetTool.DataMappingOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public WidgetTool.DataMapping build()| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping |
|
buildPartial()
public WidgetTool.DataMapping buildPartial()| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping |
|
clear()
public WidgetTool.DataMapping.Builder clear()| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
|
clearFieldMappings()
public WidgetTool.DataMapping.Builder clearFieldMappings()| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
|
clearMode()
public WidgetTool.DataMapping.Builder clearMode()Optional. The mode of the data mapping.
.google.cloud.ces.v1.WidgetTool.DataMapping.Mode mode = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
This builder for chaining. |
clearPythonFunction()
public WidgetTool.DataMapping.Builder clearPythonFunction()Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.
.google.cloud.ces.v1.PythonFunction python_function = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
|
clearPythonScript() (deprecated)
public WidgetTool.DataMapping.Builder clearPythonScript()Deprecated. google.cloud.ces.v1.WidgetTool.DataMapping.python_script is deprecated. See google/cloud/ces/v1/widget_tool.proto;l=66
Deprecated: Use python_function instead.
string python_script = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
This builder for chaining. |
clearSourceToolName()
public WidgetTool.DataMapping.Builder clearSourceToolName() Optional. The resource name of the tool that provides the data for the
widget (e.g., a search tool or a custom function). Format:
projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
string source_tool_name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
This builder for chaining. |
containsFieldMappings(String key)
public boolean containsFieldMappings(String key)Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
map<string, string> field_mappings = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public WidgetTool.DataMapping getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFieldMappings() (deprecated)
public Map<String,String> getFieldMappings()Use #getFieldMappingsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getFieldMappingsCount()
public int getFieldMappingsCount()Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
map<string, string> field_mappings = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getFieldMappingsMap()
public Map<String,String> getFieldMappingsMap()Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
map<string, string> field_mappings = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getFieldMappingsOrDefault(String key, String defaultValue)
public String getFieldMappingsOrDefault(String key, String defaultValue)Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
map<string, string> field_mappings = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getFieldMappingsOrThrow(String key)
public String getFieldMappingsOrThrow(String key)Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
map<string, string> field_mappings = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMode()
public WidgetTool.DataMapping.Mode getMode()Optional. The mode of the data mapping.
.google.cloud.ces.v1.WidgetTool.DataMapping.Mode mode = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Mode |
The mode. |
getModeValue()
public int getModeValue()Optional. The mode of the data mapping.
.google.cloud.ces.v1.WidgetTool.DataMapping.Mode mode = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for mode. |
getMutableFieldMappings() (deprecated)
public Map<String,String> getMutableFieldMappings()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getPythonFunction()
public PythonFunction getPythonFunction()Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.
.google.cloud.ces.v1.PythonFunction python_function = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PythonFunction |
The pythonFunction. |
getPythonFunctionBuilder()
public PythonFunction.Builder getPythonFunctionBuilder()Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.
.google.cloud.ces.v1.PythonFunction python_function = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PythonFunction.Builder |
|
getPythonFunctionOrBuilder()
public PythonFunctionOrBuilder getPythonFunctionOrBuilder()Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.
.google.cloud.ces.v1.PythonFunction python_function = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PythonFunctionOrBuilder |
|
getPythonScript() (deprecated)
public String getPythonScript()Deprecated. google.cloud.ces.v1.WidgetTool.DataMapping.python_script is deprecated. See google/cloud/ces/v1/widget_tool.proto;l=66
Deprecated: Use python_function instead.
string python_script = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
String |
The pythonScript. |
getPythonScriptBytes() (deprecated)
public ByteString getPythonScriptBytes()Deprecated. google.cloud.ces.v1.WidgetTool.DataMapping.python_script is deprecated. See google/cloud/ces/v1/widget_tool.proto;l=66
Deprecated: Use python_function instead.
string python_script = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pythonScript. |
getSourceToolName()
public String getSourceToolName() Optional. The resource name of the tool that provides the data for the
widget (e.g., a search tool or a custom function). Format:
projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
string source_tool_name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The sourceToolName. |
getSourceToolNameBytes()
public ByteString getSourceToolNameBytes() Optional. The resource name of the tool that provides the data for the
widget (e.g., a search tool or a custom function). Format:
projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
string source_tool_name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for sourceToolName. |
hasPythonFunction()
public boolean hasPythonFunction()Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.
.google.cloud.ces.v1.PythonFunction python_function = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pythonFunction field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(WidgetTool.DataMapping other)
public WidgetTool.DataMapping.Builder mergeFrom(WidgetTool.DataMapping other)| Parameter | |
|---|---|
| Name | Description |
other |
WidgetTool.DataMapping |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public WidgetTool.DataMapping.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public WidgetTool.DataMapping.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
|
mergePythonFunction(PythonFunction value)
public WidgetTool.DataMapping.Builder mergePythonFunction(PythonFunction value)Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.
.google.cloud.ces.v1.PythonFunction python_function = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
PythonFunction |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
|
putAllFieldMappings(Map<String,String> values)
public WidgetTool.DataMapping.Builder putAllFieldMappings(Map<String,String> values)Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
map<string, string> field_mappings = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
|
putFieldMappings(String key, String value)
public WidgetTool.DataMapping.Builder putFieldMappings(String key, String value)Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
map<string, string> field_mappings = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
|
removeFieldMappings(String key)
public WidgetTool.DataMapping.Builder removeFieldMappings(String key)Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
map<string, string> field_mappings = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
|
setMode(WidgetTool.DataMapping.Mode value)
public WidgetTool.DataMapping.Builder setMode(WidgetTool.DataMapping.Mode value)Optional. The mode of the data mapping.
.google.cloud.ces.v1.WidgetTool.DataMapping.Mode mode = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WidgetTool.DataMapping.ModeThe mode to set. |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
This builder for chaining. |
setModeValue(int value)
public WidgetTool.DataMapping.Builder setModeValue(int value)Optional. The mode of the data mapping.
.google.cloud.ces.v1.WidgetTool.DataMapping.Mode mode = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for mode to set. |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
This builder for chaining. |
setPythonFunction(PythonFunction value)
public WidgetTool.DataMapping.Builder setPythonFunction(PythonFunction value)Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.
.google.cloud.ces.v1.PythonFunction python_function = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
PythonFunction |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
|
setPythonFunction(PythonFunction.Builder builderForValue)
public WidgetTool.DataMapping.Builder setPythonFunction(PythonFunction.Builder builderForValue)Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.
.google.cloud.ces.v1.PythonFunction python_function = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
PythonFunction.Builder |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
|
setPythonScript(String value) (deprecated)
public WidgetTool.DataMapping.Builder setPythonScript(String value)Deprecated. google.cloud.ces.v1.WidgetTool.DataMapping.python_script is deprecated. See google/cloud/ces/v1/widget_tool.proto;l=66
Deprecated: Use python_function instead.
string python_script = 3 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pythonScript to set. |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
This builder for chaining. |
setPythonScriptBytes(ByteString value) (deprecated)
public WidgetTool.DataMapping.Builder setPythonScriptBytes(ByteString value)Deprecated. google.cloud.ces.v1.WidgetTool.DataMapping.python_script is deprecated. See google/cloud/ces/v1/widget_tool.proto;l=66
Deprecated: Use python_function instead.
string python_script = 3 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pythonScript to set. |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
This builder for chaining. |
setSourceToolName(String value)
public WidgetTool.DataMapping.Builder setSourceToolName(String value) Optional. The resource name of the tool that provides the data for the
widget (e.g., a search tool or a custom function). Format:
projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
string source_tool_name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe sourceToolName to set. |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
This builder for chaining. |
setSourceToolNameBytes(ByteString value)
public WidgetTool.DataMapping.Builder setSourceToolNameBytes(ByteString value) Optional. The resource name of the tool that provides the data for the
widget (e.g., a search tool or a custom function). Format:
projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
string source_tool_name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for sourceToolName to set. |
| Returns | |
|---|---|
| Type | Description |
WidgetTool.DataMapping.Builder |
This builder for chaining. |