Class WidgetTool.Builder (0.1.0) 

public static final class WidgetTool.Builder extends GeneratedMessage.Builder<WidgetTool.Builder> implements WidgetToolOrBuilder

Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent.

Protobuf type google.cloud.ces.v1.WidgetTool

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > WidgetTool.Builder

Implements

WidgetToolOrBuilder

Static Methods

getDescriptor()

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

Methods

build()

public WidgetTool build()
Returns
Type Description
WidgetTool

buildPartial()

public WidgetTool buildPartial()
Returns
Type Description
WidgetTool

clear()

public WidgetTool.Builder clear()
Returns
Type Description
WidgetTool.Builder
Overrides

clearDescription()

public WidgetTool.Builder clearDescription()

Optional. The description of the widget tool.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WidgetTool.Builder

This builder for chaining.

clearInput()

public WidgetTool.Builder clearInput()
Returns
Type Description
WidgetTool.Builder

clearName()

public WidgetTool.Builder clearName()

Required. The display name of the widget tool.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
WidgetTool.Builder

This builder for chaining.

clearParameters()

public WidgetTool.Builder clearParameters()

Optional. The input parameters of the widget tool.

.google.cloud.ces.v1.Schema parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WidgetTool.Builder

clearWidgetType()

public WidgetTool.Builder clearWidgetType()

Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.

.google.cloud.ces.v1.WidgetTool.WidgetType widget_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WidgetTool.Builder

This builder for chaining.

getDefaultInstanceForType()

public WidgetTool getDefaultInstanceForType()
Returns
Type Description
WidgetTool

getDescription()

public String getDescription()

Optional. The description of the widget tool.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the widget tool.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInputCase()

public WidgetTool.InputCase getInputCase()
Returns
Type Description
WidgetTool.InputCase

getName()

public String getName()

Required. The display name of the widget tool.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The display name of the widget tool.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getParameters()

public Schema getParameters()

Optional. The input parameters of the widget tool.

.google.cloud.ces.v1.Schema parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema

The parameters.

getParametersBuilder()

public Schema.Builder getParametersBuilder()

Optional. The input parameters of the widget tool.

.google.cloud.ces.v1.Schema parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.Builder

getParametersOrBuilder()

public SchemaOrBuilder getParametersOrBuilder()

Optional. The input parameters of the widget tool.

.google.cloud.ces.v1.Schema parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SchemaOrBuilder

getWidgetType()

public WidgetTool.WidgetType getWidgetType()

Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.

.google.cloud.ces.v1.WidgetTool.WidgetType widget_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WidgetTool.WidgetType

The widgetType.

getWidgetTypeValue()

public int getWidgetTypeValue()

Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.

.google.cloud.ces.v1.WidgetTool.WidgetType widget_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for widgetType.

hasParameters()

public boolean hasParameters()

Optional. The input parameters of the widget tool.

.google.cloud.ces.v1.Schema parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the parameters field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(WidgetTool other)

public WidgetTool.Builder mergeFrom(WidgetTool other)
Parameter
Name Description
other WidgetTool
Returns
Type Description
WidgetTool.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WidgetTool.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WidgetTool.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public WidgetTool.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
WidgetTool.Builder
Overrides

mergeParameters(Schema value)

public WidgetTool.Builder mergeParameters(Schema value)

Optional. The input parameters of the widget tool.

.google.cloud.ces.v1.Schema parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Schema
Returns
Type Description
WidgetTool.Builder

setDescription(String value)

public WidgetTool.Builder setDescription(String value)

Optional. The description of the widget tool.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.
Returns
Type Description
WidgetTool.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public WidgetTool.Builder setDescriptionBytes(ByteString value)

Optional. The description of the widget tool.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
WidgetTool.Builder

This builder for chaining.

setName(String value)

public WidgetTool.Builder setName(String value)

Required. The display name of the widget tool.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
WidgetTool.Builder

This builder for chaining.

setNameBytes(ByteString value)

public WidgetTool.Builder setNameBytes(ByteString value)

Required. The display name of the widget tool.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
WidgetTool.Builder

This builder for chaining.

setParameters(Schema value)

public WidgetTool.Builder setParameters(Schema value)

Optional. The input parameters of the widget tool.

.google.cloud.ces.v1.Schema parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Schema
Returns
Type Description
WidgetTool.Builder

setParameters(Schema.Builder builderForValue)

public WidgetTool.Builder setParameters(Schema.Builder builderForValue)

Optional. The input parameters of the widget tool.

.google.cloud.ces.v1.Schema parameters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Schema.Builder
Returns
Type Description
WidgetTool.Builder

setWidgetType(WidgetTool.WidgetType value)

public WidgetTool.Builder setWidgetType(WidgetTool.WidgetType value)

Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.

.google.cloud.ces.v1.WidgetTool.WidgetType widget_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value WidgetTool.WidgetType

The widgetType to set.
Returns
Type Description
WidgetTool.Builder

This builder for chaining.

setWidgetTypeValue(int value)

public WidgetTool.Builder setWidgetTypeValue(int value)

Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.

.google.cloud.ces.v1.WidgetTool.WidgetType widget_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for widgetType to set.
Returns
Type Description
WidgetTool.Builder

This builder for chaining.