kfp.Client().runs
- class kfp_server_api.api.run_service_api.RunServiceApi(api_client=None)[source]
Bases:
object
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
- archive_run(id, **kwargs)[source]
Archives a run. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.archive_run(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the run to be archived. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- archive_run_with_http_info(id, **kwargs)[source]
Archives a run. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.archive_run_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the run to be archived. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
- create_run(body, **kwargs)[source]
Creates a new run. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_run(body, async_req=True) >>> result = thread.get()
- Parameters
body (ApiRun) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- create_run_with_http_info(body, **kwargs)[source]
Creates a new run. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_run_with_http_info(body, async_req=True) >>> result = thread.get()
- Parameters
body (ApiRun) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiRunDetail, status_code(int), headers(HTTPHeaderDict))
- delete_run(id, **kwargs)[source]
Deletes a run. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_run(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the run to be deleted. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- delete_run_with_http_info(id, **kwargs)[source]
Deletes a run. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_run_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the run to be deleted. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
- get_run(run_id, **kwargs)[source]
Finds a specific run by ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_run(run_id, async_req=True) >>> result = thread.get()
- Parameters
run_id (str) – The ID of the run to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- get_run_with_http_info(run_id, **kwargs)[source]
Finds a specific run by ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_run_with_http_info(run_id, async_req=True) >>> result = thread.get()
- Parameters
run_id (str) – The ID of the run to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiRunDetail, status_code(int), headers(HTTPHeaderDict))
- list_runs(**kwargs)[source]
Finds all runs. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_runs(async_req=True) >>> result = thread.get()
- Parameters
page_token (str) – A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListRuns call or can be omitted when fetching the first page.
page_size (int) – The number of runs to be listed per page. If there are more runs than this number, the response message will contain a nextPageToken field you can use to fetch the next page.
sort_by (str) – Can be format of “field_name”, “field_name asc” or “field_name desc” (Example, “name asc” or “id desc”). Ascending by default.
resource_reference_key_type (str) – The type of the resource that referred to.
resource_reference_key_id (str) – The ID of the resource that referred to.
filter (str) – A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/blob/master/backend/api/filter.proto)).
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- list_runs_with_http_info(**kwargs)[source]
Finds all runs. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_runs_with_http_info(async_req=True) >>> result = thread.get()
- Parameters
page_token (str) – A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListRuns call or can be omitted when fetching the first page.
page_size (int) – The number of runs to be listed per page. If there are more runs than this number, the response message will contain a nextPageToken field you can use to fetch the next page.
sort_by (str) – Can be format of “field_name”, “field_name asc” or “field_name desc” (Example, “name asc” or “id desc”). Ascending by default.
resource_reference_key_type (str) – The type of the resource that referred to.
resource_reference_key_id (str) – The ID of the resource that referred to.
filter (str) – A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/blob/master/backend/api/filter.proto)).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiListRunsResponse, status_code(int), headers(HTTPHeaderDict))
- read_artifact(run_id, node_id, artifact_name, **kwargs)[source]
Finds a run’s artifact data. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.read_artifact(run_id, node_id, artifact_name, async_req=True) >>> result = thread.get()
- Parameters
run_id (str) – The ID of the run. (required)
node_id (str) – The ID of the running node. (required)
artifact_name (str) – The name of the artifact. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- read_artifact_with_http_info(run_id, node_id, artifact_name, **kwargs)[source]
Finds a run’s artifact data. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.read_artifact_with_http_info(run_id, node_id, artifact_name, async_req=True) >>> result = thread.get()
- Parameters
run_id (str) – The ID of the run. (required)
node_id (str) – The ID of the running node. (required)
artifact_name (str) – The name of the artifact. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiReadArtifactResponse, status_code(int), headers(HTTPHeaderDict))
- report_run_metrics(run_id, body, **kwargs)[source]
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. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.report_run_metrics(run_id, body, async_req=True) >>> result = thread.get()
- Parameters
run_id (str) – Required. The parent run ID of the metric. (required)
body (ApiReportRunMetricsRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- report_run_metrics_with_http_info(run_id, body, **kwargs)[source]
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. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.report_run_metrics_with_http_info(run_id, body, async_req=True) >>> result = thread.get()
- Parameters
run_id (str) – Required. The parent run ID of the metric. (required)
body (ApiReportRunMetricsRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiReportRunMetricsResponse, status_code(int), headers(HTTPHeaderDict))
- retry_run(run_id, **kwargs)[source]
Re-initiates a failed or terminated run. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.retry_run(run_id, async_req=True) >>> result = thread.get()
- Parameters
run_id (str) – The ID of the run to be retried. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- retry_run_with_http_info(run_id, **kwargs)[source]
Re-initiates a failed or terminated run. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.retry_run_with_http_info(run_id, async_req=True) >>> result = thread.get()
- Parameters
run_id (str) – The ID of the run to be retried. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
- terminate_run(run_id, **kwargs)[source]
Terminates an active run. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.terminate_run(run_id, async_req=True) >>> result = thread.get()
- Parameters
run_id (str) – The ID of the run to be terminated. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- terminate_run_with_http_info(run_id, **kwargs)[source]
Terminates an active run. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.terminate_run_with_http_info(run_id, async_req=True) >>> result = thread.get()
- Parameters
run_id (str) – The ID of the run to be terminated. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
- unarchive_run(id, **kwargs)[source]
Restores an archived run. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.unarchive_run(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the run to be restored. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- unarchive_run_with_http_info(id, **kwargs)[source]
Restores an archived run. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.unarchive_run_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the run to be restored. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
kfp.Client().pipelines
- class kfp_server_api.api.pipeline_service_api.PipelineServiceApi(api_client=None)[source]
Bases:
object
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
- create_pipeline(body, **kwargs)[source]
Creates a pipeline. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_pipeline(body, async_req=True) >>> result = thread.get()
- Parameters
body (ApiPipeline) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- create_pipeline_version(body, **kwargs)[source]
Adds a pipeline version to the specified pipeline. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_pipeline_version(body, async_req=True) >>> result = thread.get()
- Parameters
body (ApiPipelineVersion) – ResourceReference inside PipelineVersion specifies the pipeline that this version belongs to. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- create_pipeline_version_with_http_info(body, **kwargs)[source]
Adds a pipeline version to the specified pipeline. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_pipeline_version_with_http_info(body, async_req=True) >>> result = thread.get()
- Parameters
body (ApiPipelineVersion) – ResourceReference inside PipelineVersion specifies the pipeline that this version belongs to. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiPipelineVersion, status_code(int), headers(HTTPHeaderDict))
- create_pipeline_with_http_info(body, **kwargs)[source]
Creates a pipeline. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_pipeline_with_http_info(body, async_req=True) >>> result = thread.get()
- Parameters
body (ApiPipeline) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiPipeline, status_code(int), headers(HTTPHeaderDict))
- delete_pipeline(id, **kwargs)[source]
Deletes a pipeline and its pipeline versions. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_pipeline(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the pipeline to be deleted. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- delete_pipeline_version(version_id, **kwargs)[source]
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). # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_pipeline_version(version_id, async_req=True) >>> result = thread.get()
- Parameters
version_id (str) – The ID of the pipeline version to be deleted. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- delete_pipeline_version_with_http_info(version_id, **kwargs)[source]
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). # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_pipeline_version_with_http_info(version_id, async_req=True) >>> result = thread.get()
- Parameters
version_id (str) – The ID of the pipeline version to be deleted. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
- delete_pipeline_with_http_info(id, **kwargs)[source]
Deletes a pipeline and its pipeline versions. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_pipeline_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the pipeline to be deleted. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
- get_pipeline(id, **kwargs)[source]
Finds a specific pipeline by ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_pipeline(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the pipeline to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- get_pipeline_by_name(namespace, name, **kwargs)[source]
Finds a pipeline by Name (and namespace) # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_pipeline_by_name(namespace, name, async_req=True) >>> result = thread.get()
- Parameters
namespace (str) – The Namespace the pipeline belongs to. In the case of shared pipelines and KFPipeline standalone installation, the pipeline name is the only needed field for unique resource lookup (namespace is not required). In those case, please provide hyphen (dash character, “-“). (required)
name (str) – The Name of the pipeline to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- get_pipeline_by_name_with_http_info(namespace, name, **kwargs)[source]
Finds a pipeline by Name (and namespace) # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_pipeline_by_name_with_http_info(namespace, name, async_req=True) >>> result = thread.get()
- Parameters
namespace (str) – The Namespace the pipeline belongs to. In the case of shared pipelines and KFPipeline standalone installation, the pipeline name is the only needed field for unique resource lookup (namespace is not required). In those case, please provide hyphen (dash character, “-“). (required)
name (str) – The Name of the pipeline to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiPipeline, status_code(int), headers(HTTPHeaderDict))
- get_pipeline_version(version_id, **kwargs)[source]
Gets a pipeline version by pipeline version ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_pipeline_version(version_id, async_req=True) >>> result = thread.get()
- Parameters
version_id (str) – The ID of the pipeline version to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- get_pipeline_version_template(version_id, **kwargs)[source]
Returns a YAML template that contains the specified pipeline version’s description, parameters and metadata. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_pipeline_version_template(version_id, async_req=True) >>> result = thread.get()
- Parameters
version_id (str) – The ID of the pipeline version whose template is to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- get_pipeline_version_template_with_http_info(version_id, **kwargs)[source]
Returns a YAML template that contains the specified pipeline version’s description, parameters and metadata. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_pipeline_version_template_with_http_info(version_id, async_req=True) >>> result = thread.get()
- Parameters
version_id (str) – The ID of the pipeline version whose template is to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiGetTemplateResponse, status_code(int), headers(HTTPHeaderDict))
- get_pipeline_version_with_http_info(version_id, **kwargs)[source]
Gets a pipeline version by pipeline version ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_pipeline_version_with_http_info(version_id, async_req=True) >>> result = thread.get()
- Parameters
version_id (str) – The ID of the pipeline version to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiPipelineVersion, status_code(int), headers(HTTPHeaderDict))
- get_pipeline_with_http_info(id, **kwargs)[source]
Finds a specific pipeline by ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_pipeline_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the pipeline to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiPipeline, status_code(int), headers(HTTPHeaderDict))
- get_template(id, **kwargs)[source]
Returns a single YAML template that contains the description, parameters, and metadata associated with the pipeline provided. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_template(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the pipeline whose template is to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- get_template_with_http_info(id, **kwargs)[source]
Returns a single YAML template that contains the description, parameters, and metadata associated with the pipeline provided. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_template_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the pipeline whose template is to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiGetTemplateResponse, status_code(int), headers(HTTPHeaderDict))
- list_pipeline_versions(**kwargs)[source]
Lists all pipeline versions of a given pipeline. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_pipeline_versions(async_req=True) >>> result = thread.get()
- Parameters
resource_key_type (str) – The type of the resource that referred to.
resource_key_id (str) – The ID of the resource that referred to.
page_size (int) – The number of pipeline versions to be listed per page. If there are more pipeline versions than this number, the response message will contain a nextPageToken field you can use to fetch the next page.
page_token (str) – A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelineVersions call or can be omitted when fetching the first page.
sort_by (str) – Can be format of “field_name”, “field_name asc” or “field_name desc” Ascending by default.
filter (str) – A base-64 encoded, JSON-serialized Filter protocol buffer (see filter.proto).
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- list_pipeline_versions_with_http_info(**kwargs)[source]
Lists all pipeline versions of a given pipeline. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_pipeline_versions_with_http_info(async_req=True) >>> result = thread.get()
- Parameters
resource_key_type (str) – The type of the resource that referred to.
resource_key_id (str) – The ID of the resource that referred to.
page_size (int) – The number of pipeline versions to be listed per page. If there are more pipeline versions than this number, the response message will contain a nextPageToken field you can use to fetch the next page.
page_token (str) – A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelineVersions call or can be omitted when fetching the first page.
sort_by (str) – Can be format of “field_name”, “field_name asc” or “field_name desc” Ascending by default.
filter (str) – A base-64 encoded, JSON-serialized Filter protocol buffer (see filter.proto).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiListPipelineVersionsResponse, status_code(int), headers(HTTPHeaderDict))
- list_pipelines(**kwargs)[source]
Finds all pipelines. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_pipelines(async_req=True) >>> result = thread.get()
- Parameters
page_token (str) – A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelines call.
page_size (int) – The number of pipelines to be listed per page. If there are more pipelines than this number, the response message will contain a valid value in the nextPageToken field.
sort_by (str) – Can be format of “field_name”, “field_name asc” or “field_name desc” Ascending by default.
filter (str) – A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/blob/master/backend/api/filter.proto)).
resource_reference_key_type (str) – The type of the resource that referred to.
resource_reference_key_id (str) – The ID of the resource that referred to.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- list_pipelines_with_http_info(**kwargs)[source]
Finds all pipelines. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_pipelines_with_http_info(async_req=True) >>> result = thread.get()
- Parameters
page_token (str) – A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelines call.
page_size (int) – The number of pipelines to be listed per page. If there are more pipelines than this number, the response message will contain a valid value in the nextPageToken field.
sort_by (str) – Can be format of “field_name”, “field_name asc” or “field_name desc” Ascending by default.
filter (str) – A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/blob/master/backend/api/filter.proto)).
resource_reference_key_type (str) – The type of the resource that referred to.
resource_reference_key_id (str) – The ID of the resource that referred to.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiListPipelinesResponse, status_code(int), headers(HTTPHeaderDict))
- update_pipeline_default_version(pipeline_id, version_id, **kwargs)[source]
Update the default pipeline version of a specific pipeline. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_pipeline_default_version(pipeline_id, version_id, async_req=True) >>> result = thread.get()
- Parameters
pipeline_id (str) – The ID of the pipeline to be updated. (required)
version_id (str) – The ID of the default version. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- update_pipeline_default_version_with_http_info(pipeline_id, version_id, **kwargs)[source]
Update the default pipeline version of a specific pipeline. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_pipeline_default_version_with_http_info(pipeline_id, version_id, async_req=True) >>> result = thread.get()
- Parameters
pipeline_id (str) – The ID of the pipeline to be updated. (required)
version_id (str) – The ID of the default version. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
kfp.Client().experiments
- class kfp_server_api.api.experiment_service_api.ExperimentServiceApi(api_client=None)[source]
Bases:
object
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
- archive_experiment(id, **kwargs)[source]
Archives an experiment and the experiment’s runs and jobs. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.archive_experiment(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the experiment to be archived. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- archive_experiment_with_http_info(id, **kwargs)[source]
Archives an experiment and the experiment’s runs and jobs. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.archive_experiment_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the experiment to be archived. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
- create_experiment(body, **kwargs)[source]
Creates a new experiment. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_experiment(body, async_req=True) >>> result = thread.get()
- Parameters
body (ApiExperiment) – The experiment to be created. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- create_experiment_with_http_info(body, **kwargs)[source]
Creates a new experiment. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_experiment_with_http_info(body, async_req=True) >>> result = thread.get()
- Parameters
body (ApiExperiment) – The experiment to be created. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiExperiment, status_code(int), headers(HTTPHeaderDict))
- delete_experiment(id, **kwargs)[source]
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. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_experiment(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the experiment to be deleted. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- delete_experiment_with_http_info(id, **kwargs)[source]
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. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_experiment_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the experiment to be deleted. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
- get_experiment(id, **kwargs)[source]
Finds a specific experiment by ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_experiment(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the experiment to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- get_experiment_with_http_info(id, **kwargs)[source]
Finds a specific experiment by ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_experiment_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the experiment to be retrieved. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiExperiment, status_code(int), headers(HTTPHeaderDict))
- list_experiment(**kwargs)[source]
Finds all experiments. Supports pagination, and sorting on certain fields. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_experiment(async_req=True) >>> result = thread.get()
- Parameters
page_token (str) – A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListExperiment call or can be omitted when fetching the first page.
page_size (int) – The number of experiments to be listed per page. If there are more experiments than this number, the response message will contain a nextPageToken field you can use to fetch the next page.
sort_by (str) – Can be format of “field_name”, “field_name asc” or “field_name desc” Ascending by default.
filter (str) – A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/blob/master/backend/api/filter.proto)).
resource_reference_key_type (str) – The type of the resource that referred to.
resource_reference_key_id (str) – The ID of the resource that referred to.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- list_experiment_with_http_info(**kwargs)[source]
Finds all experiments. Supports pagination, and sorting on certain fields. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_experiment_with_http_info(async_req=True) >>> result = thread.get()
- Parameters
page_token (str) – A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListExperiment call or can be omitted when fetching the first page.
page_size (int) – The number of experiments to be listed per page. If there are more experiments than this number, the response message will contain a nextPageToken field you can use to fetch the next page.
sort_by (str) – Can be format of “field_name”, “field_name asc” or “field_name desc” Ascending by default.
filter (str) – A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/blob/master/backend/api/filter.proto)).
resource_reference_key_type (str) – The type of the resource that referred to.
resource_reference_key_id (str) – The ID of the resource that referred to.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiListExperimentsResponse, status_code(int), headers(HTTPHeaderDict))
- unarchive_experiment(id, **kwargs)[source]
Restores an archived experiment. The experiment’s archived runs and jobs will stay archived. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.unarchive_experiment(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the experiment to be restored. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- unarchive_experiment_with_http_info(id, **kwargs)[source]
Restores an archived experiment. The experiment’s archived runs and jobs will stay archived. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.unarchive_experiment_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the experiment to be restored. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
kfp.Client().jobs
- class kfp_server_api.api.job_service_api.JobServiceApi(api_client=None)[source]
Bases:
object
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
- create_job(body, **kwargs)[source]
Creates a new job. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_job(body, async_req=True) >>> result = thread.get()
- Parameters
body (ApiJob) – The job to be created (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- create_job_with_http_info(body, **kwargs)[source]
Creates a new job. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_job_with_http_info(body, async_req=True) >>> result = thread.get()
- Parameters
body (ApiJob) – The job to be created (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiJob, status_code(int), headers(HTTPHeaderDict))
- delete_job(id, **kwargs)[source]
Deletes a job. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_job(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the job to be deleted (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- delete_job_with_http_info(id, **kwargs)[source]
Deletes a job. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_job_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the job to be deleted (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
- disable_job(id, **kwargs)[source]
Stops a job and all its associated runs. The job is not deleted. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.disable_job(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the job to be disabled (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- disable_job_with_http_info(id, **kwargs)[source]
Stops a job and all its associated runs. The job is not deleted. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.disable_job_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the job to be disabled (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
- enable_job(id, **kwargs)[source]
Restarts a job that was previously stopped. All runs associated with the job will continue. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.enable_job(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the job to be enabled (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
object
- enable_job_with_http_info(id, **kwargs)[source]
Restarts a job that was previously stopped. All runs associated with the job will continue. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.enable_job_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the job to be enabled (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(object, status_code(int), headers(HTTPHeaderDict))
- get_job(id, **kwargs)[source]
Finds a specific job by ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_job(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the job to be retrieved (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- get_job_with_http_info(id, **kwargs)[source]
Finds a specific job by ID. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_job_with_http_info(id, async_req=True) >>> result = thread.get()
- Parameters
id (str) – The ID of the job to be retrieved (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiJob, status_code(int), headers(HTTPHeaderDict))
- list_jobs(**kwargs)[source]
Finds all jobs. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_jobs(async_req=True) >>> result = thread.get()
- Parameters
page_token (str) – A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListJobs call or can be omitted when fetching the first page.
page_size (int) – The number of jobs to be listed per page. If there are more jobs than this number, the response message will contain a nextPageToken field you can use to fetch the next page.
sort_by (str) – Can be format of “field_name”, “field_name asc” or “field_name desc”. Ascending by default.
resource_reference_key_type (str) – The type of the resource that referred to.
resource_reference_key_id (str) – The ID of the resource that referred to.
filter (str) – A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/blob/master/backend/api/filter.proto)).
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- list_jobs_with_http_info(**kwargs)[source]
Finds all jobs. # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_jobs_with_http_info(async_req=True) >>> result = thread.get()
- Parameters
page_token (str) – A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListJobs call or can be omitted when fetching the first page.
page_size (int) – The number of jobs to be listed per page. If there are more jobs than this number, the response message will contain a nextPageToken field you can use to fetch the next page.
sort_by (str) – Can be format of “field_name”, “field_name asc” or “field_name desc”. Ascending by default.
resource_reference_key_type (str) – The type of the resource that referred to.
resource_reference_key_id (str) – The ID of the resource that referred to.
filter (str) – A url-encoded, JSON-serialized Filter protocol buffer (see [filter.proto](https://github.com/kubeflow/pipelines/blob/master/backend/api/filter.proto)).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiListJobsResponse, status_code(int), headers(HTTPHeaderDict))
kfp.Client().pipeline_uploads
- class kfp_server_api.api.pipeline_upload_service_api.PipelineUploadServiceApi(api_client=None)[source]
Bases:
object
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
- upload_pipeline(uploadfile, **kwargs)[source]
upload_pipeline # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upload_pipeline(uploadfile, async_req=True) >>> result = thread.get()
- Parameters
uploadfile (file) – The pipeline to upload. Maximum size of 32MB is supported. (required)
name (str) –
description (str) –
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- upload_pipeline_version(uploadfile, **kwargs)[source]
upload_pipeline_version # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upload_pipeline_version(uploadfile, async_req=True) >>> result = thread.get()
- Parameters
uploadfile (file) – The pipeline to upload. Maximum size of 32MB is supported. (required)
name (str) –
pipelineid (str) –
description (str) –
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
- upload_pipeline_version_with_http_info(uploadfile, **kwargs)[source]
upload_pipeline_version # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upload_pipeline_version_with_http_info(uploadfile, async_req=True) >>> result = thread.get()
- Parameters
uploadfile (file) – The pipeline to upload. Maximum size of 32MB is supported. (required)
name (str) –
pipelineid (str) –
description (str) –
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiPipelineVersion, status_code(int), headers(HTTPHeaderDict))
- upload_pipeline_with_http_info(uploadfile, **kwargs)[source]
upload_pipeline # noqa: E501
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upload_pipeline_with_http_info(uploadfile, async_req=True) >>> result = thread.get()
- Parameters
uploadfile (file) – The pipeline to upload. Maximum size of 32MB is supported. (required)
name (str) –
description (str) –
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – response data without head status code and headers
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type
tuple(ApiPipeline, status_code(int), headers(HTTPHeaderDict))
kfp.Client().models
Kubeflow Pipelines API
This file contains REST API specification for Kubeflow Pipelines. The file is autogenerated from the swagger definition.
Contact: kubeflow-pipelines@google.com Generated by: https://openapi-generator.tech
- class kfp_server_api.models.ApiCronSchedule(start_time=None, end_time=None, cron=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'cron': 'cron', 'end_time': 'end_time', 'start_time': 'start_time'}
- property cron
E501
- Returns
The cron of this ApiCronSchedule. # noqa: E501
- Return type
str
- Type
Gets the cron of this ApiCronSchedule. # noqa
- property end_time
E501
- Returns
The end_time of this ApiCronSchedule. # noqa: E501
- Return type
datetime
- Type
Gets the end_time of this ApiCronSchedule. # noqa
- openapi_types = {'cron': 'str', 'end_time': 'datetime', 'start_time': 'datetime'}
- property start_time
E501
- Returns
The start_time of this ApiCronSchedule. # noqa: E501
- Return type
datetime
- Type
Gets the start_time of this ApiCronSchedule. # noqa
- class kfp_server_api.models.ApiExperiment(id=None, name=None, description=None, created_at=None, resource_references=None, storage_state=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'created_at': 'created_at', 'description': 'description', 'id': 'id', 'name': 'name', 'resource_references': 'resource_references', 'storage_state': 'storage_state'}
- property created_at
E501
Output. The time that the experiment created. # noqa: E501
- Returns
The created_at of this ApiExperiment. # noqa: E501
- Return type
datetime
- Type
Gets the created_at of this ApiExperiment. # noqa
- property description
E501
- Returns
The description of this ApiExperiment. # noqa: E501
- Return type
str
- Type
Gets the description of this ApiExperiment. # noqa
- property id
E501
Output. Unique experiment ID. Generated by API server. # noqa: E501
- Returns
The id of this ApiExperiment. # noqa: E501
- Return type
str
- Type
Gets the id of this ApiExperiment. # noqa
- property name
E501
Required input field. Unique experiment name provided by user. # noqa: E501
- Returns
The name of this ApiExperiment. # noqa: E501
- Return type
str
- Type
Gets the name of this ApiExperiment. # noqa
- openapi_types = {'created_at': 'datetime', 'description': 'str', 'id': 'str', 'name': 'str', 'resource_references': 'list[ApiResourceReference]', 'storage_state': 'ApiExperimentStorageState'}
- property resource_references
E501
Optional input field. Specify which resource this run belongs to. For Experiment, the only valid resource reference is a single Namespace. # noqa: E501
- Returns
The resource_references of this ApiExperiment. # noqa: E501
- Return type
list[ApiResourceReference]
- Type
Gets the resource_references of this ApiExperiment. # noqa
- property storage_state
E501
- Returns
The storage_state of this ApiExperiment. # noqa: E501
- Return type
- Type
Gets the storage_state of this ApiExperiment. # noqa
- class kfp_server_api.models.ApiExperimentStorageState(local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- ARCHIVED = 'STORAGESTATE_ARCHIVED'
- AVAILABLE = 'STORAGESTATE_AVAILABLE'
- UNSPECIFIED = 'STORAGESTATE_UNSPECIFIED'
- allowable_values = ['STORAGESTATE_UNSPECIFIED', 'STORAGESTATE_AVAILABLE', 'STORAGESTATE_ARCHIVED']
Attributes: openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}
- openapi_types = {}
- class kfp_server_api.models.ApiGetHealthzResponse(multi_user=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'multi_user': 'multi_user'}
- property multi_user
E501
- Returns
The multi_user of this ApiGetHealthzResponse. # noqa: E501
- Return type
bool
- Type
Gets the multi_user of this ApiGetHealthzResponse. # noqa
- openapi_types = {'multi_user': 'bool'}
- class kfp_server_api.models.ApiGetTemplateResponse(template=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'template': 'template'}
- openapi_types = {'template': 'str'}
- property template
E501
The template of the pipeline specified in a GetTemplate request, or of a pipeline version specified in a GetPipelinesVersionTemplate request. # noqa: E501
- Returns
The template of this ApiGetTemplateResponse. # noqa: E501
- Return type
str
- Type
Gets the template of this ApiGetTemplateResponse. # noqa
- class kfp_server_api.models.ApiJob(id=None, name=None, description=None, pipeline_spec=None, resource_references=None, service_account=None, max_concurrency=None, trigger=None, mode=None, created_at=None, updated_at=None, status=None, error=None, enabled=None, no_catchup=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'created_at': 'created_at', 'description': 'description', 'enabled': 'enabled', 'error': 'error', 'id': 'id', 'max_concurrency': 'max_concurrency', 'mode': 'mode', 'name': 'name', 'no_catchup': 'no_catchup', 'pipeline_spec': 'pipeline_spec', 'resource_references': 'resource_references', 'service_account': 'service_account', 'status': 'status', 'trigger': 'trigger', 'updated_at': 'updated_at'}
- property created_at
E501
Output. The time this job is created. # noqa: E501
- Returns
The created_at of this ApiJob. # noqa: E501
- Return type
datetime
- Type
Gets the created_at of this ApiJob. # noqa
- property description
E501
- Returns
The description of this ApiJob. # noqa: E501
- Return type
str
- Type
Gets the description of this ApiJob. # noqa
- property enabled
E501
Input. Whether the job is enabled or not. # noqa: E501
- Returns
The enabled of this ApiJob. # noqa: E501
- Return type
bool
- Type
Gets the enabled of this ApiJob. # noqa
- property error
E501
In case any error happens retrieving a job field, only job ID and the error message is returned. Client has the flexibility of choosing how to handle error. This is especially useful during listing call. # noqa: E501
- Returns
The error of this ApiJob. # noqa: E501
- Return type
str
- Type
Gets the error of this ApiJob. # noqa
- property id
E501
Output. Unique run ID. Generated by API server. # noqa: E501
- Returns
The id of this ApiJob. # noqa: E501
- Return type
str
- Type
Gets the id of this ApiJob. # noqa
- property max_concurrency
E501
- Returns
The max_concurrency of this ApiJob. # noqa: E501
- Return type
str
- Type
Gets the max_concurrency of this ApiJob. # noqa
- property mode
E501
- Returns
The mode of this ApiJob. # noqa: E501
- Return type
- Type
Gets the mode of this ApiJob. # noqa
- property name
E501
Required input field. Job name provided by user. Not unique. # noqa: E501
- Returns
The name of this ApiJob. # noqa: E501
- Return type
str
- Type
Gets the name of this ApiJob. # noqa
- property no_catchup
E501
Optional input field. Whether the job should catch up if behind schedule. If true, the job will only schedule the latest interval if behind schedule. If false, the job will catch up on each past interval. # noqa: E501
- Returns
The no_catchup of this ApiJob. # noqa: E501
- Return type
bool
- Type
Gets the no_catchup of this ApiJob. # noqa
- openapi_types = {'created_at': 'datetime', 'description': 'str', 'enabled': 'bool', 'error': 'str', 'id': 'str', 'max_concurrency': 'str', 'mode': 'JobMode', 'name': 'str', 'no_catchup': 'bool', 'pipeline_spec': 'ApiPipelineSpec', 'resource_references': 'list[ApiResourceReference]', 'service_account': 'str', 'status': 'str', 'trigger': 'ApiTrigger', 'updated_at': 'datetime'}
- property pipeline_spec
E501
- Returns
The pipeline_spec of this ApiJob. # noqa: E501
- Return type
- Type
Gets the pipeline_spec of this ApiJob. # noqa
- property resource_references
E501
Optional input field. Specify which resource this job belongs to. # noqa: E501
- Returns
The resource_references of this ApiJob. # noqa: E501
- Return type
list[ApiResourceReference]
- Type
Gets the resource_references of this ApiJob. # noqa
- property service_account
E501
Optional input field. Specify which Kubernetes service account this job uses. # noqa: E501
- Returns
The service_account of this ApiJob. # noqa: E501
- Return type
str
- Type
Gets the service_account of this ApiJob. # noqa
- property status
E501
- Returns
The status of this ApiJob. # noqa: E501
- Return type
str
- Type
Gets the status of this ApiJob. # noqa
- property trigger
E501
- Returns
The trigger of this ApiJob. # noqa: E501
- Return type
- Type
Gets the trigger of this ApiJob. # noqa
- property updated_at
E501
Output. The last time this job is updated. # noqa: E501
- Returns
The updated_at of this ApiJob. # noqa: E501
- Return type
datetime
- Type
Gets the updated_at of this ApiJob. # noqa
- class kfp_server_api.models.ApiListExperimentsResponse(experiments=None, total_size=None, next_page_token=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'experiments': 'experiments', 'next_page_token': 'next_page_token', 'total_size': 'total_size'}
- property experiments
E501
A list of experiments returned. # noqa: E501
- Returns
The experiments of this ApiListExperimentsResponse. # noqa: E501
- Return type
list[ApiExperiment]
- Type
Gets the experiments of this ApiListExperimentsResponse. # noqa
- property next_page_token
E501
The token to list the next page of experiments. # noqa: E501
- Returns
The next_page_token of this ApiListExperimentsResponse. # noqa: E501
- Return type
str
- Type
Gets the next_page_token of this ApiListExperimentsResponse. # noqa
- openapi_types = {'experiments': 'list[ApiExperiment]', 'next_page_token': 'str', 'total_size': 'int'}
- property total_size
E501
The total number of experiments for the given query. # noqa: E501
- Returns
The total_size of this ApiListExperimentsResponse. # noqa: E501
- Return type
int
- Type
Gets the total_size of this ApiListExperimentsResponse. # noqa
- class kfp_server_api.models.ApiListJobsResponse(jobs=None, total_size=None, next_page_token=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'jobs': 'jobs', 'next_page_token': 'next_page_token', 'total_size': 'total_size'}
- property jobs
E501
A list of jobs returned. # noqa: E501
- Returns
The jobs of this ApiListJobsResponse. # noqa: E501
- Return type
list[ApiJob]
- Type
Gets the jobs of this ApiListJobsResponse. # noqa
- property next_page_token
E501
The token to list the next page of jobs. # noqa: E501
- Returns
The next_page_token of this ApiListJobsResponse. # noqa: E501
- Return type
str
- Type
Gets the next_page_token of this ApiListJobsResponse. # noqa
- openapi_types = {'jobs': 'list[ApiJob]', 'next_page_token': 'str', 'total_size': 'int'}
- property total_size
E501
The total number of jobs for the given query. # noqa: E501
- Returns
The total_size of this ApiListJobsResponse. # noqa: E501
- Return type
int
- Type
Gets the total_size of this ApiListJobsResponse. # noqa
- class kfp_server_api.models.ApiListPipelineVersionsResponse(versions=None, next_page_token=None, total_size=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'next_page_token': 'next_page_token', 'total_size': 'total_size', 'versions': 'versions'}
- property next_page_token
E501
The token to list the next page of pipeline versions. # noqa: E501
- Returns
The next_page_token of this ApiListPipelineVersionsResponse. # noqa: E501
- Return type
str
- Type
Gets the next_page_token of this ApiListPipelineVersionsResponse. # noqa
- openapi_types = {'next_page_token': 'str', 'total_size': 'int', 'versions': 'list[ApiPipelineVersion]'}
- property total_size
E501
The total number of pipeline versions for the given query. # noqa: E501
- Returns
The total_size of this ApiListPipelineVersionsResponse. # noqa: E501
- Return type
int
- Type
Gets the total_size of this ApiListPipelineVersionsResponse. # noqa
- property versions
E501
- Returns
The versions of this ApiListPipelineVersionsResponse. # noqa: E501
- Return type
list[ApiPipelineVersion]
- Type
Gets the versions of this ApiListPipelineVersionsResponse. # noqa
- class kfp_server_api.models.ApiListPipelinesResponse(pipelines=None, total_size=None, next_page_token=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'next_page_token': 'next_page_token', 'pipelines': 'pipelines', 'total_size': 'total_size'}
- property next_page_token
E501
The token to list the next page of pipelines. # noqa: E501
- Returns
The next_page_token of this ApiListPipelinesResponse. # noqa: E501
- Return type
str
- Type
Gets the next_page_token of this ApiListPipelinesResponse. # noqa
- openapi_types = {'next_page_token': 'str', 'pipelines': 'list[ApiPipeline]', 'total_size': 'int'}
- property pipelines
E501
- Returns
The pipelines of this ApiListPipelinesResponse. # noqa: E501
- Return type
list[ApiPipeline]
- Type
Gets the pipelines of this ApiListPipelinesResponse. # noqa
- property total_size
E501
The total number of pipelines for the given query. # noqa: E501
- Returns
The total_size of this ApiListPipelinesResponse. # noqa: E501
- Return type
int
- Type
Gets the total_size of this ApiListPipelinesResponse. # noqa
- class kfp_server_api.models.ApiListRunsResponse(runs=None, total_size=None, next_page_token=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'next_page_token': 'next_page_token', 'runs': 'runs', 'total_size': 'total_size'}
- property next_page_token
E501
The token to list the next page of runs. # noqa: E501
- Returns
The next_page_token of this ApiListRunsResponse. # noqa: E501
- Return type
str
- Type
Gets the next_page_token of this ApiListRunsResponse. # noqa
- openapi_types = {'next_page_token': 'str', 'runs': 'list[ApiRun]', 'total_size': 'int'}
- property runs
E501
- Returns
The runs of this ApiListRunsResponse. # noqa: E501
- Return type
list[ApiRun]
- Type
Gets the runs of this ApiListRunsResponse. # noqa
- property total_size
E501
The total number of runs for the given query. # noqa: E501
- Returns
The total_size of this ApiListRunsResponse. # noqa: E501
- Return type
int
- Type
Gets the total_size of this ApiListRunsResponse. # noqa
- class kfp_server_api.models.ApiParameter(name=None, value=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'name': 'name', 'value': 'value'}
- property name
E501
- Returns
The name of this ApiParameter. # noqa: E501
- Return type
str
- Type
Gets the name of this ApiParameter. # noqa
- openapi_types = {'name': 'str', 'value': 'str'}
- property value
E501
- Returns
The value of this ApiParameter. # noqa: E501
- Return type
str
- Type
Gets the value of this ApiParameter. # noqa
- class kfp_server_api.models.ApiPeriodicSchedule(start_time=None, end_time=None, interval_second=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'end_time': 'end_time', 'interval_second': 'interval_second', 'start_time': 'start_time'}
- property end_time
E501
- Returns
The end_time of this ApiPeriodicSchedule. # noqa: E501
- Return type
datetime
- Type
Gets the end_time of this ApiPeriodicSchedule. # noqa
- property interval_second
E501
- Returns
The interval_second of this ApiPeriodicSchedule. # noqa: E501
- Return type
str
- Type
Gets the interval_second of this ApiPeriodicSchedule. # noqa
- openapi_types = {'end_time': 'datetime', 'interval_second': 'str', 'start_time': 'datetime'}
- property start_time
E501
- Returns
The start_time of this ApiPeriodicSchedule. # noqa: E501
- Return type
datetime
- Type
Gets the start_time of this ApiPeriodicSchedule. # noqa
- class kfp_server_api.models.ApiPipeline(id=None, created_at=None, name=None, description=None, parameters=None, url=None, error=None, default_version=None, resource_references=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'created_at': 'created_at', 'default_version': 'default_version', 'description': 'description', 'error': 'error', 'id': 'id', 'name': 'name', 'parameters': 'parameters', 'resource_references': 'resource_references', 'url': 'url'}
- property created_at
E501
Output. The time this pipeline is created. # noqa: E501
- Returns
The created_at of this ApiPipeline. # noqa: E501
- Return type
datetime
- Type
Gets the created_at of this ApiPipeline. # noqa
- property default_version
E501
- Returns
The default_version of this ApiPipeline. # noqa: E501
- Return type
- Type
Gets the default_version of this ApiPipeline. # noqa
- property description
E501
Optional input field. Describing the purpose of the job. # noqa: E501
- Returns
The description of this ApiPipeline. # noqa: E501
- Return type
str
- Type
Gets the description of this ApiPipeline. # noqa
- property error
E501
In case any error happens retrieving a pipeline field, only pipeline ID and the error message is returned. Client has the flexibility of choosing how to handle error. This is especially useful during listing call. # noqa: E501
- Returns
The error of this ApiPipeline. # noqa: E501
- Return type
str
- Type
Gets the error of this ApiPipeline. # noqa
- property id
E501
Output. Unique pipeline ID. Generated by API server. # noqa: E501
- Returns
The id of this ApiPipeline. # noqa: E501
- Return type
str
- Type
Gets the id of this ApiPipeline. # noqa
- property name
E501
Optional input field. Pipeline name provided by user. If not specified, file name is used as pipeline name. # noqa: E501
- Returns
The name of this ApiPipeline. # noqa: E501
- Return type
str
- Type
Gets the name of this ApiPipeline. # noqa
- openapi_types = {'created_at': 'datetime', 'default_version': 'ApiPipelineVersion', 'description': 'str', 'error': 'str', 'id': 'str', 'name': 'str', 'parameters': 'list[ApiParameter]', 'resource_references': 'list[ApiResourceReference]', 'url': 'ApiUrl'}
- property parameters
E501
Output. The input parameters for this pipeline. TODO(jingzhang36): replace this parameters field with the parameters field inside PipelineVersion when all usage of the former has been changed to use the latter. # noqa: E501
- Returns
The parameters of this ApiPipeline. # noqa: E501
- Return type
list[ApiParameter]
- Type
Gets the parameters of this ApiPipeline. # noqa
- property resource_references
E501
Input field. Specify which resource this pipeline belongs to. For Pipeline, the only valid resource reference is a single Namespace. # noqa: E501
- Returns
The resource_references of this ApiPipeline. # noqa: E501
- Return type
list[ApiResourceReference]
- Type
Gets the resource_references of this ApiPipeline. # noqa
- class kfp_server_api.models.ApiPipelineRuntime(pipeline_manifest=None, workflow_manifest=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'pipeline_manifest': 'pipeline_manifest', 'workflow_manifest': 'workflow_manifest'}
- openapi_types = {'pipeline_manifest': 'str', 'workflow_manifest': 'str'}
- property pipeline_manifest
E501
Output. The runtime JSON manifest of the pipeline, including the status of pipeline steps and fields need for UI visualization etc. # noqa: E501
- Returns
The pipeline_manifest of this ApiPipelineRuntime. # noqa: E501
- Return type
str
- Type
Gets the pipeline_manifest of this ApiPipelineRuntime. # noqa
- property workflow_manifest
E501
Output. The runtime JSON manifest of the argo workflow. This is deprecated after pipeline_runtime_manifest is in use. # noqa: E501
- Returns
The workflow_manifest of this ApiPipelineRuntime. # noqa: E501
- Return type
str
- Type
Gets the workflow_manifest of this ApiPipelineRuntime. # noqa
- class kfp_server_api.models.ApiPipelineSpec(pipeline_id=None, pipeline_name=None, workflow_manifest=None, pipeline_manifest=None, parameters=None, runtime_config=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'parameters': 'parameters', 'pipeline_id': 'pipeline_id', 'pipeline_manifest': 'pipeline_manifest', 'pipeline_name': 'pipeline_name', 'runtime_config': 'runtime_config', 'workflow_manifest': 'workflow_manifest'}
- openapi_types = {'parameters': 'list[ApiParameter]', 'pipeline_id': 'str', 'pipeline_manifest': 'str', 'pipeline_name': 'str', 'runtime_config': 'PipelineSpecRuntimeConfig', 'workflow_manifest': 'str'}
- property parameters
E501
- Returns
The parameters of this ApiPipelineSpec. # noqa: E501
- Return type
list[ApiParameter]
- Type
Gets the parameters of this ApiPipelineSpec. # noqa
- property pipeline_id
E501
Optional input field. The ID of the pipeline user uploaded before. # noqa: E501
- Returns
The pipeline_id of this ApiPipelineSpec. # noqa: E501
- Return type
str
- Type
Gets the pipeline_id of this ApiPipelineSpec. # noqa
- property pipeline_manifest
E501
Optional input field. The raw pipeline JSON spec. # noqa: E501
- Returns
The pipeline_manifest of this ApiPipelineSpec. # noqa: E501
- Return type
str
- Type
Gets the pipeline_manifest of this ApiPipelineSpec. # noqa
- property pipeline_name
E501
Optional output field. The name of the pipeline. Not empty if the pipeline id is not empty. # noqa: E501
- Returns
The pipeline_name of this ApiPipelineSpec. # noqa: E501
- Return type
str
- Type
Gets the pipeline_name of this ApiPipelineSpec. # noqa
- property runtime_config
E501
- Returns
The runtime_config of this ApiPipelineSpec. # noqa: E501
- Return type
- Type
Gets the runtime_config of this ApiPipelineSpec. # noqa
- property workflow_manifest
E501
Optional input field. The marshalled raw argo JSON workflow. This will be deprecated when pipeline_manifest is in use. # noqa: E501
- Returns
The workflow_manifest of this ApiPipelineSpec. # noqa: E501
- Return type
str
- Type
Gets the workflow_manifest of this ApiPipelineSpec. # noqa
- class kfp_server_api.models.ApiPipelineVersion(id=None, name=None, created_at=None, parameters=None, code_source_url=None, package_url=None, resource_references=None, description=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'code_source_url': 'code_source_url', 'created_at': 'created_at', 'description': 'description', 'id': 'id', 'name': 'name', 'package_url': 'package_url', 'parameters': 'parameters', 'resource_references': 'resource_references'}
- property code_source_url
E501
Input. Optional. Pipeline version code source. # noqa: E501
- Returns
The code_source_url of this ApiPipelineVersion. # noqa: E501
- Return type
str
- Type
Gets the code_source_url of this ApiPipelineVersion. # noqa
- property created_at
E501
Output. The time this pipeline version is created. # noqa: E501
- Returns
The created_at of this ApiPipelineVersion. # noqa: E501
- Return type
datetime
- Type
Gets the created_at of this ApiPipelineVersion. # noqa
- property description
E501
Input. Optional. Description for the pipeline version. # noqa: E501
- Returns
The description of this ApiPipelineVersion. # noqa: E501
- Return type
str
- Type
Gets the description of this ApiPipelineVersion. # noqa
- property id
E501
Output. Unique version ID. Generated by API server. # noqa: E501
- Returns
The id of this ApiPipelineVersion. # noqa: E501
- Return type
str
- Type
Gets the id of this ApiPipelineVersion. # noqa
- property name
E501
Optional input field. Version name provided by user. # noqa: E501
- Returns
The name of this ApiPipelineVersion. # noqa: E501
- Return type
str
- Type
Gets the name of this ApiPipelineVersion. # noqa
- openapi_types = {'code_source_url': 'str', 'created_at': 'datetime', 'description': 'str', 'id': 'str', 'name': 'str', 'package_url': 'ApiUrl', 'parameters': 'list[ApiParameter]', 'resource_references': 'list[ApiResourceReference]'}
- property package_url
E501
- Returns
The package_url of this ApiPipelineVersion. # noqa: E501
- Return type
- Type
Gets the package_url of this ApiPipelineVersion. # noqa
- property parameters
E501
Output. The input parameters for this pipeline. # noqa: E501
- Returns
The parameters of this ApiPipelineVersion. # noqa: E501
- Return type
list[ApiParameter]
- Type
Gets the parameters of this ApiPipelineVersion. # noqa
- property resource_references
E501
Input. Required. E.g., specify which pipeline this pipeline version belongs to. # noqa: E501
- Returns
The resource_references of this ApiPipelineVersion. # noqa: E501
- Return type
list[ApiResourceReference]
- Type
Gets the resource_references of this ApiPipelineVersion. # noqa
- class kfp_server_api.models.ApiReadArtifactResponse(data=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'data': 'data'}
- property data
E501
The bytes of the artifact content. # noqa: E501
- Returns
The data of this ApiReadArtifactResponse. # noqa: E501
- Return type
str
- Type
Gets the data of this ApiReadArtifactResponse. # noqa
- openapi_types = {'data': 'str'}
- class kfp_server_api.models.ApiRelationship(local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- CREATOR = 'CREATOR'
- OWNER = 'OWNER'
- UNKNOWN_RELATIONSHIP = 'UNKNOWN_RELATIONSHIP'
- allowable_values = ['UNKNOWN_RELATIONSHIP', 'OWNER', 'CREATOR']
Attributes: openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}
- openapi_types = {}
- class kfp_server_api.models.ApiReportRunMetricsRequest(run_id=None, metrics=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'metrics': 'metrics', 'run_id': 'run_id'}
- property metrics
E501
List of metrics to report. # noqa: E501
- Returns
The metrics of this ApiReportRunMetricsRequest. # noqa: E501
- Return type
list[ApiRunMetric]
- Type
Gets the metrics of this ApiReportRunMetricsRequest. # noqa
- openapi_types = {'metrics': 'list[ApiRunMetric]', 'run_id': 'str'}
- property run_id
E501
Required. The parent run ID of the metric. # noqa: E501
- Returns
The run_id of this ApiReportRunMetricsRequest. # noqa: E501
- Return type
str
- Type
Gets the run_id of this ApiReportRunMetricsRequest. # noqa
- class kfp_server_api.models.ApiReportRunMetricsResponse(results=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'results': 'results'}
- openapi_types = {'results': 'list[ReportRunMetricsResponseReportRunMetricResult]'}
- property results
E501
- Returns
The results of this ApiReportRunMetricsResponse. # noqa: E501
- Return type
- Type
Gets the results of this ApiReportRunMetricsResponse. # noqa
- class kfp_server_api.models.ApiResourceKey(type=None, id=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'id': 'id', 'type': 'type'}
- property id
E501
The ID of the resource that referred to. # noqa: E501
- Returns
The id of this ApiResourceKey. # noqa: E501
- Return type
str
- Type
Gets the id of this ApiResourceKey. # noqa
- openapi_types = {'id': 'str', 'type': 'ApiResourceType'}
- property type
E501
- Returns
The type of this ApiResourceKey. # noqa: E501
- Return type
- Type
Gets the type of this ApiResourceKey. # noqa
- class kfp_server_api.models.ApiResourceReference(key=None, name=None, relationship=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'key': 'key', 'name': 'name', 'relationship': 'relationship'}
- property key
E501
- Returns
The key of this ApiResourceReference. # noqa: E501
- Return type
- Type
Gets the key of this ApiResourceReference. # noqa
- property name
E501
The name of the resource that referred to. # noqa: E501
- Returns
The name of this ApiResourceReference. # noqa: E501
- Return type
str
- Type
Gets the name of this ApiResourceReference. # noqa
- openapi_types = {'key': 'ApiResourceKey', 'name': 'str', 'relationship': 'ApiRelationship'}
- property relationship
E501
- Returns
The relationship of this ApiResourceReference. # noqa: E501
- Return type
- Type
Gets the relationship of this ApiResourceReference. # noqa
- class kfp_server_api.models.ApiResourceType(local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- EXPERIMENT = 'EXPERIMENT'
- JOB = 'JOB'
- NAMESPACE = 'NAMESPACE'
- PIPELINE = 'PIPELINE'
- PIPELINE_VERSION = 'PIPELINE_VERSION'
- UNKNOWN_RESOURCE_TYPE = 'UNKNOWN_RESOURCE_TYPE'
- allowable_values = ['UNKNOWN_RESOURCE_TYPE', 'EXPERIMENT', 'JOB', 'PIPELINE', 'PIPELINE_VERSION', 'NAMESPACE']
Attributes: openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}
- openapi_types = {}
- class kfp_server_api.models.ApiRun(id=None, name=None, storage_state=None, description=None, pipeline_spec=None, resource_references=None, service_account=None, created_at=None, scheduled_at=None, finished_at=None, status=None, error=None, metrics=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'created_at': 'created_at', 'description': 'description', 'error': 'error', 'finished_at': 'finished_at', 'id': 'id', 'metrics': 'metrics', 'name': 'name', 'pipeline_spec': 'pipeline_spec', 'resource_references': 'resource_references', 'scheduled_at': 'scheduled_at', 'service_account': 'service_account', 'status': 'status', 'storage_state': 'storage_state'}
- property created_at
E501
Output. The time that the run created. # noqa: E501
- Returns
The created_at of this ApiRun. # noqa: E501
- Return type
datetime
- Type
Gets the created_at of this ApiRun. # noqa
- property description
E501
- Returns
The description of this ApiRun. # noqa: E501
- Return type
str
- Type
Gets the description of this ApiRun. # noqa
- property error
E501
In case any error happens retrieving a run field, only run ID and the error message is returned. Client has the flexibility of choosing how to handle error. This is especially useful during listing call. # noqa: E501
- Returns
The error of this ApiRun. # noqa: E501
- Return type
str
- Type
Gets the error of this ApiRun. # noqa
- property finished_at
E501
Output. The time this run is finished. # noqa: E501
- Returns
The finished_at of this ApiRun. # noqa: E501
- Return type
datetime
- Type
Gets the finished_at of this ApiRun. # noqa
- property id
E501
Output. Unique run ID. Generated by API server. # noqa: E501
- Returns
The id of this ApiRun. # noqa: E501
- Return type
str
- Type
Gets the id of this ApiRun. # noqa
- property metrics
E501
Output. The metrics of the run. The metrics are reported by ReportMetrics API. # noqa: E501
- Returns
The metrics of this ApiRun. # noqa: E501
- Return type
list[ApiRunMetric]
- Type
Gets the metrics of this ApiRun. # noqa
- property name
E501
Required input field. Name provided by user, or auto generated if run is created by scheduled job. Not unique. # noqa: E501
- Returns
The name of this ApiRun. # noqa: E501
- Return type
str
- Type
Gets the name of this ApiRun. # noqa
- openapi_types = {'created_at': 'datetime', 'description': 'str', 'error': 'str', 'finished_at': 'datetime', 'id': 'str', 'metrics': 'list[ApiRunMetric]', 'name': 'str', 'pipeline_spec': 'ApiPipelineSpec', 'resource_references': 'list[ApiResourceReference]', 'scheduled_at': 'datetime', 'service_account': 'str', 'status': 'str', 'storage_state': 'ApiRunStorageState'}
- property pipeline_spec
E501
- Returns
The pipeline_spec of this ApiRun. # noqa: E501
- Return type
- Type
Gets the pipeline_spec of this ApiRun. # noqa
- property resource_references
E501
Optional input field. Specify which resource this run belongs to. When creating a run from a particular pipeline version, the pipeline version can be specified here. # noqa: E501
- Returns
The resource_references of this ApiRun. # noqa: E501
- Return type
list[ApiResourceReference]
- Type
Gets the resource_references of this ApiRun. # noqa
- property scheduled_at
E501
Output. When this run is scheduled to run. This could be different from created_at. For example, if a run is from a backfilling job that was supposed to run 2 month ago, the scheduled_at is 2 month ago, v.s. created_at is the current time. # noqa: E501
- Returns
The scheduled_at of this ApiRun. # noqa: E501
- Return type
datetime
- Type
Gets the scheduled_at of this ApiRun. # noqa
- property service_account
E501
Optional input field. Specify which Kubernetes service account this run uses. # noqa: E501
- Returns
The service_account of this ApiRun. # noqa: E501
- Return type
str
- Type
Gets the service_account of this ApiRun. # noqa
- property status
E501
- Returns
The status of this ApiRun. # noqa: E501
- Return type
str
- Type
Gets the status of this ApiRun. # noqa
- property storage_state
E501
- Returns
The storage_state of this ApiRun. # noqa: E501
- Return type
- Type
Gets the storage_state of this ApiRun. # noqa
- class kfp_server_api.models.ApiRunDetail(run=None, pipeline_runtime=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'pipeline_runtime': 'pipeline_runtime', 'run': 'run'}
- openapi_types = {'pipeline_runtime': 'ApiPipelineRuntime', 'run': 'ApiRun'}
- property pipeline_runtime
E501
- Returns
The pipeline_runtime of this ApiRunDetail. # noqa: E501
- Return type
- Type
Gets the pipeline_runtime of this ApiRunDetail. # noqa
- property run
E501
- Returns
The run of this ApiRunDetail. # noqa: E501
- Return type
- Type
Gets the run of this ApiRunDetail. # noqa
- class kfp_server_api.models.ApiRunMetric(name=None, node_id=None, number_value=None, format=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'format': 'format', 'name': 'name', 'node_id': 'node_id', 'number_value': 'number_value'}
- property format
E501
- Returns
The format of this ApiRunMetric. # noqa: E501
- Return type
- Type
Gets the format of this ApiRunMetric. # noqa
- property name
E501
Required. The user defined name of the metric. It must between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. # noqa: E501
- Returns
The name of this ApiRunMetric. # noqa: E501
- Return type
str
- Type
Gets the name of this ApiRunMetric. # noqa
- property node_id
E501
Required. The runtime node ID which reports the metric. The node ID can be found in the RunDetail.workflow.Status. Metric with same (node_id, name) are considerd as duplicate. Only the first reporting will be recorded. Max length is 128. # noqa: E501
- Returns
The node_id of this ApiRunMetric. # noqa: E501
- Return type
str
- Type
Gets the node_id of this ApiRunMetric. # noqa
- property number_value
E501
The number value of the metric. # noqa: E501
- Returns
The number_value of this ApiRunMetric. # noqa: E501
- Return type
float
- Type
Gets the number_value of this ApiRunMetric. # noqa
- openapi_types = {'format': 'RunMetricFormat', 'name': 'str', 'node_id': 'str', 'number_value': 'float'}
- class kfp_server_api.models.ApiRunStorageState(local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- ARCHIVED = 'STORAGESTATE_ARCHIVED'
- AVAILABLE = 'STORAGESTATE_AVAILABLE'
- allowable_values = ['STORAGESTATE_AVAILABLE', 'STORAGESTATE_ARCHIVED']
Attributes: openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}
- openapi_types = {}
- class kfp_server_api.models.ApiStatus(error=None, code=None, details=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'code': 'code', 'details': 'details', 'error': 'error'}
- property code
E501
- Returns
The code of this ApiStatus. # noqa: E501
- Return type
int
- Type
Gets the code of this ApiStatus. # noqa
- property details
E501
- Returns
The details of this ApiStatus. # noqa: E501
- Return type
list[ProtobufAny]
- Type
Gets the details of this ApiStatus. # noqa
- property error
E501
- Returns
The error of this ApiStatus. # noqa: E501
- Return type
str
- Type
Gets the error of this ApiStatus. # noqa
- openapi_types = {'code': 'int', 'details': 'list[ProtobufAny]', 'error': 'str'}
- class kfp_server_api.models.ApiTrigger(cron_schedule=None, periodic_schedule=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'cron_schedule': 'cron_schedule', 'periodic_schedule': 'periodic_schedule'}
- property cron_schedule
E501
- Returns
The cron_schedule of this ApiTrigger. # noqa: E501
- Return type
- Type
Gets the cron_schedule of this ApiTrigger. # noqa
- openapi_types = {'cron_schedule': 'ApiCronSchedule', 'periodic_schedule': 'ApiPeriodicSchedule'}
- property periodic_schedule
E501
- Returns
The periodic_schedule of this ApiTrigger. # noqa: E501
- Return type
- Type
Gets the periodic_schedule of this ApiTrigger. # noqa
- class kfp_server_api.models.ApiUrl(pipeline_url=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'pipeline_url': 'pipeline_url'}
- openapi_types = {'pipeline_url': 'str'}
- property pipeline_url
E501
URL of the pipeline definition or the pipeline version definition. # noqa: E501
- Returns
The pipeline_url of this ApiUrl. # noqa: E501
- Return type
str
- Type
Gets the pipeline_url of this ApiUrl. # noqa
- class kfp_server_api.models.JobMode(local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- DISABLED = 'DISABLED'
- ENABLED = 'ENABLED'
- UNKNOWN_MODE = 'UNKNOWN_MODE'
- allowable_values = ['UNKNOWN_MODE', 'ENABLED', 'DISABLED']
Attributes: openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}
- openapi_types = {}
- class kfp_server_api.models.PipelineSpecRuntimeConfig(parameters=None, pipeline_root=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'parameters': 'parameters', 'pipeline_root': 'pipeline_root'}
- openapi_types = {'parameters': 'dict(str, ProtobufValue)', 'pipeline_root': 'str'}
- property parameters
E501
The runtime parameters of the PipelineSpec. The parameters will be used to replace the placeholders at runtime. # noqa: E501
- Returns
The parameters of this PipelineSpecRuntimeConfig. # noqa: E501
- Return type
dict(str, ProtobufValue)
- Type
Gets the parameters of this PipelineSpecRuntimeConfig. # noqa
- property pipeline_root
E501
- Returns
The pipeline_root of this PipelineSpecRuntimeConfig. # noqa: E501
- Return type
str
- Type
Gets the pipeline_root of this PipelineSpecRuntimeConfig. # noqa
- class kfp_server_api.models.ProtobufAny(type_url=None, value=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'type_url': 'type_url', 'value': 'value'}
- openapi_types = {'type_url': 'str', 'value': 'str'}
- property type_url
E501
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one “/” character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading “.” is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics. # noqa: E501
- Returns
The type_url of this ProtobufAny. # noqa: E501
- Return type
str
- Type
Gets the type_url of this ProtobufAny. # noqa
- property value
E501
Must be a valid serialized protocol buffer of the above specified type. # noqa: E501
- Returns
The value of this ProtobufAny. # noqa: E501
- Return type
str
- Type
Gets the value of this ProtobufAny. # noqa
- class kfp_server_api.models.ProtobufListValue(values=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'values': 'values'}
- openapi_types = {'values': 'list[ProtobufValue]'}
- property values
E501
Repeated field of dynamically typed values. # noqa: E501
- Returns
The values of this ProtobufListValue. # noqa: E501
- Return type
list[ProtobufValue]
- Type
Gets the values of this ProtobufListValue. # noqa
- class kfp_server_api.models.ProtobufNullValue(local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- NULL_VALUE = 'NULL_VALUE'
- allowable_values = ['NULL_VALUE']
Attributes: openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}
- openapi_types = {}
- class kfp_server_api.models.ProtobufStruct(fields=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'fields': 'fields'}
- property fields
E501
Unordered map of dynamically typed values. # noqa: E501
- Returns
The fields of this ProtobufStruct. # noqa: E501
- Return type
dict(str, ProtobufValue)
- Type
Gets the fields of this ProtobufStruct. # noqa
- openapi_types = {'fields': 'dict(str, ProtobufValue)'}
- class kfp_server_api.models.ProtobufValue(null_value=None, number_value=None, string_value=None, bool_value=None, struct_value=None, list_value=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'bool_value': 'bool_value', 'list_value': 'list_value', 'null_value': 'null_value', 'number_value': 'number_value', 'string_value': 'string_value', 'struct_value': 'struct_value'}
- property bool_value
E501
Represents a boolean value. # noqa: E501
- Returns
The bool_value of this ProtobufValue. # noqa: E501
- Return type
bool
- Type
Gets the bool_value of this ProtobufValue. # noqa
- property list_value
E501
- Returns
The list_value of this ProtobufValue. # noqa: E501
- Return type
- Type
Gets the list_value of this ProtobufValue. # noqa
- property null_value
E501
- Returns
The null_value of this ProtobufValue. # noqa: E501
- Return type
- Type
Gets the null_value of this ProtobufValue. # noqa
- property number_value
E501
Represents a double value. # noqa: E501
- Returns
The number_value of this ProtobufValue. # noqa: E501
- Return type
float
- Type
Gets the number_value of this ProtobufValue. # noqa
- openapi_types = {'bool_value': 'bool', 'list_value': 'ProtobufListValue', 'null_value': 'ProtobufNullValue', 'number_value': 'float', 'string_value': 'str', 'struct_value': 'ProtobufStruct'}
- property string_value
E501
Represents a string value. # noqa: E501
- Returns
The string_value of this ProtobufValue. # noqa: E501
- Return type
str
- Type
Gets the string_value of this ProtobufValue. # noqa
- property struct_value
E501
- Returns
The struct_value of this ProtobufValue. # noqa: E501
- Return type
- Type
Gets the struct_value of this ProtobufValue. # noqa
- class kfp_server_api.models.ReportRunMetricsResponseReportRunMetricResult(metric_name=None, metric_node_id=None, status=None, message=None, local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- attribute_map = {'message': 'message', 'metric_name': 'metric_name', 'metric_node_id': 'metric_node_id', 'status': 'status'}
- property message
E501
Output. The detailed message of the error of the reporting. # noqa: E501
- Returns
The message of this ReportRunMetricsResponseReportRunMetricResult. # noqa: E501
- Return type
str
- Type
Gets the message of this ReportRunMetricsResponseReportRunMetricResult. # noqa
- property metric_name
E501
Output. The name of the metric. # noqa: E501
- Returns
The metric_name of this ReportRunMetricsResponseReportRunMetricResult. # noqa: E501
- Return type
str
- Type
Gets the metric_name of this ReportRunMetricsResponseReportRunMetricResult. # noqa
- property metric_node_id
E501
Output. The ID of the node which reports the metric. # noqa: E501
- Returns
The metric_node_id of this ReportRunMetricsResponseReportRunMetricResult. # noqa: E501
- Return type
str
- Type
Gets the metric_node_id of this ReportRunMetricsResponseReportRunMetricResult. # noqa
- openapi_types = {'message': 'str', 'metric_name': 'str', 'metric_node_id': 'str', 'status': 'ReportRunMetricsResponseReportRunMetricResultStatus'}
- property status
E501
- Returns
The status of this ReportRunMetricsResponseReportRunMetricResult. # noqa: E501
- Return type
- Type
Gets the status of this ReportRunMetricsResponseReportRunMetricResult. # noqa
- class kfp_server_api.models.ReportRunMetricsResponseReportRunMetricResultStatus(local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- DUPLICATE_REPORTING = 'DUPLICATE_REPORTING'
- INTERNAL_ERROR = 'INTERNAL_ERROR'
- INVALID_ARGUMENT = 'INVALID_ARGUMENT'
- OK = 'OK'
- UNSPECIFIED = 'UNSPECIFIED'
- allowable_values = ['UNSPECIFIED', 'OK', 'INVALID_ARGUMENT', 'DUPLICATE_REPORTING', 'INTERNAL_ERROR']
Attributes: openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}
- openapi_types = {}
- class kfp_server_api.models.RunMetricFormat(local_vars_configuration=None)[source]
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
- PERCENTAGE = 'PERCENTAGE'
- RAW = 'RAW'
- UNSPECIFIED = 'UNSPECIFIED'
- allowable_values = ['UNSPECIFIED', 'RAW', 'PERCENTAGE']
Attributes: openapi_types (dict): The key is attribute name
and the value is attribute type.
- attribute_map (dict): The key is attribute name
and the value is json key in definition.
- attribute_map = {}
- openapi_types = {}