snowflake.core.service.ServiceEndpoint | Snowflake Documentation (original) (raw)

class snowflake.core.service.ServiceEndpoint(*, name: Annotated[str, Strict(strict=True)] | None = None, port: Annotated[int, Strict(strict=True)] | None = None, portRange: Annotated[str, Strict(strict=True)] | None = None, protocol: Annotated[str, Strict(strict=True)] | None = 'HTTP', is_public: Annotated[bool, Strict(strict=True)] | None = False, ingress_url: Annotated[str, Strict(strict=True)] | None = None)¶

Bases: BaseModel

A model object representing the ServiceEndpoint resource.

Constructs an object of type ServiceEndpoint with the provided properties.

Parameters:

• name (str , optional) – User-friendly endpoint name that represents the corresponding port.
• port (int , optional) – The network port the service is listening on. NULL, when portRange is specified.
• port_range (str , optional) – The network port range the service is listening on. NULL, when port is specified.
• protocol (str , default 'HTTP') – Supported network protocol (TCP, HTTP, or HTTPS).
• is_public (bool , default False) – True, if the endpoint is public, accessible from internet.
• ingress_url (str , optional) – Endpoint URL accessible from the internet.

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

Create an instance of ServiceEndpoint from a dict.

classmethod from_json(json_str: str) → ServiceEndpoint¶

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