Skip to content

Latest commit

 

History

History
220 lines (150 loc) · 6.23 KB

Check.md

File metadata and controls

220 lines (150 loc) · 6.23 KB

Check

Method HTTP request Release Stage
create POST /v2/dataHealth/checks Public Beta
delete DELETE /v2/dataHealth/checks/{checkRid} Public Beta
get GET /v2/dataHealth/checks/{checkRid} Public Beta
replace PUT /v2/dataHealth/checks/{checkRid} Public Beta

create

Creates a new Check.

Parameters

Name Type Description Notes
config CheckConfig
intent Optional[CheckIntent] [optional]
preview Optional[PreviewMode] Enables the use of preview functionality. [optional]

Return type

Check

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# CheckConfig
config = None
# Optional[CheckIntent]
intent = "Check to ensure builds are passing."
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.data_health.Check.create(config=config, intent=intent, preview=preview)
    print("The create response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Check.create: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 Check The created Check application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

Delete the Check with the specified rid.

Parameters

Name Type Description Notes
check_rid CheckRid
preview Optional[PreviewMode] Enables the use of preview functionality. [optional]

Return type

None

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# CheckRid
check_rid = "ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.data_health.Check.delete(check_rid, preview=preview)
    print("The delete response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Check.delete: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
204 None None

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get

Get the Check with the specified rid.

Parameters

Name Type Description Notes
check_rid CheckRid
preview Optional[PreviewMode] Enables the use of preview functionality. [optional]

Return type

Check

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# CheckRid
check_rid = "ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.data_health.Check.get(check_rid, preview=preview)
    print("The get response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Check.get: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 Check application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replace

Replace the Check with the specified rid. Changing the type of a check after it has been created is not supported.

Parameters

Name Type Description Notes
check_rid CheckRid
config ReplaceCheckConfig
intent Optional[CheckIntent] [optional]
preview Optional[PreviewMode] Enables the use of preview functionality. [optional]

Return type

Check

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# CheckRid
check_rid = "ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3"
# ReplaceCheckConfig
config = None
# Optional[CheckIntent]
intent = "Check to ensure builds are passing."
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.data_health.Check.replace(
        check_rid, config=config, intent=intent, preview=preview
    )
    print("The replace response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Check.replace: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 Check The replaced Check application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]