Skip to content
Qualia Docs

Checks_GetAutomaticCheckPolicy_Dataset

GET
/v1/accounts/{account}/datasets/{dataset}/checkPolicies/{checkPolicy}
 
curl --request GET \
  --url https://junction-api.qualiastudios.dev/v1/accounts/example/datasets/example/checkPolicies/example \
  --header 'X-API-Key: <X-API-Key>'

Reads the effective policy and its source for each scheduler half.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
account
required
string

The account id.

dataset
required
string

The dataset id.

checkPolicy
required
string

The checkPolicy id.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Automatic checks policy is per scheduler half, not per catalog check id. Inheritance never queues or replays a run: only a new upload is checked.

object
name

The automatic policy under an org, workspace or dataset.

string
heuristicEnabled

Whether the scheduler runs the free heuristic half.

boolean
heuristicSource

Which level supplied the heuristic setting: platform, org, workspace or dataset.

string
graphEnabled

Whether the scheduler runs the paid graph half.

boolean
graphSource

Which level supplied the graph setting: platform, org, workspace or dataset.

string
heuristic

The heuristic override at this level; SETTING_UNSPECIFIED clears it.

string format: enum
Allowed values: SETTING_UNSPECIFIED ENABLED DISABLED
graph

The graph override at this level; SETTING_UNSPECIFIED clears it.

string format: enum
Allowed values: SETTING_UNSPECIFIED ENABLED DISABLED
Example 
{
  "heuristic": "SETTING_UNSPECIFIED",
  "graph": "SETTING_UNSPECIFIED"
}

default

Section titled “default ”

Default error response

Media type application/json
One of:
API error

A refusal from the API itself.

object
code
required

The gRPC code name in upper case, e.g. NOT_FOUND.

string
message
required
string
retryable
required

Whether the same call may succeed if retried.

boolean
details
required

Empty, except when a dataset copy or move is refused: then one google.rpc.ErrorInfo with the refusal’s reason code, its domain and, in metadata, the datasets it names.

Array<object>
object
Example generated
{
  "code": "example",
  "message": "example",
  "retryable": true,
  "details": [
    {}
  ]
}