Package com.google.cloud.dialogflow.v2

Interface ToolOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Tool, Tool.Builder
@Generated public interface ToolOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • getToolKey

      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:
      The toolKey.

    • getToolKeyBytes

      com.google.protobuf.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:
      The bytes for toolKey.

    • getDisplayName

      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:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.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:
      The bytes for displayName.

    • getDescription

      String getDescription()
       Optional. A human readable description of the tool.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. A human readable description of the tool.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • getActionConfirmationRequirementCount

      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];

    • containsActionConfirmationRequirement

      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];

    • getActionConfirmationRequirement

      @Deprecated Map<String,Tool.ConfirmationRequirement> getActionConfirmationRequirement()
      Deprecated.
      Use getActionConfirmationRequirementMap() instead.

    • getActionConfirmationRequirementMap

      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];

    • getActionConfirmationRequirementOrDefault

      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];

    • getActionConfirmationRequirementOrThrow

      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];

    • getActionConfirmationRequirementValue

      @Deprecated Map<String,Integer> getActionConfirmationRequirementValue()
      Deprecated.
      Use getActionConfirmationRequirementValueMap() instead.

    • getActionConfirmationRequirementValueMap

      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];

    • getActionConfirmationRequirementValueOrDefault

      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];

    • getActionConfirmationRequirementValueOrThrow

      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];

    • hasExtensionSpec

      @Deprecated 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:
      Whether the extensionSpec field is set.

    • getExtensionSpec

      @Deprecated 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:
      The extensionSpec.

    • getExtensionSpecOrBuilder

      @Deprecated Tool.ExtensionToolOrBuilder getExtensionSpecOrBuilder()
      Deprecated.
       Vertex extension tool specification.
      .google.cloud.dialogflow.v2.Tool.ExtensionTool extension_spec = 4 [deprecated = true];

    • hasFunctionSpec

      boolean hasFunctionSpec()
       Client side executed function specification.
      .google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;
      Returns:
      Whether the functionSpec field is set.

    • getFunctionSpec

      Tool.FunctionTool getFunctionSpec()
       Client side executed function specification.
      .google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;
      Returns:
      The functionSpec.

    • getFunctionSpecOrBuilder

      Tool.FunctionToolOrBuilder getFunctionSpecOrBuilder()
       Client side executed function specification.
      .google.cloud.dialogflow.v2.Tool.FunctionTool function_spec = 13;

    • hasConnectorSpec

      boolean hasConnectorSpec()
       Integration connectors tool specification.
      .google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;
      Returns:
      Whether the connectorSpec field is set.

    • getConnectorSpec

      Tool.ConnectorTool getConnectorSpec()
       Integration connectors tool specification.
      .google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;
      Returns:
      The connectorSpec.

    • getConnectorSpecOrBuilder

      Tool.ConnectorToolOrBuilder getConnectorSpecOrBuilder()
       Integration connectors tool specification.
      .google.cloud.dialogflow.v2.Tool.ConnectorTool connector_spec = 18;

    • hasOpenApiSpec

      boolean hasOpenApiSpec()
       OpenAPI tool.
      .google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;
      Returns:
      Whether the openApiSpec field is set.

    • getOpenApiSpec

      Tool.OpenApiTool getOpenApiSpec()
       OpenAPI tool.
      .google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;
      Returns:
      The openApiSpec.

    • getOpenApiSpecOrBuilder

      Tool.OpenApiToolOrBuilder getOpenApiSpecOrBuilder()
       OpenAPI tool.
      .google.cloud.dialogflow.v2.Tool.OpenApiTool open_api_spec = 20;

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Creation time of this tool.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Creation time of this tool.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Creation time of this tool.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. Update time of this tool.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. Update time of this tool.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Update time of this tool.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasSatisfiesPzs

      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:
      Whether the satisfiesPzs field is set.

    • getSatisfiesPzs

      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:
      The satisfiesPzs.

    • hasSatisfiesPzi

      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:
      Whether the satisfiesPzi field is set.

    • getSatisfiesPzi

      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:
      The satisfiesPzi.

    • getSpecificationCase

      Tool.SpecificationCase getSpecificationCase()