Struct FunctionTool 

#[non_exhaustive]
pub struct FunctionTool {
    pub input_schema: Option<Struct>,
    pub output_schema: Option<Struct>,
    pub method_type: MethodType,
    /* private fields */
}

Available on crate feature tools only.

A Function tool describes the functions to be invoked on the client side.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

input_schema: Option<Struct>

Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function’s parameters as properties of the object.

output_schema: Option<Struct>

Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function’s parameters as properties of the object.

method_type: MethodType

Optional. The method type of the function. If not specified, the default value is GET.

Implementations

impl FunctionTool

pub fn new() -> Self

pub fn set_input_schema<T>(self, v: T) -> Self

where T: Into<Struct>,

Sets the value of input_schema.

Example

use wkt::Struct;
let x = FunctionTool::new().set_input_schema(Struct::default()/* use setters */);

pub fn set_or_clear_input_schema<T>(self, v: Option<T>) -> Self

where T: Into<Struct>,

Sets or clears the value of input_schema.

Example

use wkt::Struct;
let x = FunctionTool::new().set_or_clear_input_schema(Some(Struct::default()/* use setters */));
let x = FunctionTool::new().set_or_clear_input_schema(None::<Struct>);

pub fn set_output_schema<T>(self, v: T) -> Self

where T: Into<Struct>,

Sets the value of output_schema.

Example

use wkt::Struct;
let x = FunctionTool::new().set_output_schema(Struct::default()/* use setters */);

pub fn set_or_clear_output_schema<T>(self, v: Option<T>) -> Self

where T: Into<Struct>,

Sets or clears the value of output_schema.

Example

use wkt::Struct;
let x = FunctionTool::new().set_or_clear_output_schema(Some(Struct::default()/* use setters */));
let x = FunctionTool::new().set_or_clear_output_schema(None::<Struct>);

pub fn set_method_type<T: Into<MethodType>>(self, v: T) -> Self

Sets the value of method_type.

Example

use google_cloud_dialogflow_v2::model::tool::MethodType;
let x0 = FunctionTool::new().set_method_type(MethodType::Get);
let x1 = FunctionTool::new().set_method_type(MethodType::Post);
let x2 = FunctionTool::new().set_method_type(MethodType::Put);

Trait Implementations

impl Clone for FunctionTool

fn clone(&self) -> FunctionTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionTool

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

Formats the value using the given formatter.

impl Default for FunctionTool

fn default() -> FunctionTool

Returns the “default value” for a type.

impl Message for FunctionTool

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FunctionTool

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for FunctionTool