gs_interactive.AdminServiceJobManagementApi¶

All URIs are relative to {INTERACTIVE_ADMIN_ENDPOINT}

Method	HTTP request	Description
CancelJob	DELETE /v1/job/{job_id}	Cancell the job with specified jobId
GetJobById	GET /v1/job/{job_id}	Get the metadata of the job with specified jobId
ListJobs	GET /v1/job	List all jobs(including history jobs)

CancelJob¶

Result[str] cancel_job(job_id)

Example¶

from gs_interactive.client.driver import Driver
from gs_interactive.client.session import Session
from gs_interactive.models import *

driver = Driver()
sess = driver.session()

# loading_resp = sess.bulk_loading(graph_id, bulk_load_request)
# job_id = resp.get_value().job_id
resp = sess.cancel_job(job_id)
assert resp.is_ok()
print("cancel job resp", resp)

Parameters¶

Name	Type	Description	Notes
job_id	str

Return type¶

str

Authorization¶

No authorization required

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Successful operation	-

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

GetJobById¶

Result[JobStatus] get_job(job_id)

Example¶

resp = sess.get_job(job_id)
assert resp.is_ok()
status = resp.get_value().status
print("job status: ", status)

Parameters¶

Name	Type	Description	Notes
job_id	str	The id of the job, returned from POST /v1/graph/{graph_id}/dataloading

Return type¶

JobStatus

Authorization¶

No authorization required

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	successful operation	-

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

ListJobs¶

Result[List[JobStatus]] list_jobs()

Example¶

resp = sess.list_jobs(job_id)
assert resp.is_ok()
print("list job resp: ", resp)

Parameters¶

This endpoint does not need any parameter.

Return type¶

List[JobStatus]

Authorization¶

No authorization required

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	successful operation	-

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