Class Tool.Builder (4.87.0) 

public static final class Tool.Builder extends GeneratedMessageV3.Builder<Tool.Builder> implements ToolOrBuilder

Represents a tool.

Protobuf type google.cloud.dialogflow.v2.Tool

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Tool.Builder

Implements

ToolOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Tool.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Tool.Builder
Overrides

build()

public Tool build()
Returns
Type Description
Tool

buildPartial()

public Tool buildPartial()
Returns
Type Description
Tool

clear()

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

clearActionConfirmationRequirement()

public Tool.Builder clearActionConfirmationRequirement()
Returns
Type Description
Tool.Builder

clearConnectorSpec()

public Tool.Builder clearConnectorSpec()

Integration connectors tool specification.

.google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;

Returns
Type Description
Tool.Builder

clearCreateTime()

public Tool.Builder clearCreateTime()

Output only. Creation time of this tool.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Tool.Builder

clearDescription()

public Tool.Builder clearDescription()

Optional. A human readable description of the tool.

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

Returns
Type Description
Tool.Builder

This builder for chaining.

clearDisplayName()

public Tool.Builder clearDisplayName()

Optional. A human readable short name of the tool, to be shown on the UI.

string display_name = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Tool.Builder

This builder for chaining.

clearExtensionSpec() (deprecated)

public Tool.Builder clearExtensionSpec()

Vertex extension tool specification.

.google.cloud.dialogflow.v2.Tool.ExtensionTool extension_spec = 4 [deprecated = true];

Returns
Type Description
Tool.Builder

clearField(Descriptors.FieldDescriptor field)

public Tool.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Tool.Builder
Overrides

clearFunctionSpec()

public Tool.Builder clearFunctionSpec()

Client side executed function specification.

.google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;

Returns
Type Description
Tool.Builder

clearName()

public Tool.Builder clearName()

Output only. Identifier. The resource name of the tool. Format: projects/<Project ID>/locations/<Location ID>/tools/<Tool ID>.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Tool.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Tool.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Tool.Builder
Overrides

clearOpenApiSpec()

public Tool.Builder clearOpenApiSpec()

OpenAPI tool.

.google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;

Returns
Type Description
Tool.Builder

clearSatisfiesPzi()

public Tool.Builder clearSatisfiesPzi()

Output only. A read only boolean field reflecting Zone Isolation status of the tool. If the field is absent, it means the status is unknown.

optional bool satisfies_pzi = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Tool.Builder

This builder for chaining.

clearSatisfiesPzs()

public Tool.Builder clearSatisfiesPzs()

Output only. A read only boolean field reflecting Zone Separation status of the tool. If the field is absent, it means the status is unknown.

optional bool satisfies_pzs = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Tool.Builder

This builder for chaining.

clearSpecification()

public Tool.Builder clearSpecification()
Returns
Type Description
Tool.Builder

clearToolKey()

public Tool.Builder clearToolKey()

Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.

string tool_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Tool.Builder

This builder for chaining.

clearUpdateTime()

public Tool.Builder clearUpdateTime()

Output only. Update time of this tool.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Tool.Builder

clone()

public Tool.Builder clone()
Returns
Type Description
Tool.Builder
Overrides

containsActionConfirmationRequirement(String key)

public boolean containsActionConfirmationRequirement(String key)

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getActionConfirmationRequirement() (deprecated)

public Map<String,Tool.ConfirmationRequirement> getActionConfirmationRequirement()

Use #getActionConfirmationRequirementMap() instead.

Returns
Type Description
Map<String,ConfirmationRequirement>

getActionConfirmationRequirementCount()

public int getActionConfirmationRequirementCount()

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getActionConfirmationRequirementMap()

public Map<String,Tool.ConfirmationRequirement> getActionConfirmationRequirementMap()

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,ConfirmationRequirement>

getActionConfirmationRequirementOrDefault(String key, Tool.ConfirmationRequirement defaultValue)

public Tool.ConfirmationRequirement getActionConfirmationRequirementOrDefault(String key, Tool.ConfirmationRequirement defaultValue)

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue Tool.ConfirmationRequirement
Returns
Type Description
Tool.ConfirmationRequirement

getActionConfirmationRequirementOrThrow(String key)

public Tool.ConfirmationRequirement getActionConfirmationRequirementOrThrow(String key)

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Tool.ConfirmationRequirement

getActionConfirmationRequirementValue() (deprecated)

public Map<String,Integer> getActionConfirmationRequirementValue()

Use #getActionConfirmationRequirementValueMap() instead.

Returns
Type Description
Map<String,Integer>

getActionConfirmationRequirementValueMap()

public Map<String,Integer> getActionConfirmationRequirementValueMap()

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,Integer>

getActionConfirmationRequirementValueOrDefault(String key, int defaultValue)

public int getActionConfirmationRequirementValueOrDefault(String key, int defaultValue)

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue int
Returns
Type Description
int

getActionConfirmationRequirementValueOrThrow(String key)

public int getActionConfirmationRequirementValueOrThrow(String key)

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
int

getConnectorSpec()

public Tool.ConnectorTool getConnectorSpec()

Integration connectors tool specification.

.google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;

Returns
Type Description
Tool.ConnectorTool

The connectorSpec.

getConnectorSpecBuilder()

public Tool.ConnectorTool.Builder getConnectorSpecBuilder()

Integration connectors tool specification.

.google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;

Returns
Type Description
Tool.ConnectorTool.Builder

getConnectorSpecOrBuilder()

public Tool.ConnectorToolOrBuilder getConnectorSpecOrBuilder()

Integration connectors tool specification.

.google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;

Returns
Type Description
Tool.ConnectorToolOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Creation time of this tool.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Creation time of this tool.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation time of this tool.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Tool getDefaultInstanceForType()
Returns
Type Description
Tool

getDescription()

public String getDescription()

Optional. A human readable description of the tool.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. A human readable description of the tool.

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

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Optional. A human readable short name of the tool, to be shown on the UI.

string display_name = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. A human readable short name of the tool, to be shown on the UI.

string display_name = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getExtensionSpec() (deprecated)

public Tool.ExtensionTool getExtensionSpec()

Deprecated. google.cloud.dialogflow.v2.Tool.extension_spec is deprecated. See google/cloud/dialogflow/v2/tool.proto;l=563

Vertex extension tool specification.

.google.cloud.dialogflow.v2.Tool.ExtensionTool extension_spec = 4 [deprecated = true];

Returns
Type Description
Tool.ExtensionTool

The extensionSpec.

getExtensionSpecBuilder() (deprecated)

public Tool.ExtensionTool.Builder getExtensionSpecBuilder()

Vertex extension tool specification.

.google.cloud.dialogflow.v2.Tool.ExtensionTool extension_spec = 4 [deprecated = true];

Returns
Type Description
Tool.ExtensionTool.Builder

getExtensionSpecOrBuilder() (deprecated)

public Tool.ExtensionToolOrBuilder getExtensionSpecOrBuilder()

Vertex extension tool specification.

.google.cloud.dialogflow.v2.Tool.ExtensionTool extension_spec = 4 [deprecated = true];

Returns
Type Description
Tool.ExtensionToolOrBuilder

getFunctionSpec()

public Tool.FunctionTool getFunctionSpec()

Client side executed function specification.

.google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;

Returns
Type Description
Tool.FunctionTool

The functionSpec.

getFunctionSpecBuilder()

public Tool.FunctionTool.Builder getFunctionSpecBuilder()

Client side executed function specification.

.google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;

Returns
Type Description
Tool.FunctionTool.Builder

getFunctionSpecOrBuilder()

public Tool.FunctionToolOrBuilder getFunctionSpecOrBuilder()

Client side executed function specification.

.google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;

Returns
Type Description
Tool.FunctionToolOrBuilder

getMutableActionConfirmationRequirement() (deprecated)

public Map<String,Tool.ConfirmationRequirement> getMutableActionConfirmationRequirement()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,ConfirmationRequirement>

getMutableActionConfirmationRequirementValue() (deprecated)

public Map<String,Integer> getMutableActionConfirmationRequirementValue()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,Integer>

getName()

public String getName()

Output only. Identifier. The resource name of the tool. Format: projects/<Project ID>/locations/<Location ID>/tools/<Tool ID>.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Identifier. The resource name of the tool. Format: projects/<Project ID>/locations/<Location ID>/tools/<Tool ID>.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getOpenApiSpec()

public Tool.OpenApiTool getOpenApiSpec()

OpenAPI tool.

.google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;

Returns
Type Description
Tool.OpenApiTool

The openApiSpec.

getOpenApiSpecBuilder()

public Tool.OpenApiTool.Builder getOpenApiSpecBuilder()

OpenAPI tool.

.google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;

Returns
Type Description
Tool.OpenApiTool.Builder

getOpenApiSpecOrBuilder()

public Tool.OpenApiToolOrBuilder getOpenApiSpecOrBuilder()

OpenAPI tool.

.google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;

Returns
Type Description
Tool.OpenApiToolOrBuilder

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. A read only boolean field reflecting Zone Isolation status of the tool. If the field is absent, it means the status is unknown.

optional bool satisfies_pzi = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. A read only boolean field reflecting Zone Separation status of the tool. If the field is absent, it means the status is unknown.

optional bool satisfies_pzs = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getSpecificationCase()

public Tool.SpecificationCase getSpecificationCase()
Returns
Type Description
Tool.SpecificationCase

getToolKey()

public String getToolKey()

Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.

string tool_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The toolKey.

getToolKeyBytes()

public ByteString getToolKeyBytes()

Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.

string tool_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for toolKey.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update time of this tool.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Update time of this tool.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time of this tool.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasConnectorSpec()

public boolean hasConnectorSpec()

Integration connectors tool specification.

.google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;

Returns
Type Description
boolean

Whether the connectorSpec field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Creation time of this tool.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasExtensionSpec() (deprecated)

public boolean hasExtensionSpec()

Deprecated. google.cloud.dialogflow.v2.Tool.extension_spec is deprecated. See google/cloud/dialogflow/v2/tool.proto;l=563

Vertex extension tool specification.

.google.cloud.dialogflow.v2.Tool.ExtensionTool extension_spec = 4 [deprecated = true];

Returns
Type Description
boolean

Whether the extensionSpec field is set.

hasFunctionSpec()

public boolean hasFunctionSpec()

Client side executed function specification.

.google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;

Returns
Type Description
boolean

Whether the functionSpec field is set.

hasOpenApiSpec()

public boolean hasOpenApiSpec()

OpenAPI tool.

.google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;

Returns
Type Description
boolean

Whether the openApiSpec field is set.

hasSatisfiesPzi()

public boolean hasSatisfiesPzi()

Output only. A read only boolean field reflecting Zone Isolation status of the tool. If the field is absent, it means the status is unknown.

optional bool satisfies_pzi = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

public boolean hasSatisfiesPzs()

Output only. A read only boolean field reflecting Zone Separation status of the tool. If the field is absent, it means the status is unknown.

optional bool satisfies_pzs = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update time of this tool.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.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.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeConnectorSpec(Tool.ConnectorTool value)

public Tool.Builder mergeConnectorSpec(Tool.ConnectorTool value)

Integration connectors tool specification.

.google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;

Parameter
Name Description
value Tool.ConnectorTool
Returns
Type Description
Tool.Builder

mergeCreateTime(Timestamp value)

public Tool.Builder mergeCreateTime(Timestamp value)

Output only. Creation time of this tool.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Tool.Builder

mergeExtensionSpec(Tool.ExtensionTool value) (deprecated)

public Tool.Builder mergeExtensionSpec(Tool.ExtensionTool value)

Vertex extension tool specification.

.google.cloud.dialogflow.v2.Tool.ExtensionTool extension_spec = 4 [deprecated = true];

Parameter
Name Description
value Tool.ExtensionTool
Returns
Type Description
Tool.Builder

mergeFrom(Tool other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFunctionSpec(Tool.FunctionTool value)

public Tool.Builder mergeFunctionSpec(Tool.FunctionTool value)

Client side executed function specification.

.google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;

Parameter
Name Description
value Tool.FunctionTool
Returns
Type Description
Tool.Builder

mergeOpenApiSpec(Tool.OpenApiTool value)

public Tool.Builder mergeOpenApiSpec(Tool.OpenApiTool value)

OpenAPI tool.

.google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;

Parameter
Name Description
value Tool.OpenApiTool
Returns
Type Description
Tool.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Tool.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Tool.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Tool.Builder mergeUpdateTime(Timestamp value)

Output only. Update time of this tool.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Tool.Builder

putActionConfirmationRequirement(String key, Tool.ConfirmationRequirement value)

public Tool.Builder putActionConfirmationRequirement(String key, Tool.ConfirmationRequirement value)

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value Tool.ConfirmationRequirement
Returns
Type Description
Tool.Builder

putActionConfirmationRequirementValue(String key, int value)

public Tool.Builder putActionConfirmationRequirementValue(String key, int value)

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value int
Returns
Type Description
Tool.Builder

putAllActionConfirmationRequirement(Map<String,Tool.ConfirmationRequirement> values)

public Tool.Builder putAllActionConfirmationRequirement(Map<String,Tool.ConfirmationRequirement> values)

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,ConfirmationRequirement>
Returns
Type Description
Tool.Builder

putAllActionConfirmationRequirementValue(Map<String,Integer> values)

public Tool.Builder putAllActionConfirmationRequirementValue(Map<String,Integer> values)

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,Integer>
Returns
Type Description
Tool.Builder

removeActionConfirmationRequirement(String key)

public Tool.Builder removeActionConfirmationRequirement(String key)

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.

map<string, .google.cloud.dialogflow.v2.Tool.ConfirmationRequirement> action_confirmation_requirement = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Tool.Builder

setConnectorSpec(Tool.ConnectorTool value)

public Tool.Builder setConnectorSpec(Tool.ConnectorTool value)

Integration connectors tool specification.

.google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;

Parameter
Name Description
value Tool.ConnectorTool
Returns
Type Description
Tool.Builder

setConnectorSpec(Tool.ConnectorTool.Builder builderForValue)

public Tool.Builder setConnectorSpec(Tool.ConnectorTool.Builder builderForValue)

Integration connectors tool specification.

.google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;

Parameter
Name Description
builderForValue Tool.ConnectorTool.Builder
Returns
Type Description
Tool.Builder

setCreateTime(Timestamp value)

public Tool.Builder setCreateTime(Timestamp value)

Output only. Creation time of this tool.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Tool.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Tool.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Creation time of this tool.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Tool.Builder

setDescription(String value)

public Tool.Builder setDescription(String value)

Optional. A human readable description of the tool.

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

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Tool.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Tool.Builder setDescriptionBytes(ByteString value)

Optional. A human readable description of the tool.

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

Parameter
Name Description
value ByteString

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

This builder for chaining.

setDisplayName(String value)

public Tool.Builder setDisplayName(String value)

Optional. A human readable short name of the tool, to be shown on the UI.

string display_name = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Tool.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Tool.Builder setDisplayNameBytes(ByteString value)

Optional. A human readable short name of the tool, to be shown on the UI.

string display_name = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Tool.Builder

This builder for chaining.

setExtensionSpec(Tool.ExtensionTool value) (deprecated)

public Tool.Builder setExtensionSpec(Tool.ExtensionTool value)

Vertex extension tool specification.

.google.cloud.dialogflow.v2.Tool.ExtensionTool extension_spec = 4 [deprecated = true];

Parameter
Name Description
value Tool.ExtensionTool
Returns
Type Description
Tool.Builder

setExtensionSpec(Tool.ExtensionTool.Builder builderForValue) (deprecated)

public Tool.Builder setExtensionSpec(Tool.ExtensionTool.Builder builderForValue)

Vertex extension tool specification.

.google.cloud.dialogflow.v2.Tool.ExtensionTool extension_spec = 4 [deprecated = true];

Parameter
Name Description
builderForValue Tool.ExtensionTool.Builder
Returns
Type Description
Tool.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Tool.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Tool.Builder
Overrides

setFunctionSpec(Tool.FunctionTool value)

public Tool.Builder setFunctionSpec(Tool.FunctionTool value)

Client side executed function specification.

.google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;

Parameter
Name Description
value Tool.FunctionTool
Returns
Type Description
Tool.Builder

setFunctionSpec(Tool.FunctionTool.Builder builderForValue)

public Tool.Builder setFunctionSpec(Tool.FunctionTool.Builder builderForValue)

Client side executed function specification.

.google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;

Parameter
Name Description
builderForValue Tool.FunctionTool.Builder
Returns
Type Description
Tool.Builder

setName(String value)

public Tool.Builder setName(String value)

Output only. Identifier. The resource name of the tool. Format: projects/<Project ID>/locations/<Location ID>/tools/<Tool ID>.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Tool.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Tool.Builder setNameBytes(ByteString value)

Output only. Identifier. The resource name of the tool. Format: projects/<Project ID>/locations/<Location ID>/tools/<Tool ID>.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

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

This builder for chaining.

setOpenApiSpec(Tool.OpenApiTool value)

public Tool.Builder setOpenApiSpec(Tool.OpenApiTool value)

OpenAPI tool.

.google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;

Parameter
Name Description
value Tool.OpenApiTool
Returns
Type Description
Tool.Builder

setOpenApiSpec(Tool.OpenApiTool.Builder builderForValue)

public Tool.Builder setOpenApiSpec(Tool.OpenApiTool.Builder builderForValue)

OpenAPI tool.

.google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;

Parameter
Name Description
builderForValue Tool.OpenApiTool.Builder
Returns
Type Description
Tool.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Tool.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Tool.Builder
Overrides

setSatisfiesPzi(boolean value)

public Tool.Builder setSatisfiesPzi(boolean value)

Output only. A read only boolean field reflecting Zone Isolation status of the tool. If the field is absent, it means the status is unknown.

optional bool satisfies_pzi = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzi to set.
Returns
Type Description
Tool.Builder

This builder for chaining.

setSatisfiesPzs(boolean value)

public Tool.Builder setSatisfiesPzs(boolean value)

Output only. A read only boolean field reflecting Zone Separation status of the tool. If the field is absent, it means the status is unknown.

optional bool satisfies_pzs = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzs to set.
Returns
Type Description
Tool.Builder

This builder for chaining.

setToolKey(String value)

public Tool.Builder setToolKey(String value)

Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.

string tool_key = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The toolKey to set.
Returns
Type Description
Tool.Builder

This builder for chaining.

setToolKeyBytes(ByteString value)

public Tool.Builder setToolKeyBytes(ByteString value)

Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.

string tool_key = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for toolKey to set.
Returns
Type Description
Tool.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Tool.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Tool.Builder
Overrides

setUpdateTime(Timestamp value)

public Tool.Builder setUpdateTime(Timestamp value)

Output only. Update time of this tool.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Tool.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Tool.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Update time of this tool.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Tool.Builder