seldon_deploy_sdk.BatchJobsApi

All URIs are relative to http://X.X.X.X/seldon-deploy/api/v1alpha1

Method	HTTP request	Description
create_pipeline_batch_job	POST /namespaces/{namespace}/pipelines/{name}/batchjobs
create_seldon_deployment_batch_job	POST /namespaces/{namespace}/seldondeployments/{name}/batchjobs
get_deployment_batch_job	GET /namespaces/{namespace}/seldondeployments/{name}/batchjobs/{jobName}
get_pipeline_batch_job	GET /namespaces/{namespace}/pipelines/{name}/batchjobs/{jobName}
list_pipeline_batch_jobs	GET /namespaces/{namespace}/pipelines/{name}/batchjobs
list_seldon_deployment_batch_jobs	GET /namespaces/{namespace}/seldondeployments/{name}/batchjobs

create_pipeline_batch_job

BatchJobPostResponse create_pipeline_batch_job(name, namespace, workflow)

Create the pipeline batch jobs

Example

from __future__ import print_function
import time
import seldon_deploy_sdk
from seldon_deploy_sdk.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.BatchJobsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
workflow = seldon_deploy_sdk.BatchJobDefinition() # BatchJobDefinition | WorkflowName

try:
    api_response = api_instance.create_pipeline_batch_job(name, namespace, workflow)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BatchJobsApi->create_pipeline_batch_job: %s\n" % e)

Parameters

Name	Type	Description
name	str	Name identifies a resource
namespace	str	Namespace provides a logical grouping of resources
workflow	BatchJobDefinition	WorkflowName

Return type

BatchJobPostResponse

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

create_seldon_deployment_batch_job

BatchJobPostResponse create_seldon_deployment_batch_job(name, namespace, workflow)

Create the seldondeployment's batch jobs

Example

from __future__ import print_function
import time
import seldon_deploy_sdk
from seldon_deploy_sdk.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.BatchJobsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
workflow = seldon_deploy_sdk.BatchJobDefinition() # BatchJobDefinition | WorkflowName

try:
    api_response = api_instance.create_seldon_deployment_batch_job(name, namespace, workflow)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BatchJobsApi->create_seldon_deployment_batch_job: %s\n" % e)

Parameters

Name	Type	Description
name	str	Name identifies a resource
namespace	str	Namespace provides a logical grouping of resources
workflow	BatchJobDefinition	WorkflowName

Return type

BatchJobPostResponse

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

get_deployment_batch_job

BatchJobGetResponse get_deployment_batch_job(name, namespace, job_name)

Get details on the seldondeployment's batch job

Example

from __future__ import print_function
import time
import seldon_deploy_sdk
from seldon_deploy_sdk.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.BatchJobsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
job_name = 'job_name_example' # str | JobName identifies a job name

try:
    api_response = api_instance.get_deployment_batch_job(name, namespace, job_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BatchJobsApi->get_deployment_batch_job: %s\n" % e)

Parameters

Name	Type	Description
name	str	Name identifies a resource
namespace	str	Namespace provides a logical grouping of resources
job_name	str	JobName identifies a job name

Return type

BatchJobGetResponse

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

get_pipeline_batch_job

BatchJobGetResponse get_pipeline_batch_job(name, namespace, job_name)

Get details on the pipeline batch job

Example

from __future__ import print_function
import time
import seldon_deploy_sdk
from seldon_deploy_sdk.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.BatchJobsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
job_name = 'job_name_example' # str | JobName identifies a job name

try:
    api_response = api_instance.get_pipeline_batch_job(name, namespace, job_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BatchJobsApi->get_pipeline_batch_job: %s\n" % e)

Parameters

Name	Type	Description
name	str	Name identifies a resource
namespace	str	Namespace provides a logical grouping of resources
job_name	str	JobName identifies a job name

Return type

BatchJobGetResponse

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

list_pipeline_batch_jobs

BatchJobsListResponse list_pipeline_batch_jobs(name, namespace, limit=limit, page=page)

Read the pipeline batch jobs

Example

from __future__ import print_function
import time
import seldon_deploy_sdk
from seldon_deploy_sdk.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.BatchJobsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
limit = 'limit_example' # str | Limit of items returned in one response (optional)
page = 'page_example' # str | Requested page (optional)

try:
    api_response = api_instance.list_pipeline_batch_jobs(name, namespace, limit=limit, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BatchJobsApi->list_pipeline_batch_jobs: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	Name identifies a resource
namespace	str	Namespace provides a logical grouping of resources
limit	str	Limit of items returned in one response	[optional]
page	str	Requested page	[optional]

Return type

BatchJobsListResponse

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

list_seldon_deployment_batch_jobs

BatchJobsListResponse list_seldon_deployment_batch_jobs(name, namespace, limit=limit, page=page)

Read the seldondeployment's batch jobs

Example

from __future__ import print_function
import time
import seldon_deploy_sdk
from seldon_deploy_sdk.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.BatchJobsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
limit = 'limit_example' # str | Limit of items returned in one response (optional)
page = 'page_example' # str | Requested page (optional)

try:
    api_response = api_instance.list_seldon_deployment_batch_jobs(name, namespace, limit=limit, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BatchJobsApi->list_seldon_deployment_batch_jobs: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	Name identifies a resource
namespace	str	Namespace provides a logical grouping of resources
limit	str	Limit of items returned in one response	[optional]
page	str	Requested page	[optional]

Return type

BatchJobsListResponse

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

BatchJobsApi.md

Latest commit

History

BatchJobsApi.md

File metadata and controls

seldon_deploy_sdk.BatchJobsApi

create_pipeline_batch_job

Example

Parameters

Return type

Authorization

HTTP request headers

create_seldon_deployment_batch_job

Example

Parameters

Return type

Authorization

HTTP request headers

get_deployment_batch_job

Example

Parameters

Return type

Authorization

HTTP request headers

get_pipeline_batch_job

Example

Parameters

Return type

Authorization

HTTP request headers

list_pipeline_batch_jobs

Example

Parameters

Return type

Authorization

HTTP request headers

list_seldon_deployment_batch_jobs

Example

Parameters

Return type

Authorization

HTTP request headers