Snowflake · Schema

JobService

A Snowflake job service object.

Data LakesData SharingData WarehousingDatabaseSQL

Properties

Name	Type	Description
name	object	String that specifies the identifier (that is, the name) for the service.
status	string	The current status of the service.
compute_pool	string	Specifies the name of the compute pool in your account on which to run the service.
spec	object	Specifies service specification.
external_access_integrations	array	Specifies the names of the external access integrations that allow your service to access external sites.
query_warehouse	object	Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use.
comment	string	Specifies a comment for the service.
is_async_job	boolean	True if the service is an async job service; false otherwise.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/JobService",
  "title": "JobService",
  "type": "object",
  "description": "A Snowflake job service object.",
  "writeOnly": true,
  "properties": {
    "name": {
      "$ref": "./common.yaml#/components/schemas/Identifier",
      "description": "String that specifies the identifier (that is, the name) for the service."
    },
    "status": {
      "type": "string",
      "description": "The current status of the service.",
      "example": "example_value"
    },
    "compute_pool": {
      "type": "string",
      "description": "Specifies the name of the compute pool in your account on which to run the service.",
      "example": "example_value"
    },
    "spec": {
      "$ref": "#/components/schemas/ServiceSpec",
      "description": "Specifies service specification."
    },
    "external_access_integrations": {
      "type": "array",
      "description": "Specifies the names of the external access integrations that allow your service to access external sites.",
      "items": {
        "type": "string"
      },
      "example": []
    },
    "query_warehouse": {
      "$ref": "./common.yaml#/components/schemas/Identifier",
      "description": "Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use."
    },
    "comment": {
      "type": "string",
      "description": "Specifies a comment for the service.",
      "example": "example_value"
    },
    "is_async_job": {
      "type": "boolean",
      "description": "True if the service is an async job service; false otherwise.",
      "example": true
    }
  },
  "required": [
    "name",
    "compute_pool",
    "spec"
  ],
  "example": {
    "name": "service_name",
    "compute_pool": "compute_pool_name",
    "spec": {
      "spec_type": "from_file",
      "stage": "@stage_name",
      "spec_file": "spec_file.yaml"
    }
  }
}