Struct Function 

pub struct Function {

    pub name: String,
    pub catalog_name: String,
    pub schema_name: String,
    pub full_name: String,
    pub data_type: String,
    pub full_data_type: String,
    pub input_params: MessageField<FunctionParameterInfos>,
    pub return_params: Option<String>,
    pub routine_body_language: Option<String>,
    pub routine_definition: Option<String>,
    pub routine_dependencies: Option<String>,
    pub parameter_style: EnumValue<ParameterStyle>,
    pub is_deterministic: bool,
    pub sql_data_access: EnumValue<SqlDataAccess>,
    pub is_null_call: bool,
    pub security_type: EnumValue<SecurityType>,
    pub specific_name: Option<String>,
    pub routine_body: EnumValue<RoutineBody>,
    pub comment: Option<String>,
    pub properties: HashMap<String, String>,
    pub owner: Option<String>,
    pub function_id: Option<String>,
    pub created_at: Option<i64>,
    pub created_by: Option<String>,
    pub updated_at: Option<i64>,
    pub updated_by: Option<String>,
    /* private fields */
}

A User-Defined Function (UDF) registered under a catalog + schema hierarchy.

Fields

name: String

Name of function, relative to parent schema.

Field 1: name

catalog_name: String

Name of parent catalog.

Field 2: catalog_name

schema_name: String

Name of parent schema.

Field 3: schema_name

full_name: String

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

Format: catalog_name.schema_name.function_name

Field 4: full_name

data_type: String

Full data type specification of the return type of the function.

Field 5: data_type

full_data_type: String

Full data type specification as SQL/catalogString text.

Field 6: full_data_type

input_params: MessageField<FunctionParameterInfos>

The array of function parameter infos.

Field 7: input_params

return_params: Option<String>

The return type of the function in JSON format.

Field 8: return_params

routine_body_language: Option<String>

The language of the function routine body.

Field 9: routine_body_language

routine_definition: Option<String>

Function body.

Field 10: routine_definition

routine_dependencies: Option<String>

Function dependencies (in JSON form).

Field 11: routine_dependencies

parameter_style: EnumValue<ParameterStyle>

The parameter-passing style.

Field 12: parameter_style

is_deterministic: bool

Indicates whether the function is deterministic.

Field 13: is_deterministic

sql_data_access: EnumValue<SqlDataAccess>

SQL data access information.

Field 14: sql_data_access

is_null_call: bool

Indicates whether the function is null-calling.

Field 15: is_null_call

security_type: EnumValue<SecurityType>

The security type of the function.

Field 16: security_type

specific_name: Option<String>

The type of the function (SCALAR or TABLE).

Field 17: specific_name

routine_body: EnumValue<RoutineBody>

The routine body.

Field 18: routine_body

comment: Option<String>

User-provided free-form text description.

Field 19: comment

properties: HashMap<String, String>

A map of key-value properties attached to the securable.

Field 20: properties

owner: Option<String>

Username of current owner of the function.

Field 21: owner

function_id: Option<String>

Unique identifier for the function.

Field 22: function_id

created_at: Option<i64>

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

Field 1000: created_at

created_by: Option<String>

Username of function creator.

Field 1001: created_by

updated_at: Option<i64>

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

Field 1002: updated_at

updated_by: Option<String>

Username of user who last modified the function.

Field 1003: updated_by

Implementations

impl Function

pub fn qualified_name(&self) -> String

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

impl Function

pub const TYPE_URL: &'static str = "type.googleapis.com/unitycatalog.functions.v1.Function"

Protobuf type URL for this message, for use with Any::pack and Any::unpack_if.

Format: type.googleapis.com/<fully.qualified.TypeName>

impl Function

pub fn with_return_params(self, value: impl Into<String>) -> Self

Sets Self::return_params to Some(value), consuming and returning self.

pub fn with_routine_body_language(self, value: impl Into<String>) -> Self

Sets Self::routine_body_language to Some(value), consuming and returning self.

pub fn with_routine_definition(self, value: impl Into<String>) -> Self

Sets Self::routine_definition to Some(value), consuming and returning self.

pub fn with_routine_dependencies(self, value: impl Into<String>) -> Self

Sets Self::routine_dependencies to Some(value), consuming and returning self.

pub fn with_specific_name(self, value: impl Into<String>) -> Self

Sets Self::specific_name to Some(value), consuming and returning self.

pub fn with_comment(self, value: impl Into<String>) -> Self

Sets Self::comment to Some(value), consuming and returning self.

pub fn with_owner(self, value: impl Into<String>) -> Self

Sets Self::owner to Some(value), consuming and returning self.

pub fn with_function_id(self, value: impl Into<String>) -> Self

Sets Self::function_id to Some(value), consuming and returning self.

pub fn with_created_at(self, value: i64) -> Self

Sets Self::created_at to Some(value), consuming and returning self.

pub fn with_created_by(self, value: impl Into<String>) -> Self

Sets Self::created_by to Some(value), consuming and returning self.

pub fn with_updated_at(self, value: i64) -> Self

Sets Self::updated_at to Some(value), consuming and returning self.

pub fn with_updated_by(self, value: impl Into<String>) -> Self

Sets Self::updated_by to Some(value), consuming and returning self.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Default for Function

fn default() -> Function

Returns the “default value” for a type.

impl DefaultInstance for Function

fn default_instance() -> &'static Self

Return a reference to the single default instance of this type.

impl<'de> Deserialize<'de> for Function

where Function: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExtensionSet for Function

const PROTO_FQN: &'static str = "unitycatalog.functions.v1.Function"

Fully-qualified proto type name of this message (no leading dot), e.g. "google.protobuf.FieldOptions".

fn unknown_fields(&self) -> &UnknownFields

Immutable access to the extendee’s unknown-field storage.

fn unknown_fields_mut(&mut self) -> &mut UnknownFields

Mutable access to the extendee’s unknown-field storage.

fn extension<C>(&self, ext: &Extension<C>) -> <C as ExtensionCodec>::Output

where C: ExtensionCodec,

Read an extension value.

fn set_extension<C>( &mut self, ext: &Extension<C>, value: <C as ExtensionCodec>::Value, )

where C: ExtensionCodec,

Write an extension value, replacing any prior occurrences.

fn has_extension<C>(&self, ext: &Extension<C>) -> bool

where C: ExtensionCodec,

Returns true if any record at the extension’s field number is present.

fn clear_extension<C>(&mut self, ext: &Extension<C>)

where C: ExtensionCodec,

Remove all records at the extension’s field number.

fn extension_or_default<C>( &self, ext: &Extension<C>, ) -> <C as ExtensionCodec>::Value

where C: ExtensionCodec<Output = Option<<C as ExtensionCodec>::Value>>, <C as ExtensionCodec>::Value: Default,

Read a singular extension value, returning the proto2 [default = ...] value if absent, or the type’s Default if no proto default was declared.

impl From<Function> for Resource

fn from(v: Function) -> Self

Converts to this type from the input type.

impl HasMessageView for Function

type View<'a> = FunctionView<'a>

The zero-copy view of Self, borrowing from a buffer with lifetime 'a.

type ViewHandle = FunctionOwnedView

The generated 'static owned-view handle for Self (FooOwnedView).

fn decode_view_handle(bytes: Bytes) -> Result<Self::ViewHandle, DecodeError>

Decode a ViewHandle from a Bytes buffer.

fn decode_view_handle_with_options( bytes: Bytes, opts: &DecodeOptions, ) -> Result<Self::ViewHandle, DecodeError>

Decode a ViewHandle with custom DecodeOptions (recursion limit, max message size).

impl Message for Function

fn compute_size(&self, __cache: &mut SizeCache) -> u32

Returns the total encoded size in bytes.

The result is a u32; the protobuf specification requires all messages to fit within 2 GiB (2,147,483,647 bytes), so a compliant message will never overflow this type.

fn write_to(&self, __cache: &mut SizeCache, buf: &mut impl BufMut)

Write this message’s encoded bytes to a buffer, consuming nested-message sizes from cache (populated by a prior compute_size call on the same cache).

fn merge_field( &mut self, tag: Tag, buf: &mut impl Buf, depth: u32, ) -> Result<(), DecodeError>

Processes a single already-decoded tag and its associated field data from buf.

fn clear(&mut self)

Clear all fields to their default values.

fn encode(&self, buf: &mut impl BufMut)

Compute size, then write. This is the primary encoding API.

fn encode_with_cache(&self, cache: &mut SizeCache, buf: &mut impl BufMut)

Encode using a caller-supplied SizeCache, for reuse across many encodes in a hot loop. Clears the cache first.

fn encoded_len(&self) -> u32

Compute the encoded byte size of this message.

fn encode_length_delimited(&self, buf: &mut impl BufMut)

Encode this message as a length-delimited byte sequence.

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

Encode this message to a new Vec<u8>.

fn encode_to_bytes(&self) -> Bytes

Encode this message to a new bytes::Bytes.

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

where Self: Sized,

Decode a message from a buffer.

fn decode_from_slice(data: &[u8]) -> Result<Self, DecodeError>

where Self: Sized,

Decode a message from a byte slice.

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

where Self: Sized,

Decode a length-delimited message from a buffer.

fn merge_to_limit( &mut self, buf: &mut impl Buf, depth: u32, limit: usize, ) -> Result<(), DecodeError>

Merge fields from a buffer until buf.remaining() reaches limit.

fn merge_group( &mut self, buf: &mut impl Buf, depth: u32, field_number: u32, ) -> Result<(), DecodeError>

Merges a group-encoded message from buf, reading fields until an EndGroup tag with the given field_number is encountered.

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

Merge fields from a buffer into this message.

fn merge_from_slice(&mut self, data: &[u8]) -> Result<(), DecodeError>

Merge fields from a byte slice into this message.

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

Merge fields from a length-delimited sub-message payload into this message.

impl MessageName for Function

const PACKAGE: &'static str = "unitycatalog.functions.v1"

The protobuf package the message is declared in.

const NAME: &'static str = "Function"

The unqualified message name, with . between nesting levels.

const FULL_NAME: &'static str = "unitycatalog.functions.v1.Function"

The fully-qualified protobuf type name with no leading dot.

const TYPE_URL: &'static str = "type.googleapis.com/unitycatalog.functions.v1.Function"

The google.protobuf.Any.type_url form for this message.

impl PartialEq for Function

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

Equality operator ==.

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

Inequality operator !=.

impl ProtoElemJson for Function

fn serialize_proto_json<S: Serializer>( v: &Self, s: S, ) -> Result<S::Ok, S::Error>

Serialize this value with proto3 JSON semantics.

fn deserialize_proto_json<'de, D: Deserializer<'de>>( d: D, ) -> Result<Self, D::Error>

Deserialize a value with proto3 JSON semantics.

impl ResourceExt for Function

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 Function

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 Function

impl TryFrom<Function> for Object

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Object<ObjectLabel>> for Function

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 Function

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.