pipelines/backend/api/python_http_client

kfp-server-api

This file contains REST API specification for Kubeflow Pipelines. The file is autogenerated from the swagger definition.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.7.0
• Package version: 1.7.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.google.com

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import kfp_server_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import kfp_server_api

Getting Started

Please follow the installation procedure and then run the following:

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"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration = kfp_server_api.Configuration(
    host = "http://localhost",
    api_key = {
        'authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'


# Enter a context with an instance of the API client
with kfp_server_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kfp_server_api.ExperimentServiceApi(api_client)
    id = 'id_example' # str | The ID of the experiment to be archived.

    try:
        # Archives an experiment and the experiment's runs and jobs.
        api_response = api_instance.archive_experiment(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExperimentServiceApi->archive_experiment: %s\n" % e)
    

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
ExperimentServiceApi	archive_experiment	POST /apis/v1beta1/experiments/{id}:archive	Archives an experiment and the experiment's runs and jobs.
ExperimentServiceApi	create_experiment	POST /apis/v1beta1/experiments	Creates a new experiment.
ExperimentServiceApi	delete_experiment	DELETE /apis/v1beta1/experiments/{id}	Deletes an experiment without deleting the experiment's runs and jobs. To avoid unexpected behaviors, delete an experiment's runs and jobs before deleting the experiment.
ExperimentServiceApi	get_experiment	GET /apis/v1beta1/experiments/{id}	Finds a specific experiment by ID.
ExperimentServiceApi	list_experiment	GET /apis/v1beta1/experiments	Finds all experiments. Supports pagination, and sorting on certain fields.
ExperimentServiceApi	unarchive_experiment	POST /apis/v1beta1/experiments/{id}:unarchive	Restores an archived experiment. The experiment's archived runs and jobs will stay archived.
HealthzServiceApi	get_healthz	GET /apis/v1beta1/healthz	Get healthz data.
JobServiceApi	create_job	POST /apis/v1beta1/jobs	Creates a new job.
JobServiceApi	delete_job	DELETE /apis/v1beta1/jobs/{id}	Deletes a job.
JobServiceApi	disable_job	POST /apis/v1beta1/jobs/{id}/disable	Stops a job and all its associated runs. The job is not deleted.
JobServiceApi	enable_job	POST /apis/v1beta1/jobs/{id}/enable	Restarts a job that was previously stopped. All runs associated with the job will continue.
JobServiceApi	get_job	GET /apis/v1beta1/jobs/{id}	Finds a specific job by ID.
JobServiceApi	list_jobs	GET /apis/v1beta1/jobs	Finds all jobs.
PipelineServiceApi	create_pipeline	POST /apis/v1beta1/pipelines	Creates a pipeline.
PipelineServiceApi	create_pipeline_version	POST /apis/v1beta1/pipeline_versions	Adds a pipeline version to the specified pipeline.
PipelineServiceApi	delete_pipeline	DELETE /apis/v1beta1/pipelines/{id}	Deletes a pipeline and its pipeline versions.
PipelineServiceApi	delete_pipeline_version	DELETE /apis/v1beta1/pipeline_versions/{version_id}	Deletes a pipeline version by pipeline version ID. If the deleted pipeline version is the default pipeline version, the pipeline's default version changes to the pipeline's most recent pipeline version. If there are no remaining pipeline versions, the pipeline will have no default version. Examines the run_service_api.ipynb notebook to learn more about creating a run using a pipeline version (https://github.com/kubeflow/pipelines/blob/master/tools/benchmarks/run_service_api.ipynb).
PipelineServiceApi	get_pipeline	GET /apis/v1beta1/pipelines/{id}	Finds a specific pipeline by ID.
PipelineServiceApi	get_pipeline_version	GET /apis/v1beta1/pipeline_versions/{version_id}	Gets a pipeline version by pipeline version ID.
PipelineServiceApi	get_pipeline_version_template	GET /apis/v1beta1/pipeline_versions/{version_id}/templates	Returns a YAML template that contains the specified pipeline version's description, parameters and metadata.
PipelineServiceApi	get_template	GET /apis/v1beta1/pipelines/{id}/templates	Returns a single YAML template that contains the description, parameters, and metadata associated with the pipeline provided.
PipelineServiceApi	list_pipeline_versions	GET /apis/v1beta1/pipeline_versions	Lists all pipeline versions of a given pipeline.
PipelineServiceApi	list_pipelines	GET /apis/v1beta1/pipelines	Finds all pipelines.
PipelineServiceApi	update_pipeline_default_version	POST /apis/v1beta1/pipelines/{pipeline_id}/default_version/{version_id}	Update the default pipeline version of a specific pipeline.
PipelineUploadServiceApi	upload_pipeline	POST /apis/v1beta1/pipelines/upload
PipelineUploadServiceApi	upload_pipeline_version	POST /apis/v1beta1/pipelines/upload_version
RunServiceApi	archive_run	POST /apis/v1beta1/runs/{id}:archive	Archives a run.
RunServiceApi	create_run	POST /apis/v1beta1/runs	Creates a new run.
RunServiceApi	delete_run	DELETE /apis/v1beta1/runs/{id}	Deletes a run.
RunServiceApi	get_run	GET /apis/v1beta1/runs/{run_id}	Finds a specific run by ID.
RunServiceApi	list_runs	GET /apis/v1beta1/runs	Finds all runs.
RunServiceApi	read_artifact	GET /apis/v1beta1/runs/{run_id}/nodes/{node_id}/artifacts/{artifact_name}:read	Finds a run's artifact data.
RunServiceApi	report_run_metrics	POST /apis/v1beta1/runs/{run_id}:reportMetrics	ReportRunMetrics reports metrics of a run. Each metric is reported in its own transaction, so this API accepts partial failures. Metric can be uniquely identified by (run_id, node_id, name). Duplicate reporting will be ignored by the API. First reporting wins.
RunServiceApi	retry_run	POST /apis/v1beta1/runs/{run_id}/retry	Re-initiates a failed or terminated run.
RunServiceApi	terminate_run	POST /apis/v1beta1/runs/{run_id}/terminate	Terminates an active run.
RunServiceApi	unarchive_run	POST /apis/v1beta1/runs/{id}:unarchive	Restores an archived run.

Documentation For Models

• ApiCronSchedule
• ApiExperiment
• ApiExperimentStorageState
• ApiGetHealthzResponse
• ApiGetTemplateResponse
• ApiJob
• ApiListExperimentsResponse
• ApiListJobsResponse
• ApiListPipelineVersionsResponse
• ApiListPipelinesResponse
• ApiListRunsResponse
• ApiParameter
• ApiPeriodicSchedule
• ApiPipeline
• ApiPipelineRuntime
• ApiPipelineSpec
• ApiPipelineVersion
• ApiReadArtifactResponse
• ApiRelationship
• ApiReportRunMetricsRequest
• ApiReportRunMetricsResponse
• ApiResourceKey
• ApiResourceReference
• ApiResourceType
• ApiRun
• ApiRunDetail
• ApiRunMetric
• ApiRunStorageState
• ApiStatus
• ApiTrigger
• ApiUrl
• JobMode
• ProtobufAny
• ReportRunMetricsResponseReportRunMetricResult
• ReportRunMetricsResponseReportRunMetricResultStatus
• RunMetricFormat

Documentation For Authorization

Bearer

• Type: API key
• API key parameter name: authorization
• Location: HTTP header

Author

kubeflow-pipelines@google.com