snowflake.core.alert.Alert | Snowflake Documentation (original) (raw)

class snowflake.core.alert.Alert(*, name: Annotated[str, Strict(strict=True)], comment: Annotated[str, Strict(strict=True)] | None = None, schedule: Schedule, warehouse: Annotated[str, Strict(strict=True)] | None = None, condition: Annotated[str, Strict(strict=True)], action: Annotated[str, Strict(strict=True)], created_on: datetime | None = None, database_name: Annotated[str, Strict(strict=True)] | None = None, schema_name: Annotated[str, Strict(strict=True)] | None = None, owner: Annotated[str, Strict(strict=True)] | None = None, owner_role_type: Annotated[str, Strict(strict=True)] | None = None, state: Annotated[str, Strict(strict=True)] | None = None)¶

Bases: BaseModel

A model object representing the Alert resource.

Constructs an object of type Alert with the provided properties.

Parameters:

• name (str) – Name of the alert
• schedule (Schedule)
• condition (str) – The SQL statement that must be evaluated to determine whether to trigger the alert
• action (str) – The SQL statement to execute when the alert is triggered
• comment (str , optional) – user comment associated to an object in the dictionary
• warehouse (str , optional) – The warehouse the alert runs in
• created_on (datetime , optional) – Date and time when the alert was created.
• database_name (str , optional) – Database in which the alert is stored
• schema_name (str , optional) – Schema in which the alert is stored
• owner (str , optional) – Role that owns the alert
• owner_role_type (str , optional) – The type of role that owns the alert
• state (str , optional) – The current state of the alert

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) → Alert¶

Create an instance of Alert from a dict.

classmethod from_json(json_str: str) → Alert¶

Create an instance of Alert 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.