snowflake.core.function.ServiceFunctionΒΆ
- class snowflake.core.function.ServiceFunction(*, 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, service: Annotated[str, Strict(strict=True)], service_database: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, service_schema: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, endpoint: Annotated[str, Strict(strict=True)], path: Annotated[str, Strict(strict=True)])ΒΆ
Bases:
Function
A model object representing the ServiceFunction resource.
Constructs an object of type ServiceFunction 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])
- servicestr
A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.
- endpointstr
Functionβs endpoint
- pathstr
Functionβs path
- returnsstr, default βTEXTβ
Specifies the type for the function return value.
- max_batch_rowsint, optional
Specifies the max rows for batch operation.
- created_ondatetime, optional
Date and time when the function was created.
- signaturestr, optional
Functionβs arguments.
- languagestr, optional
Functionβs language.
- bodystr, optional
Functionβs body.
- service_databasestr, optional
A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.
- service_schemastr, optional
A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.
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 ServiceFunction from a dict.
- classmethod from_json(json_str: str) ServiceFunction ΒΆ
Create an instance of ServiceFunction 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.