snowflake.core.service.Service

class snowflake.core.service.Service(*, name: Annotated[str, Strict(strict=True)], status: Annotated[str, Strict(strict=True)] | None = None, compute_pool: Annotated[str, Strict(strict=True)], spec: ServiceSpec, external_access_integrations: List[Annotated[str, Strict(strict=True)]] | None = None, query_warehouse: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, comment: Annotated[str, Strict(strict=True)] | None = None, is_async_job: Annotated[bool, Strict(strict=True)] | None = None, auto_resume: Annotated[bool, Strict(strict=True)] | None = None, current_instances: Annotated[int, Strict(strict=True)] | None = None, target_instances: Annotated[int, Strict(strict=True)] | None = None, min_ready_instances: Annotated[int, Strict(strict=True)] | None = None, min_instances: Annotated[int, Strict(strict=True)] | None = None, max_instances: Annotated[int, Strict(strict=True)] | 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, Strict(strict=True)] | None = None, dns_name: Annotated[str, Strict(strict=True)] | None = None, created_on: datetime | None = None, updated_on: datetime | None = None, resumed_on: datetime | None = None, suspended_on: datetime | None = None, auto_suspend_secs: Annotated[int, Strict(strict=True)] | None = None, owner_role_type: Annotated[str, Strict(strict=True)] | None = None, is_job: Annotated[bool, Strict(strict=True)] | None = None, spec_digest: Annotated[str, Strict(strict=True)] | None = None, is_upgrading: Annotated[bool, Strict(strict=True)] | None = None, managing_object_domain: Annotated[str, Strict(strict=True)] | None = None, managing_object_name: Annotated[str, Strict(strict=True)] | None = None)

Bases: BaseModel

A model object representing the Service resource.

Constructs an object of type Service with the provided properties.

Parameters:

  • name (str) – 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.

  • compute_pool (str) – Specifies the name of the compute pool in your account on which to run the service.

  • spec (ServiceSpec)

statusstr, optional

The current status of the service.

external_access_integrationslist[str], optional

Specifies the names of the external access integrations that allow your service to access external sites.

query_warehousestr, 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.

commentstr, optional

Specifies a comment for the service.

is_async_jobbool, optional

True if the service is an async job service; false otherwise.

auto_resumebool, optional

Specifies whether to automatically resume a service when a service function or ingress is called.

current_instancesint, optional

The current number of instances for the service.

target_instancesint, optional

The target number of service instances that should be running as determined by Snowflake.

min_ready_instancesint, optional

The minimum number of ready service instances to declare the service as READY.

min_instancesint, optional

Specifies the minimum number of service instances to run.

max_instancesint, optional

Specifies the maximum number of service instances to run.

database_namestr, 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.

schema_namestr, 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.

ownerstr, optional

Role that owns the service.

dns_namestr, optional

Snowflake-assiged DNS name of the service. The DNS name enables service-to-service communications.

created_ondatetime, optional

Timestamp when the service was created.

updated_ondatetime, optional

Timestamp when the service was last updated.

resumed_ondatetime, optional

Timestamp when the service was last resumed.

suspended_ondatetime, optional

Timestamp when the service was last suspended.

auto_suspend_secsint, optional

Number of seconds of inactivity after which the service will be automatically suspended. The default value is 0 which represents the service will not be automatically suspended.

owner_role_typestr, optional

The role type of the service owner.

is_jobbool, optional

True if the service is a job service; false otherwise.

spec_digeststr, optional

The unique and immutable identifier representing the service spec content.

is_upgradingbool, optional

TRUE, if Snowflake is in the process of upgrading the service.

managing_object_domainstr, optional

The domain of the managing object (for example, the domain of the notebook that manages the service). NULL if the service is not managed by a Snowflake entity.

managing_object_namestr, optional

The name of the managing object (for example, the name of the notebook that manages the service). NULL if the service is not managed by a Snowflake entity.

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

Create an instance of Service from a dict.

classmethod from_json(json_str: str) → Service

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