Skip to content

Latest commit

 

History

History
109 lines (72 loc) · 3.13 KB

Job.md

File metadata and controls

109 lines (72 loc) · 3.13 KB

Job

Method HTTP request Release Stage
get GET /v2/orchestration/jobs/{jobRid} Public Beta
get_batch POST /v2/orchestration/jobs/getBatch Public Beta

get

Get the Job with the specified rid.

Parameters

Name Type Description Notes
job_rid JobRid The RID of a Job.
preview Optional[PreviewMode] Enables the use of preview functionality. [optional]

Return type

Job

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

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

# JobRid | The RID of a Job.
job_rid = "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


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

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 Job application/json

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

get_batch

Execute multiple get requests on Job.

The maximum batch size for this endpoint is 500.

Parameters

Name Type Description Notes
body List[GetJobsBatchRequestElement] Body of the request
preview Optional[PreviewMode] Enables the use of preview functionality. [optional]

Return type

GetJobsBatchResponse

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

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

# List[GetJobsBatchRequestElement] | Body of the request
body = [{"jobRid": "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448"}]
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.orchestration.Job.get_batch(body, preview=preview)
    print("The get_batch response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Job.get_batch: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 GetJobsBatchResponse application/json

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