Interface ToolOrBuilder (4.87.0) 

public interface ToolOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsActionConfirmationRequirement(String key)

public abstract 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 abstract Map<String,Tool.ConfirmationRequirement> getActionConfirmationRequirement()

Use #getActionConfirmationRequirementMap() instead.

Returns
Type Description
Map<String,ConfirmationRequirement>

getActionConfirmationRequirementCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,Integer> getActionConfirmationRequirementValue()

Use #getActionConfirmationRequirementValueMap() instead.

Returns
Type Description
Map<String,Integer>

getActionConfirmationRequirementValueMap()

public abstract 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 abstract 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 abstract 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 abstract Tool.ConnectorTool getConnectorSpec()

Integration connectors tool specification.

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

Returns
Type Description
Tool.ConnectorTool

The connectorSpec.

getConnectorSpecOrBuilder()

public abstract Tool.ConnectorToolOrBuilder getConnectorSpecOrBuilder()

Integration connectors tool specification.

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

Returns
Type Description
Tool.ConnectorToolOrBuilder

getCreateTime()

public abstract 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.

getCreateTimeOrBuilder()

public abstract 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

getDescription()

public abstract 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 abstract 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.

getDisplayName()

public abstract 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 abstract 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 abstract 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.

getExtensionSpecOrBuilder() (deprecated)

public abstract 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 abstract Tool.FunctionTool getFunctionSpec()

Client side executed function specification.

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

Returns
Type Description
Tool.FunctionTool

The functionSpec.

getFunctionSpecOrBuilder()

public abstract Tool.FunctionToolOrBuilder getFunctionSpecOrBuilder()

Client side executed function specification.

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

Returns
Type Description
Tool.FunctionToolOrBuilder

getName()

public abstract 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 abstract 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 abstract Tool.OpenApiTool getOpenApiSpec()

OpenAPI tool.

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

Returns
Type Description
Tool.OpenApiTool

The openApiSpec.

getOpenApiSpecOrBuilder()

public abstract Tool.OpenApiToolOrBuilder getOpenApiSpecOrBuilder()

OpenAPI tool.

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

Returns
Type Description
Tool.OpenApiToolOrBuilder

getSatisfiesPzi()

public abstract 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 abstract 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 abstract Tool.SpecificationCase getSpecificationCase()
Returns
Type Description
Tool.SpecificationCase

getToolKey()

public abstract 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 abstract 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 abstract 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.

getUpdateTimeOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.