Struct google_api_proto::google::cloud::dialogflow::cx::v3beta1::Tool

pub struct Tool {
    pub name: String,
    pub display_name: String,
    pub description: String,
    pub tool_type: i32,
    pub specification: Option<Specification>,
}

A tool provides a list of actions which are available to the [Playbook][google.cloud.dialogflow.cx.v3beta1.Playbook] to attain its goal. A Tool consists of a description of the tool’s usage and a specification of the tool which contains the schema and authentication information.

Fields

name: String

The unique identifier of the Tool. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/tools/<Tool ID>.

display_name: String

Required. The human-readable name of the Tool, unique within an agent.

description: String

Required. High level description of the Tool and its usage.

tool_type: i32

Output only. The tool type.

specification: Option<Specification>

Specification of the Tool.

Implementations

impl Tool

pub fn tool_type(&self) -> ToolType

Returns the enum value of tool_type, or the default if the field is set to an invalid enum value.

pub fn set_tool_type(&mut self, value: ToolType)

Sets tool_type to the provided enum value.

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Tool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Tool

fn default() -> Self

Returns the “default value” for a type.

impl Message for Tool

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Tool

fn eq(&self, other: &Tool) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Tool