Google Cloud Ces V1 Client - Class DataMapping (0.2.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class DataMapping.

Configuration for mapping data from a source tool to the widget's input parameters.

Generated from protobuf message google.cloud.ces.v1.WidgetTool.DataMapping

Namespace

Google \ Cloud \ Ces \ V1 \ WidgetTool

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ source_tool_name
string

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}

↳ field_mappings
array| Google\Protobuf\Internal\MapField

Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.

↳ python_function
Google\Cloud\Ces\V1\PythonFunction

Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.

↳ mode
int

Optional. The mode of the data mapping.

↳ python_script
string

Deprecated: Use python_function instead.

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}

Returns
Type
Description
string

setSourceToolName

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}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFieldMappings

Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.

Returns
Type
Description

setFieldMappings

Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.

Parameter
Name
Description
Returns
Type
Description
$this

getPythonFunction

Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.

Returns
Type
Description

hasPythonFunction

clearPythonFunction

setPythonFunction

Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.

Parameter
Name
Description
Returns
Type
Description
$this

getMode

Optional. The mode of the data mapping.

Returns
Type
Description
int
Enum of type Mode .

setMode

Optional. The mode of the data mapping.

Parameter
Name
Description
var
int

Enum of type Mode .

Returns
Type
Description
$this

getPythonScript

Deprecated: Use python_function instead.

Returns
Type
Description
string

setPythonScript

Deprecated: Use python_function instead.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: