Struct ApiInvocationInput 

#[non_exhaustive]
pub struct ApiInvocationInput {
    pub action_group: String,
    pub http_method: Option<String>,
    pub api_path: Option<String>,
    pub parameters: Option<Vec<ApiParameter>>,
    pub request_body: Option<ApiRequestBody>,
    pub action_invocation_type: Option<ActionInvocationType>,
    pub agent_id: Option<String>,
    pub collaborator_name: Option<String>,
}

Contains information about the API operation that the agent predicts should be called.

This data type is used in the following API operations:

• In the returnControl field of the InvokeAgent response

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.

action_group: String

The action group that the API operation belongs to.

http_method: Option<String>

The HTTP method of the API operation.

api_path: Option<String>

The path to the API operation.

parameters: Option<Vec<ApiParameter>>

The parameters to provide for the API request, as the agent elicited from the user.

request_body: Option<ApiRequestBody>

The request body to provide for the API request, as the agent elicited from the user.

action_invocation_type: Option<ActionInvocationType>

Contains information about the API operation to invoke.

agent_id: Option<String>

The agent's ID.

collaborator_name: Option<String>

The agent collaborator's name.

Implementations

impl ApiInvocationInput

pub fn action_group(&self) -> &str

The action group that the API operation belongs to.

pub fn http_method(&self) -> Option<&str>

The HTTP method of the API operation.

pub fn api_path(&self) -> Option<&str>

The path to the API operation.

pub fn parameters(&self) -> &[ApiParameter]

The parameters to provide for the API request, as the agent elicited from the user.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .parameters.is_none().

pub fn request_body(&self) -> Option<&ApiRequestBody>

The request body to provide for the API request, as the agent elicited from the user.

pub fn action_invocation_type(&self) -> Option<&ActionInvocationType>

Contains information about the API operation to invoke.

pub fn agent_id(&self) -> Option<&str>

The agent's ID.

pub fn collaborator_name(&self) -> Option<&str>

The agent collaborator's name.

impl ApiInvocationInput

pub fn builder() -> ApiInvocationInputBuilder

Creates a new builder-style object to manufacture ApiInvocationInput.

Trait Implementations

impl Clone for ApiInvocationInput

fn clone(&self) -> ApiInvocationInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiInvocationInput

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

Formats the value using the given formatter.

impl PartialEq for ApiInvocationInput

fn eq(&self, other: &ApiInvocationInput) -> 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 ApiInvocationInput