Class WidgetTool.DataMapping (0.7.0)

public static final class WidgetTool.DataMapping extends GeneratedMessage implements WidgetTool.DataMappingOrBuilder

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

Protobuf type google.cloud.ces.v1beta.WidgetTool.DataMapping

Static Fields

FIELD_MAPPINGS_FIELD_NUMBER

public static final int FIELD_MAPPINGS_FIELD_NUMBER
Field Value
Type Description
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
Type Description
int

PYTHON_FUNCTION_FIELD_NUMBER

public static final int PYTHON_FUNCTION_FIELD_NUMBER
Field Value
Type Description
int

PYTHON_SCRIPT_FIELD_NUMBER

public static final int PYTHON_SCRIPT_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_TOOL_NAME_FIELD_NUMBER

public static final int SOURCE_TOOL_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WidgetTool.DataMapping getDefaultInstance()
Returns
Type Description
WidgetTool.DataMapping

getDescriptor()

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

newBuilder()

public static WidgetTool.DataMapping.Builder newBuilder()
Returns
Type Description
WidgetTool.DataMapping.Builder

newBuilder(WidgetTool.DataMapping prototype)

public static WidgetTool.DataMapping.Builder newBuilder(WidgetTool.DataMapping prototype)
Parameter
Name Description
prototype WidgetTool.DataMapping
Returns
Type Description
WidgetTool.DataMapping.Builder

parseDelimitedFrom(InputStream input)

public static WidgetTool.DataMapping parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WidgetTool.DataMapping
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WidgetTool.DataMapping parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetTool.DataMapping
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static WidgetTool.DataMapping parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
WidgetTool.DataMapping
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WidgetTool.DataMapping parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetTool.DataMapping
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WidgetTool.DataMapping parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WidgetTool.DataMapping
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WidgetTool.DataMapping parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetTool.DataMapping
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WidgetTool.DataMapping parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WidgetTool.DataMapping
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WidgetTool.DataMapping parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetTool.DataMapping
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static WidgetTool.DataMapping parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WidgetTool.DataMapping
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WidgetTool.DataMapping parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetTool.DataMapping
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static WidgetTool.DataMapping parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WidgetTool.DataMapping
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WidgetTool.DataMapping parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetTool.DataMapping
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<WidgetTool.DataMapping> parser()
Returns
Type Description
Parser<DataMapping>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public WidgetTool.DataMapping getDefaultInstanceForType()
Returns
Type Description
WidgetTool.DataMapping

getFieldMappings() (deprecated)

public Map<String,String> getFieldMappings()
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.v1beta.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.v1beta.WidgetTool.DataMapping.Mode mode = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for mode.

getParserForType()

public Parser<WidgetTool.DataMapping> getParserForType()
Returns
Type Description
Parser<DataMapping>
Overrides

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.v1beta.PythonFunction python_function = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PythonFunction

The pythonFunction.

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.v1beta.PythonFunction python_function = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PythonFunctionOrBuilder

getPythonScript() (deprecated)

public String getPythonScript()

Deprecated. google.cloud.ces.v1beta.WidgetTool.DataMapping.python_script is deprecated. See google/cloud/ces/v1beta/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.v1beta.WidgetTool.DataMapping.python_script is deprecated. See google/cloud/ces/v1beta/widget_tool.proto;l=66

Deprecated: Use python_function instead.

string python_script = 3 [deprecated = true];

Returns
Type Description
ByteString

The bytes for pythonScript.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.v1beta.PythonFunction python_function = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the pythonFunction field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public WidgetTool.DataMapping.Builder newBuilderForType()
Returns
Type Description
WidgetTool.DataMapping.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected WidgetTool.DataMapping.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WidgetTool.DataMapping.Builder
Overrides

toBuilder()

public WidgetTool.DataMapping.Builder toBuilder()
Returns
Type Description
WidgetTool.DataMapping.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException