snowflake.core.function.FunctionΒΆ

class snowflake.core.function.Function(*, name: Annotated[str, Strict(strict=True)], arguments: List[FunctionArgument], returns: Annotated[str, Strict(strict=True)] | None = 'TEXT', max_batch_rows: Annotated[int, Strict(strict=True)] | None = None, created_on: datetime | None = None, signature: Annotated[str, Strict(strict=True)] | None = None, language: Annotated[str, Strict(strict=True)] | None = None, body: Annotated[str, Strict(strict=True)] | None = None)ΒΆ

Bases: BaseModel

A model object representing the Function resource.

Constructs an object of type Function with the provided properties.

Parameters:

  • name (str) – Specifies the name for the function, must be unique for the schema in which the function is created

  • arguments (list[FunctionArgument])

  • returns (str, default 'TEXT') – Specifies the type for the function return value.

  • max_batch_rows (int, optional) – Specifies the max rows for batch operation.

  • created_on (datetime, optional) – Date and time when the function was created.

  • signature (str, optional) – Function’s arguments.

  • language (str, optional) – Function’s language.

  • body (str, optional) – Function’s body.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

classmethod from_dict(obj: dict) β†’ ServiceFunctionΒΆ

Create an instance of Function from a dict.

classmethod from_json(json_str: str) β†’ ServiceFunctionΒΆ

Create an instance of Function from a JSON string.

to_dict(hide_readonly_properties: bool = False) β†’ dict[str, Any]ΒΆ

Returns the dictionary representation of the model using alias.

to_dict_without_readonly_properties() β†’ dict[str, Any]ΒΆ

Return the dictionary representation of the model without readonly properties.

to_json() β†’ strΒΆ

Returns the JSON representation of the model using alias.

to_str() β†’ strΒΆ

Returns the string representation of the model using alias.

Language: English