pipelines/backend/api/v2beta1/python_http_client/docs/RecurringRunServiceApi.md

kfp_server_api.RecurringRunServiceApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_recurring_run	POST /apis/v2beta1/recurringruns	Creates a new recurring run in an experiment, given the experiment ID.
delete_recurring_run	DELETE /apis/v2beta1/recurringruns/{recurring_run_id}	Deletes a recurring run.
disable_recurring_run	POST /apis/v2beta1/recurringruns/{recurring_run_id}:disable	Stops a recurring run and all its associated runs. The recurring run is not deleted.
enable_recurring_run	POST /apis/v2beta1/recurringruns/{recurring_run_id}:enable	Restarts a recurring run that was previously stopped. All runs associated with the recurring run will continue.
get_recurring_run	GET /apis/v2beta1/recurringruns/{recurring_run_id}	Finds a specific recurring run by ID.
list_recurring_runs	GET /apis/v2beta1/recurringruns	Finds all recurring runs given experiment and namespace. If experiment ID is not specified, find all recurring runs across all experiments.

create_recurring_run

V2beta1RecurringRun create_recurring_run(body)

Creates a new recurring run in an experiment, given the experiment ID.

Example

from __future__ import print_function
import time
import kfp_server_api
from kfp_server_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kfp_server_api.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with kfp_server_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = kfp_server_api.RecurringRunServiceApi(api_client)
    body = kfp_server_api.V2beta1RecurringRun() # V2beta1RecurringRun | The recurring run to be created.

    try:
        # Creates a new recurring run in an experiment, given the experiment ID.
        api_response = api_instance.create_recurring_run(body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling RecurringRunServiceApi->create_recurring_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	V2beta1RecurringRun	The recurring run to be created.

Return type

V2beta1RecurringRun

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

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

delete_recurring_run

object delete_recurring_run(recurring_run_id)

Deletes a recurring run.

Example

from __future__ import print_function
import time
import kfp_server_api
from kfp_server_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kfp_server_api.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with kfp_server_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = kfp_server_api.RecurringRunServiceApi(api_client)
    recurring_run_id = 'recurring_run_id_example' # str | The ID of the recurring run to be deleted.

    try:
        # Deletes a recurring run.
        api_response = api_instance.delete_recurring_run(recurring_run_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling RecurringRunServiceApi->delete_recurring_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
recurring_run_id	str	The ID of the recurring run to be deleted.

Return type

object

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

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

disable_recurring_run

object disable_recurring_run(recurring_run_id)

Stops a recurring run and all its associated runs. The recurring run is not deleted.

Example

from __future__ import print_function
import time
import kfp_server_api
from kfp_server_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kfp_server_api.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with kfp_server_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = kfp_server_api.RecurringRunServiceApi(api_client)
    recurring_run_id = 'recurring_run_id_example' # str | The ID of the recurring runs to be disabled.

    try:
        # Stops a recurring run and all its associated runs. The recurring run is not deleted.
        api_response = api_instance.disable_recurring_run(recurring_run_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling RecurringRunServiceApi->disable_recurring_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
recurring_run_id	str	The ID of the recurring runs to be disabled.

Return type

object

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

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

enable_recurring_run

object enable_recurring_run(recurring_run_id)

Restarts a recurring run that was previously stopped. All runs associated with the recurring run will continue.

Example

from __future__ import print_function
import time
import kfp_server_api
from kfp_server_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kfp_server_api.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with kfp_server_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = kfp_server_api.RecurringRunServiceApi(api_client)
    recurring_run_id = 'recurring_run_id_example' # str | The ID of the recurring runs to be enabled.

    try:
        # Restarts a recurring run that was previously stopped. All runs associated with the  recurring run will continue.
        api_response = api_instance.enable_recurring_run(recurring_run_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling RecurringRunServiceApi->enable_recurring_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
recurring_run_id	str	The ID of the recurring runs to be enabled.

Return type

object

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

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

get_recurring_run

V2beta1RecurringRun get_recurring_run(recurring_run_id)

Finds a specific recurring run by ID.

Example

from __future__ import print_function
import time
import kfp_server_api
from kfp_server_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kfp_server_api.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with kfp_server_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = kfp_server_api.RecurringRunServiceApi(api_client)
    recurring_run_id = 'recurring_run_id_example' # str | The ID of the recurring run to be retrieved.

    try:
        # Finds a specific recurring run by ID.
        api_response = api_instance.get_recurring_run(recurring_run_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling RecurringRunServiceApi->get_recurring_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
recurring_run_id	str	The ID of the recurring run to be retrieved.

Return type

V2beta1RecurringRun

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

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

list_recurring_runs

V2beta1ListRecurringRunsResponse list_recurring_runs(page_token=page_token, page_size=page_size, sort_by=sort_by, namespace=namespace, filter=filter, experiment_id=experiment_id)

Finds all recurring runs given experiment and namespace. If experiment ID is not specified, find all recurring runs across all experiments.

Example

from __future__ import print_function
import time
import kfp_server_api
from kfp_server_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kfp_server_api.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with kfp_server_api.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = kfp_server_api.RecurringRunServiceApi(api_client)
    page_token = 'page_token_example' # str | A page token to request the next page of results. The token is acquired from the nextPageToken field of the response from the previous ListRecurringRuns call or can be omitted when fetching the first page. (optional)
page_size = 56 # int | The number of recurring runs to be listed per page. If there are more recurring runs  than this number, the response message will contain a nextPageToken field you can use to fetch the next page. (optional)
sort_by = 'sort_by_example' # str | Can be formatted as \"field_name\", \"field_name asc\" or \"field_name desc\". Ascending by default. (optional)
namespace = 'namespace_example' # str | Optional input. The namespace the recurring runs belong to. (optional)
filter = 'filter_example' # str | A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/blob/master/backend/api/filter.proto)). (optional)
experiment_id = 'experiment_id_example' # str | The ID of the experiment to be retrieved. If empty, list recurring runs across all experiments. (optional)

    try:
        # Finds all recurring runs given experiment and namespace.  If experiment ID is not specified, find all recurring runs across all experiments.
        api_response = api_instance.list_recurring_runs(page_token=page_token, page_size=page_size, sort_by=sort_by, namespace=namespace, filter=filter, experiment_id=experiment_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling RecurringRunServiceApi->list_recurring_runs: %s\n" % e)

Parameters

Name	Type	Description	Notes
page_token	str	A page token to request the next page of results. The token is acquired from the nextPageToken field of the response from the previous ListRecurringRuns call or can be omitted when fetching the first page.	[optional]
page_size	int	The number of recurring runs to be listed per page. If there are more recurring runs than this number, the response message will contain a nextPageToken field you can use to fetch the next page.	[optional]
sort_by	str	Can be formatted as "field_name", "field_name asc" or "field_name desc". Ascending by default.	[optional]
namespace	str	Optional input. The namespace the recurring runs belong to.	[optional]
filter	str	A url-encoded, JSON-serialized Filter protocol buffer (see filter.proto).	[optional]
experiment_id	str	The ID of the experiment to be retrieved. If empty, list recurring runs across all experiments.	[optional]

Return type

V2beta1ListRecurringRunsResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

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