snowflake.core.network_rule.NetworkRule

class snowflake.core.network_rule.NetworkRule(*, type: Annotated[str, Strict(strict=True)], mode: Annotated[str, Strict(strict=True)] | None = None, value_list: List[Annotated[str, Strict(strict=True)]] | None = None, comment: Annotated[str, Strict(strict=True)] | None = None, name: Annotated[str, Strict(strict=True)], created_on: datetime | None = None, database_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, schema_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, owner: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, owner_role_type: Annotated[str, Strict(strict=True)] | None = None)

Bases: BaseModel

A model object representing the NetworkRule resource.

Constructs an object of type NetworkRule with the provided properties.

Parameters:

  • type (str) – Type of the network rule

  • name (str) – Name of the network rule

  • mode (str, optional) – Specifies what is restricted by the network rule. Possible values: INGRESS, INTERNAL_STAGE, EGRESS

  • value_list (list[str], optional) – List of values in a network rule

  • comment (str, optional) – Comment for the network rule

  • created_on (datetime, optional) – Date and time when the network rule was created

  • database_name (str, optional) – Database in which the network rule is stored

  • schema_name (str, optional) – Schema in which the network rule is stored

  • owner (str, optional) – Role that owns the network rule

  • owner_role_type (str, optional) – The type of role that owns the network rule

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) → NetworkRule

Create an instance of NetworkRule from a dict.

classmethod from_json(json_str: str) → NetworkRule

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