Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Tool

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2/classes.rb,
lib/google/apis/dialogflow_v2/representations.rb,
lib/google/apis/dialogflow_v2/representations.rb

Overview

Represents a tool.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2Tool

Returns a new instance of GoogleCloudDialogflowV2Tool.



18769
18770
18771
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18769

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#action_confirmation_requirement ⇒ Hash<String,String>

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. Corresponds to the JSON property actionConfirmationRequirement

Returns:

  • (Hash<String,String>) 


18699
18700
18701
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18699

def action_confirmation_requirement
  @action_confirmation_requirement
end

#connector_spec ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ToolConnectorTool

A ConnectorTool enabling using Integration Connectors Connections as tools. Corresponds to the JSON property connectorSpec

Returns:



18704
18705
18706
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18704

def connector_spec
  @connector_spec
end

#create_time ⇒ String

Output only. Creation time of this tool. Corresponds to the JSON property createTime

Returns:

  • (String) 


18709
18710
18711
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18709

def create_time
  @create_time
end

#description ⇒ String

Optional. A human readable description of the tool. Corresponds to the JSON property description

Returns:

  • (String) 


18714
18715
18716
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18714

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


18719
18720
18721
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18719

def display_name
  @display_name
end

#extension_spec ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ToolExtensionTool

An ExtensionTool is a way to use Vertex Extensions as a tool. Corresponds to the JSON property extensionSpec

Returns:



18724
18725
18726
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18724

def extension_spec
  @extension_spec
end

#function_spec ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ToolFunctionTool

A Function tool describes the functions to be invoked on the client side. Corresponds to the JSON property functionSpec

Returns:



18729
18730
18731
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18729

def function_spec
  @function_spec
end

#name ⇒ String

Output only. Identifier. The resource name of the tool. Format: projects// locations//tools/. Corresponds to the JSON property name

Returns:

  • (String) 


18735
18736
18737
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18735

def name
  @name
end

#open_api_spec ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ToolOpenApiTool

An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. Corresponds to the JSON property openApiSpec

Returns:



18741
18742
18743
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18741

def open_api_spec
  @open_api_spec
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

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. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


18747
18748
18749
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18747

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


18754
18755
18756
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18754

def satisfies_pzs
  @satisfies_pzs
end

#tool_key ⇒ String

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. Corresponds to the JSON property toolKey

Returns:

  • (String) 


18762
18763
18764
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18762

def tool_key
  @tool_key
end

#update_time ⇒ String

Output only. Update time of this tool. Corresponds to the JSON property updateTime

Returns:

  • (String) 


18767
18768
18769
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18767

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18774
18775
18776
18777
18778
18779
18780
18781
18782
18783
18784
18785
18786
18787
18788
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 18774

def update!(**args)
  @action_confirmation_requirement = args[:action_confirmation_requirement] if args.key?(:action_confirmation_requirement)
  @connector_spec = args[:connector_spec] if args.key?(:connector_spec)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @extension_spec = args[:extension_spec] if args.key?(:extension_spec)
  @function_spec = args[:function_spec] if args.key?(:function_spec)
  @name = args[:name] if args.key?(:name)
  @open_api_spec = args[:open_api_spec] if args.key?(:open_api_spec)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @tool_key = args[:tool_key] if args.key?(:tool_key)
  @update_time = args[:update_time] if args.key?(:update_time)
end