@@ -4,11 +4,69 @@ All URIs are relative to *http://X.X.X.X/seldon-deploy/api/v1alpha1*
44
55Method | HTTP request | Description
66------------- | ------------- | -------------
7+ [ ** create_pipeline_batch_job** ] ( BatchJobsApi.md#create_pipeline_batch_job ) | ** POST** /namespaces/{namespace}/pipelines/{name}/batchjobs |
78[ ** create_seldon_deployment_batch_job** ] ( BatchJobsApi.md#create_seldon_deployment_batch_job ) | ** POST** /namespaces/{namespace}/seldondeployments/{name}/batchjobs |
89[ ** get_deployment_batch_job** ] ( BatchJobsApi.md#get_deployment_batch_job ) | ** GET** /namespaces/{namespace}/seldondeployments/{name}/batchjobs/{jobName} |
10+ [ ** get_pipeline_batch_job** ] ( BatchJobsApi.md#get_pipeline_batch_job ) | ** GET** /namespaces/{namespace}/pipelines/{name}/batchjobs/{jobName} |
11+ [ ** list_pipeline_batch_jobs** ] ( BatchJobsApi.md#list_pipeline_batch_jobs ) | ** GET** /namespaces/{namespace}/pipelines/{name}/batchjobs |
912[ ** list_seldon_deployment_batch_jobs** ] ( BatchJobsApi.md#list_seldon_deployment_batch_jobs ) | ** GET** /namespaces/{namespace}/seldondeployments/{name}/batchjobs |
1013
1114
15+ # ** create_pipeline_batch_job**
16+ > BatchJobPostResponse create_pipeline_batch_job(name, namespace, workflow)
17+
18+
19+
20+ Create the pipeline batch jobs
21+
22+ ### Example
23+ ``` python
24+ from __future__ import print_function
25+ import time
26+ import seldon_deploy_sdk
27+ from seldon_deploy_sdk.rest import ApiException
28+ from pprint import pprint
29+
30+ # Configure OAuth2 access token for authorization: OAuth2
31+ configuration = seldon_deploy_sdk.Configuration()
32+ configuration.access_token = ' YOUR_ACCESS_TOKEN'
33+
34+ # create an instance of the API class
35+ api_instance = seldon_deploy_sdk.BatchJobsApi(seldon_deploy_sdk.ApiClient(configuration))
36+ name = ' name_example' # str | Name identifies a resource
37+ namespace = ' namespace_example' # str | Namespace provides a logical grouping of resources
38+ workflow = seldon_deploy_sdk.BatchJobDefinition() # BatchJobDefinition | WorkflowName
39+
40+ try :
41+ api_response = api_instance.create_pipeline_batch_job(name, namespace, workflow)
42+ pprint(api_response)
43+ except ApiException as e:
44+ print (" Exception when calling BatchJobsApi->create_pipeline_batch_job: %s \n " % e)
45+ ```
46+
47+ ### Parameters
48+
49+ Name | Type | Description | Notes
50+ ------------- | ------------- | ------------- | -------------
51+ ** name** | ** str** | Name identifies a resource |
52+ ** namespace** | ** str** | Namespace provides a logical grouping of resources |
53+ ** workflow** | [ ** BatchJobDefinition** ] ( BatchJobDefinition.md ) | WorkflowName |
54+
55+ ### Return type
56+
57+ [ ** BatchJobPostResponse** ] ( BatchJobPostResponse.md )
58+
59+ ### Authorization
60+
61+ [ OAuth2] ( ../README.md#OAuth2 )
62+
63+ ### HTTP request headers
64+
65+ - ** Content-Type** : application/json
66+ - ** Accept** : application/json
67+
68+ [[ Back to top]] ( # ) [[ Back to API list]] ( ../README.md#documentation-for-api-endpoints ) [[ Back to Model list]] ( ../README.md#documentation-for-models ) [[ Back to README]] ( ../README.md )
69+
1270# ** create_seldon_deployment_batch_job**
1371> BatchJobPostResponse create_seldon_deployment_batch_job(name, namespace, workflow)
1472
@@ -119,6 +177,118 @@ Name | Type | Description | Notes
119177
120178[[ Back to top]] ( # ) [[ Back to API list]] ( ../README.md#documentation-for-api-endpoints ) [[ Back to Model list]] ( ../README.md#documentation-for-models ) [[ Back to README]] ( ../README.md )
121179
180+ # ** get_pipeline_batch_job**
181+ > BatchJobGetResponse get_pipeline_batch_job(name, namespace, job_name)
182+
183+
184+
185+ Get details on the pipeline batch job
186+
187+ ### Example
188+ ``` python
189+ from __future__ import print_function
190+ import time
191+ import seldon_deploy_sdk
192+ from seldon_deploy_sdk.rest import ApiException
193+ from pprint import pprint
194+
195+ # Configure OAuth2 access token for authorization: OAuth2
196+ configuration = seldon_deploy_sdk.Configuration()
197+ configuration.access_token = ' YOUR_ACCESS_TOKEN'
198+
199+ # create an instance of the API class
200+ api_instance = seldon_deploy_sdk.BatchJobsApi(seldon_deploy_sdk.ApiClient(configuration))
201+ name = ' name_example' # str | Name identifies a resource
202+ namespace = ' namespace_example' # str | Namespace provides a logical grouping of resources
203+ job_name = ' job_name_example' # str | JobName identifies a job name
204+
205+ try :
206+ api_response = api_instance.get_pipeline_batch_job(name, namespace, job_name)
207+ pprint(api_response)
208+ except ApiException as e:
209+ print (" Exception when calling BatchJobsApi->get_pipeline_batch_job: %s \n " % e)
210+ ```
211+
212+ ### Parameters
213+
214+ Name | Type | Description | Notes
215+ ------------- | ------------- | ------------- | -------------
216+ ** name** | ** str** | Name identifies a resource |
217+ ** namespace** | ** str** | Namespace provides a logical grouping of resources |
218+ ** job_name** | ** str** | JobName identifies a job name |
219+
220+ ### Return type
221+
222+ [ ** BatchJobGetResponse** ] ( BatchJobGetResponse.md )
223+
224+ ### Authorization
225+
226+ [ OAuth2] ( ../README.md#OAuth2 )
227+
228+ ### HTTP request headers
229+
230+ - ** Content-Type** : application/json
231+ - ** Accept** : application/json
232+
233+ [[ Back to top]] ( # ) [[ Back to API list]] ( ../README.md#documentation-for-api-endpoints ) [[ Back to Model list]] ( ../README.md#documentation-for-models ) [[ Back to README]] ( ../README.md )
234+
235+ # ** list_pipeline_batch_jobs**
236+ > BatchJobsListResponse list_pipeline_batch_jobs(name, namespace, limit=limit, page=page)
237+
238+
239+
240+ Read the pipeline batch jobs
241+
242+ ### Example
243+ ``` python
244+ from __future__ import print_function
245+ import time
246+ import seldon_deploy_sdk
247+ from seldon_deploy_sdk.rest import ApiException
248+ from pprint import pprint
249+
250+ # Configure OAuth2 access token for authorization: OAuth2
251+ configuration = seldon_deploy_sdk.Configuration()
252+ configuration.access_token = ' YOUR_ACCESS_TOKEN'
253+
254+ # create an instance of the API class
255+ api_instance = seldon_deploy_sdk.BatchJobsApi(seldon_deploy_sdk.ApiClient(configuration))
256+ name = ' name_example' # str | Name identifies a resource
257+ namespace = ' namespace_example' # str | Namespace provides a logical grouping of resources
258+ limit = ' limit_example' # str | Limit of items returned in one response (optional)
259+ page = ' page_example' # str | Requested page (optional)
260+
261+ try :
262+ api_response = api_instance.list_pipeline_batch_jobs(name, namespace, limit = limit, page = page)
263+ pprint(api_response)
264+ except ApiException as e:
265+ print (" Exception when calling BatchJobsApi->list_pipeline_batch_jobs: %s \n " % e)
266+ ```
267+
268+ ### Parameters
269+
270+ Name | Type | Description | Notes
271+ ------------- | ------------- | ------------- | -------------
272+ ** name** | ** str** | Name identifies a resource |
273+ ** namespace** | ** str** | Namespace provides a logical grouping of resources |
274+ ** limit** | ** str** | Limit of items returned in one response | [ optional]
275+ ** page** | ** str** | Requested page | [ optional]
276+
277+ ### Return type
278+
279+ [ ** BatchJobsListResponse** ] ( BatchJobsListResponse.md )
280+
281+ ### Authorization
282+
283+ [ OAuth2] ( ../README.md#OAuth2 )
284+
285+ ### HTTP request headers
286+
287+ - ** Content-Type** : application/json
288+ - ** Accept** : application/json
289+
290+ [[ Back to top]] ( # ) [[ Back to API list]] ( ../README.md#documentation-for-api-endpoints ) [[ Back to Model list]] ( ../README.md#documentation-for-models ) [[ Back to README]] ( ../README.md )
291+
122292# ** list_seldon_deployment_batch_jobs**
123293> BatchJobsListResponse list_seldon_deployment_batch_jobs(name, namespace, limit=limit, page=page)
124294
0 commit comments