com.google.cloud.dialogflow.cx.v3beta1.ToolOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-cx-v3beta1 Show documentation
PROTO library for proto-google-cloud-dialogflow-cx-v3beta1
The newest version!
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/dialogflow/cx/v3beta1/tool.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.cx.v3beta1;

public interface ToolOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.Tool)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * The unique identifier of the Tool.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
   * 
   *
   * string name = 1;
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * The unique identifier of the Tool.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
   * 
   *
   * string name = 1;
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Required. The human-readable name of the Tool, unique within an agent.
   * 
   *
   * string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   *    * Required. The human-readable name of the Tool, unique within an agent.
   * 
   *
   * string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   *    * Required. High level description of the Tool and its usage.
   * 
   *
   * string description = 3 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *
   *
   *    * Required. High level description of the Tool and its usage.
   * 
   *
   * string description = 3 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString getDescriptionBytes();

  /**
   *
   *
   *    * OpenAPI specification of the Tool.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiTool open_api_spec = 4;
   *
   * @return Whether the openApiSpec field is set.
   */
  boolean hasOpenApiSpec();
  /**
   *
   *
   *    * OpenAPI specification of the Tool.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiTool open_api_spec = 4;
   *
   * @return The openApiSpec.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiTool getOpenApiSpec();
  /**
   *
   *
   *    * OpenAPI specification of the Tool.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiTool open_api_spec = 4;
   */
  com.google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiToolOrBuilder getOpenApiSpecOrBuilder();

  /**
   *
   *
   *    * Data store search tool specification.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreTool data_store_spec = 8;
   *
   * @return Whether the dataStoreSpec field is set.
   */
  boolean hasDataStoreSpec();
  /**
   *
   *
   *    * Data store search tool specification.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreTool data_store_spec = 8;
   *
   * @return The dataStoreSpec.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreTool getDataStoreSpec();
  /**
   *
   *
   *    * Data store search tool specification.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreTool data_store_spec = 8;
   */
  com.google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreToolOrBuilder getDataStoreSpecOrBuilder();

  /**
   *
   *
   *    * Vertex extension tool specification.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionTool extension_spec = 11;
   *
   * @return Whether the extensionSpec field is set.
   */
  boolean hasExtensionSpec();
  /**
   *
   *
   *    * Vertex extension tool specification.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionTool extension_spec = 11;
   *
   * @return The extensionSpec.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionTool getExtensionSpec();
  /**
   *
   *
   *    * Vertex extension tool specification.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionTool extension_spec = 11;
   */
  com.google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionToolOrBuilder getExtensionSpecOrBuilder();

  /**
   *
   *
   *    * Client side executed function specification.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Tool.FunctionTool function_spec = 13;
   *
   * @return Whether the functionSpec field is set.
   */
  boolean hasFunctionSpec();
  /**
   *
   *
   *    * Client side executed function specification.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Tool.FunctionTool function_spec = 13;
   *
   * @return The functionSpec.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Tool.FunctionTool getFunctionSpec();
  /**
   *
   *
   *    * Client side executed function specification.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Tool.FunctionTool function_spec = 13;
   */
  com.google.cloud.dialogflow.cx.v3beta1.Tool.FunctionToolOrBuilder getFunctionSpecOrBuilder();

  /**
   *
   *
   *    * Output only. The tool type.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.Tool.ToolType tool_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The enum numeric value on the wire for toolType.
   */
  int getToolTypeValue();
  /**
   *
   *
   *    * Output only. The tool type.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.Tool.ToolType tool_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The toolType.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Tool.ToolType getToolType();

  com.google.cloud.dialogflow.cx.v3beta1.Tool.SpecificationCase getSpecificationCase();
}