Struct Agent 

pub struct Agent {

    pub name: String,
    pub catalog_name: String,
    pub schema_name: String,
    pub full_name: String,
    pub agent_id: String,
    pub invocation_protocol: i32,
    pub endpoint: String,
    pub description: Option<String>,
    pub capabilities: Vec<String>,
    pub input_schema: Option<String>,
    pub owner: Option<String>,
    pub comment: Option<String>,
    pub created_at: Option<i64>,
    pub created_by: Option<String>,
    pub updated_at: Option<i64>,
    pub updated_by: Option<String>,
    pub metastore_id: Option<String>,
}

An agent registered in Unity Catalog.

Fields

name: String

Name of the agent, relative to parent schema.

catalog_name: String

Name of parent catalog.

schema_name: String

Name of parent schema.

full_name: String

The three-level (fully qualified) name of the agent.

agent_id: String

The unique identifier of the agent.

invocation_protocol: i32

The protocol a recipient uses to invoke the agent.

endpoint: String

The agent’s invocation endpoint URL.

description: Option<String>

An LLM-readable description of what the agent does and the inputs it expects.

capabilities: Vec<String>

Capability identifiers advertised by the agent (e.g. sql_query, document_search, code_execution).

input_schema: Option<String>

A JSON Schema (encoded as a JSON string) describing the agent’s expected input payload. Kept as an opaque string so the schema can evolve without changing this message.

owner: Option<String>

Username of current owner of the agent.

comment: Option<String>

User-provided free-form text description.

created_at: Option<i64>

Time at which this agent was created, in epoch milliseconds.

created_by: Option<String>

Username of agent creator.

updated_at: Option<i64>

Time at which this agent was last updated, in epoch milliseconds.

updated_by: Option<String>

Username of user who last modified the agent.

metastore_id: Option<String>

The unique identifier of the metastore.

Implementations

impl Agent

pub fn qualified_name(&self) -> String

Returns the fully-qualified dot-separated name computed from component fields.

impl Agent

pub fn invocation_protocol(&self) -> InvocationProtocol

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

pub fn set_invocation_protocol(&mut self, value: InvocationProtocol)

Sets invocation_protocol to the provided enum value.

pub fn description(&self) -> &str

Returns the value of description, or the default value if description is unset.

pub fn input_schema(&self) -> &str

Returns the value of input_schema, or the default value if input_schema is unset.

pub fn owner(&self) -> &str

Returns the value of owner, or the default value if owner is unset.

pub fn comment(&self) -> &str

Returns the value of comment, or the default value if comment is unset.

pub fn created_at(&self) -> i64

Returns the value of created_at, or the default value if created_at is unset.

pub fn created_by(&self) -> &str

Returns the value of created_by, or the default value if created_by is unset.

pub fn updated_at(&self) -> i64

Returns the value of updated_at, or the default value if updated_at is unset.

pub fn updated_by(&self) -> &str

Returns the value of updated_by, or the default value if updated_by is unset.

pub fn metastore_id(&self) -> &str

Returns the value of metastore_id, or the default value if metastore_id is unset.

Trait Implementations

impl Clone for Agent

fn clone(&self) -> Agent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Agent

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

Formats the value using the given formatter.

impl Default for Agent

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Agent

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Agent

impl From<Agent> for Resource

fn from(v: Agent) -> Self

Converts to this type from the input type.

impl Hash for Agent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for Agent

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 Agent

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

Equality operator ==.

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

Inequality operator !=.

impl ResourceExt for Agent

fn resource_name(&self) -> ResourceName

Get the name of the resource

fn resource_ref(&self) -> ResourceRef

Get the reference for the resource

fn resource_ident(&self) -> ResourceIdent

Get the ident for the resource

impl Serialize for Agent

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Agent

impl TryFrom<Agent> for Object

type Error = Error

The type returned in the event of a conversion error.

fn try_from(obj: Agent) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Object<ObjectLabel>> for Agent

type Error = Error

The type returned in the event of a conversion error.

fn try_from(object: Object) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Resource> for Agent

type Error = Error

The type returned in the event of a conversion error.

fn try_from(r: Resource) -> Result<Self, Self::Error>

Performs the conversion.