kfp-server-api 2.0.5__tar.gz → 2.2.0__tar.gz

{kfp-server-api-2.0.5 → kfp-server-api-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kfp-server-api
-Version: 2.0.5
+Version: 2.2.0
 Summary: Kubeflow Pipelines API
 Home-page: https://github.com/kubeflow/pipelines
 Author: google

kfp-server-api-2.2.0/README.md

@@ -0,0 +1,202 @@
+# kfp-server-api
+This file contains REST API specification for Kubeflow Pipelines. The file is autogenerated from the swagger definition.
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 2.2.0
+- Package version: 2.2.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+For more information, please visit [https://www.google.com](https://www.google.com)
+
+## Requirements.
+
+Python 2.7 and 3.4+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import kfp_server_api
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import kfp_server_api
+```
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+from __future__ import print_function
+
+import time
+import kfp_server_api
+from kfp_server_api.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = kfp_server_api.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: Bearer
+configuration = kfp_server_api.Configuration(
+    host = "http://localhost",
+    api_key = {
+        'authorization': 'YOUR_API_KEY'
+    }
+)
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['authorization'] = 'Bearer'
+
+
+# Enter a context with an instance of the API client
+with kfp_server_api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = kfp_server_api.AuthServiceApi(api_client)
+    namespace = 'namespace_example' # str |  (optional)
+resources = 'UNASSIGNED_RESOURCES' # str |  (optional) (default to 'UNASSIGNED_RESOURCES')
+verb = 'UNASSIGNED_VERB' # str |  (optional) (default to 'UNASSIGNED_VERB')
+
+    try:
+        api_response = api_instance.auth_service_authorize(namespace=namespace, resources=resources, verb=verb)
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling AuthServiceApi->auth_service_authorize: %s\n" % e)
+    
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AuthServiceApi* | [**auth_service_authorize**](docs/AuthServiceApi.md#auth_service_authorize) | **GET** /apis/v2beta1/auth | 
+*ExperimentServiceApi* | [**experiment_service_archive_experiment**](docs/ExperimentServiceApi.md#experiment_service_archive_experiment) | **POST** /apis/v2beta1/experiments/{experiment_id}:archive | Archives an experiment and the experiment's runs and recurring runs.
+*ExperimentServiceApi* | [**experiment_service_create_experiment**](docs/ExperimentServiceApi.md#experiment_service_create_experiment) | **POST** /apis/v2beta1/experiments | Creates a new experiment.
+*ExperimentServiceApi* | [**experiment_service_delete_experiment**](docs/ExperimentServiceApi.md#experiment_service_delete_experiment) | **DELETE** /apis/v2beta1/experiments/{experiment_id} | Deletes an experiment without deleting the experiment's runs and recurring  runs. To avoid unexpected behaviors, delete an experiment's runs and recurring  runs before deleting the experiment.
+*ExperimentServiceApi* | [**experiment_service_get_experiment**](docs/ExperimentServiceApi.md#experiment_service_get_experiment) | **GET** /apis/v2beta1/experiments/{experiment_id} | Finds a specific experiment by ID.
+*ExperimentServiceApi* | [**experiment_service_list_experiments**](docs/ExperimentServiceApi.md#experiment_service_list_experiments) | **GET** /apis/v2beta1/experiments | Finds all experiments. Supports pagination, and sorting on certain fields.
+*ExperimentServiceApi* | [**experiment_service_unarchive_experiment**](docs/ExperimentServiceApi.md#experiment_service_unarchive_experiment) | **POST** /apis/v2beta1/experiments/{experiment_id}:unarchive | Restores an archived experiment. The experiment's archived runs and recurring runs will stay archived.
+*HealthzServiceApi* | [**healthz_service_get_healthz**](docs/HealthzServiceApi.md#healthz_service_get_healthz) | **GET** /apis/v2beta1/healthz | Get healthz data.
+*PipelineServiceApi* | [**pipeline_service_create_pipeline**](docs/PipelineServiceApi.md#pipeline_service_create_pipeline) | **POST** /apis/v2beta1/pipelines | Creates a pipeline.
+*PipelineServiceApi* | [**pipeline_service_create_pipeline_and_version**](docs/PipelineServiceApi.md#pipeline_service_create_pipeline_and_version) | **POST** /apis/v2beta1/pipelines/create | Creates a new pipeline and a new pipeline version in a single transaction.
+*PipelineServiceApi* | [**pipeline_service_create_pipeline_version**](docs/PipelineServiceApi.md#pipeline_service_create_pipeline_version) | **POST** /apis/v2beta1/pipelines/{pipeline_id}/versions | Adds a pipeline version to the specified pipeline ID.
+*PipelineServiceApi* | [**pipeline_service_delete_pipeline**](docs/PipelineServiceApi.md#pipeline_service_delete_pipeline) | **DELETE** /apis/v2beta1/pipelines/{pipeline_id} | Deletes an empty pipeline by ID. Returns error if the pipeline has pipeline versions.
+*PipelineServiceApi* | [**pipeline_service_delete_pipeline_version**](docs/PipelineServiceApi.md#pipeline_service_delete_pipeline_version) | **DELETE** /apis/v2beta1/pipelines/{pipeline_id}/versions/{pipeline_version_id} | Deletes a specific pipeline version by pipeline version ID and pipeline ID.
+*PipelineServiceApi* | [**pipeline_service_get_pipeline**](docs/PipelineServiceApi.md#pipeline_service_get_pipeline) | **GET** /apis/v2beta1/pipelines/{pipeline_id} | Finds a specific pipeline by ID.
+*PipelineServiceApi* | [**pipeline_service_get_pipeline_by_name**](docs/PipelineServiceApi.md#pipeline_service_get_pipeline_by_name) | **GET** /apis/v2beta1/pipelines/names/{name} | Finds a specific pipeline by name and namespace.
+*PipelineServiceApi* | [**pipeline_service_get_pipeline_version**](docs/PipelineServiceApi.md#pipeline_service_get_pipeline_version) | **GET** /apis/v2beta1/pipelines/{pipeline_id}/versions/{pipeline_version_id} | Gets a pipeline version by pipeline version ID and pipeline ID.
+*PipelineServiceApi* | [**pipeline_service_list_pipeline_versions**](docs/PipelineServiceApi.md#pipeline_service_list_pipeline_versions) | **GET** /apis/v2beta1/pipelines/{pipeline_id}/versions | Lists all pipeline versions of a given pipeline ID.
+*PipelineServiceApi* | [**pipeline_service_list_pipelines**](docs/PipelineServiceApi.md#pipeline_service_list_pipelines) | **GET** /apis/v2beta1/pipelines | Finds all pipelines within a namespace.
+*PipelineUploadServiceApi* | [**upload_pipeline**](docs/PipelineUploadServiceApi.md#upload_pipeline) | **POST** /apis/v2beta1/pipelines/upload | 
+*PipelineUploadServiceApi* | [**upload_pipeline_version**](docs/PipelineUploadServiceApi.md#upload_pipeline_version) | **POST** /apis/v2beta1/pipelines/upload_version | 
+*RecurringRunServiceApi* | [**recurring_run_service_create_recurring_run**](docs/RecurringRunServiceApi.md#recurring_run_service_create_recurring_run) | **POST** /apis/v2beta1/recurringruns | Creates a new recurring run in an experiment, given the experiment ID.
+*RecurringRunServiceApi* | [**recurring_run_service_delete_recurring_run**](docs/RecurringRunServiceApi.md#recurring_run_service_delete_recurring_run) | **DELETE** /apis/v2beta1/recurringruns/{recurring_run_id} | Deletes a recurring run.
+*RecurringRunServiceApi* | [**recurring_run_service_disable_recurring_run**](docs/RecurringRunServiceApi.md#recurring_run_service_disable_recurring_run) | **POST** /apis/v2beta1/recurringruns/{recurring_run_id}:disable | Stops a recurring run and all its associated runs. The recurring run is not deleted.
+*RecurringRunServiceApi* | [**recurring_run_service_enable_recurring_run**](docs/RecurringRunServiceApi.md#recurring_run_service_enable_recurring_run) | **POST** /apis/v2beta1/recurringruns/{recurring_run_id}:enable | Restarts a recurring run that was previously stopped. All runs associated with the  recurring run will continue.
+*RecurringRunServiceApi* | [**recurring_run_service_get_recurring_run**](docs/RecurringRunServiceApi.md#recurring_run_service_get_recurring_run) | **GET** /apis/v2beta1/recurringruns/{recurring_run_id} | Finds a specific recurring run by ID.
+*RecurringRunServiceApi* | [**recurring_run_service_list_recurring_runs**](docs/RecurringRunServiceApi.md#recurring_run_service_list_recurring_runs) | **GET** /apis/v2beta1/recurringruns | Finds all recurring runs given experiment and namespace.  If experiment ID is not specified, find all recurring runs across all experiments.
+*ReportServiceApi* | [**report_service_report_scheduled_workflow**](docs/ReportServiceApi.md#report_service_report_scheduled_workflow) | **POST** /apis/v2beta1/scheduledworkflows | 
+*ReportServiceApi* | [**report_service_report_workflow**](docs/ReportServiceApi.md#report_service_report_workflow) | **POST** /apis/v2beta1/workflows | 
+*RunServiceApi* | [**run_service_archive_run**](docs/RunServiceApi.md#run_service_archive_run) | **POST** /apis/v2beta1/runs/{run_id}:archive | Archives a run in an experiment given by run ID and experiment ID.
+*RunServiceApi* | [**run_service_create_run**](docs/RunServiceApi.md#run_service_create_run) | **POST** /apis/v2beta1/runs | Creates a new run in an experiment specified by experiment ID.  If experiment ID is not specified, the run is created in the default experiment.
+*RunServiceApi* | [**run_service_delete_run**](docs/RunServiceApi.md#run_service_delete_run) | **DELETE** /apis/v2beta1/runs/{run_id} | Deletes a run in an experiment given by run ID and experiment ID.
+*RunServiceApi* | [**run_service_get_run**](docs/RunServiceApi.md#run_service_get_run) | **GET** /apis/v2beta1/runs/{run_id} | Finds a specific run by ID.
+*RunServiceApi* | [**run_service_list_runs**](docs/RunServiceApi.md#run_service_list_runs) | **GET** /apis/v2beta1/runs | Finds all runs in an experiment given by experiment ID.  If experiment id is not specified, finds all runs across all experiments.
+*RunServiceApi* | [**run_service_read_artifact**](docs/RunServiceApi.md#run_service_read_artifact) | **GET** /apis/v2beta1/runs/{run_id}/nodes/{node_id}/artifacts/{artifact_name}:read | Finds artifact data in a run.
+*RunServiceApi* | [**run_service_retry_run**](docs/RunServiceApi.md#run_service_retry_run) | **POST** /apis/v2beta1/runs/{run_id}:retry | Re-initiates a failed or terminated run.
+*RunServiceApi* | [**run_service_terminate_run**](docs/RunServiceApi.md#run_service_terminate_run) | **POST** /apis/v2beta1/runs/{run_id}:terminate | Terminates an active run.
+*RunServiceApi* | [**run_service_unarchive_run**](docs/RunServiceApi.md#run_service_unarchive_run) | **POST** /apis/v2beta1/runs/{run_id}:unarchive | Restores an archived run in an experiment given by run ID and experiment ID.
+*VisualizationServiceApi* | [**visualization_service_create_visualization_v1**](docs/VisualizationServiceApi.md#visualization_service_create_visualization_v1) | **POST** /apis/v2beta1/visualizations/{namespace} | 
+
+
+## Documentation For Models
+
+ - [AuthorizeRequestResources](docs/AuthorizeRequestResources.md)
+ - [AuthorizeRequestVerb](docs/AuthorizeRequestVerb.md)
+ - [GooglerpcStatus](docs/GooglerpcStatus.md)
+ - [PipelineTaskDetailChildTask](docs/PipelineTaskDetailChildTask.md)
+ - [PredicateIntValues](docs/PredicateIntValues.md)
+ - [PredicateLongValues](docs/PredicateLongValues.md)
+ - [PredicateStringValues](docs/PredicateStringValues.md)
+ - [ProtobufAny](docs/ProtobufAny.md)
+ - [ProtobufNullValue](docs/ProtobufNullValue.md)
+ - [RecurringRunMode](docs/RecurringRunMode.md)
+ - [RuntimeError](docs/RuntimeError.md)
+ - [V2beta1ArtifactList](docs/V2beta1ArtifactList.md)
+ - [V2beta1CreatePipelineAndVersionRequest](docs/V2beta1CreatePipelineAndVersionRequest.md)
+ - [V2beta1CronSchedule](docs/V2beta1CronSchedule.md)
+ - [V2beta1Experiment](docs/V2beta1Experiment.md)
+ - [V2beta1ExperimentStorageState](docs/V2beta1ExperimentStorageState.md)
+ - [V2beta1Filter](docs/V2beta1Filter.md)
+ - [V2beta1GetHealthzResponse](docs/V2beta1GetHealthzResponse.md)
+ - [V2beta1ListExperimentsResponse](docs/V2beta1ListExperimentsResponse.md)
+ - [V2beta1ListPipelineVersionsResponse](docs/V2beta1ListPipelineVersionsResponse.md)
+ - [V2beta1ListPipelinesResponse](docs/V2beta1ListPipelinesResponse.md)
+ - [V2beta1ListRecurringRunsResponse](docs/V2beta1ListRecurringRunsResponse.md)
+ - [V2beta1ListRunsResponse](docs/V2beta1ListRunsResponse.md)
+ - [V2beta1PeriodicSchedule](docs/V2beta1PeriodicSchedule.md)
+ - [V2beta1Pipeline](docs/V2beta1Pipeline.md)
+ - [V2beta1PipelineTaskDetail](docs/V2beta1PipelineTaskDetail.md)
+ - [V2beta1PipelineTaskExecutorDetail](docs/V2beta1PipelineTaskExecutorDetail.md)
+ - [V2beta1PipelineVersion](docs/V2beta1PipelineVersion.md)
+ - [V2beta1PipelineVersionReference](docs/V2beta1PipelineVersionReference.md)
+ - [V2beta1Predicate](docs/V2beta1Predicate.md)
+ - [V2beta1PredicateOperation](docs/V2beta1PredicateOperation.md)
+ - [V2beta1ReadArtifactResponse](docs/V2beta1ReadArtifactResponse.md)
+ - [V2beta1RecurringRun](docs/V2beta1RecurringRun.md)
+ - [V2beta1RecurringRunStatus](docs/V2beta1RecurringRunStatus.md)
+ - [V2beta1Run](docs/V2beta1Run.md)
+ - [V2beta1RunDetails](docs/V2beta1RunDetails.md)
+ - [V2beta1RunStorageState](docs/V2beta1RunStorageState.md)
+ - [V2beta1RuntimeConfig](docs/V2beta1RuntimeConfig.md)
+ - [V2beta1RuntimeState](docs/V2beta1RuntimeState.md)
+ - [V2beta1RuntimeStatus](docs/V2beta1RuntimeStatus.md)
+ - [V2beta1Trigger](docs/V2beta1Trigger.md)
+ - [V2beta1Url](docs/V2beta1Url.md)
+ - [V2beta1Visualization](docs/V2beta1Visualization.md)
+ - [V2beta1VisualizationType](docs/V2beta1VisualizationType.md)
+
+
+## Documentation For Authorization
+
+
+## Bearer
+
+- **Type**: API key
+- **API key parameter name**: authorization
+- **Location**: HTTP header
+
+
+## Author
+
+kubeflow-pipelines@google.com
+
+

{kfp-server-api-2.0.5 → kfp-server-api-2.2.0}/kfp_server_api/__init__.py

@@ -14,7 +14,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "2.0.5"
+__version__ = "2.2.0"
 
 # import apis into sdk package
 from kfp_server_api.api.auth_service_api import AuthServiceApi
@@ -46,6 +46,7 @@ from kfp_server_api.models.predicate_string_values import PredicateStringValues
 from kfp_server_api.models.protobuf_any import ProtobufAny
 from kfp_server_api.models.protobuf_null_value import ProtobufNullValue
 from kfp_server_api.models.recurring_run_mode import RecurringRunMode
+from kfp_server_api.models.runtime_error import RuntimeError
 from kfp_server_api.models.v2beta1_artifact_list import V2beta1ArtifactList
 from kfp_server_api.models.v2beta1_create_pipeline_and_version_request import V2beta1CreatePipelineAndVersionRequest
 from kfp_server_api.models.v2beta1_cron_schedule import V2beta1CronSchedule

{kfp-server-api-2.0.5 → kfp-server-api-2.2.0}/kfp_server_api/api/auth_service_api.py

@@ -36,13 +36,13 @@ class AuthServiceApi(object):
             api_client = ApiClient()
         self.api_client = api_client
 
-    def authorize(self, **kwargs):  # noqa: E501
-        """authorize  # noqa: E501
+    def auth_service_authorize(self, **kwargs):  # noqa: E501
+        """auth_service_authorize  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.authorize(async_req=True)
+        >>> thread = api.auth_service_authorize(async_req=True)
         >>> result = thread.get()
 
         :param namespace:
@@ -66,15 +66,15 @@ class AuthServiceApi(object):
         :rtype: object
         """
         kwargs['_return_http_data_only'] = True
-        return self.authorize_with_http_info(**kwargs)  # noqa: E501
+        return self.auth_service_authorize_with_http_info(**kwargs)  # noqa: E501
 
-    def authorize_with_http_info(self, **kwargs):  # noqa: E501
-        """authorize  # noqa: E501
+    def auth_service_authorize_with_http_info(self, **kwargs):  # noqa: E501
+        """auth_service_authorize  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.authorize_with_http_info(async_req=True)
+        >>> thread = api.auth_service_authorize_with_http_info(async_req=True)
         >>> result = thread.get()
 
         :param namespace:
@@ -122,7 +122,7 @@ class AuthServiceApi(object):
             if key not in all_params:
                 raise ApiTypeError(
                     "Got an unexpected keyword argument '%s'"
-                    " to method authorize" % key
+                    " to method auth_service_authorize" % key
                 )
             local_var_params[key] = val
         del local_var_params['kwargs']

{kfp-server-api-2.0.5 → kfp-server-api-2.2.0}/kfp_server_api/api/experiment_service_api.py

@@ -36,13 +36,13 @@ class ExperimentServiceApi(object):
             api_client = ApiClient()
         self.api_client = api_client
 
-    def archive_experiment(self, experiment_id, **kwargs):  # noqa: E501
+    def experiment_service_archive_experiment(self, experiment_id, **kwargs):  # noqa: E501
         """Archives an experiment and the experiment's runs and recurring 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.archive_experiment(experiment_id, async_req=True)
+        >>> thread = api.experiment_service_archive_experiment(experiment_id, async_req=True)
         >>> result = thread.get()
 
         :param experiment_id: The ID of the experiment to be archived. (required)
@@ -62,15 +62,15 @@ class ExperimentServiceApi(object):
         :rtype: object
         """
         kwargs['_return_http_data_only'] = True
-        return self.archive_experiment_with_http_info(experiment_id, **kwargs)  # noqa: E501
+        return self.experiment_service_archive_experiment_with_http_info(experiment_id, **kwargs)  # noqa: E501
 
-    def archive_experiment_with_http_info(self, experiment_id, **kwargs):  # noqa: E501
+    def experiment_service_archive_experiment_with_http_info(self, experiment_id, **kwargs):  # noqa: E501
         """Archives an experiment and the experiment's runs and recurring 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.archive_experiment_with_http_info(experiment_id, async_req=True)
+        >>> thread = api.experiment_service_archive_experiment_with_http_info(experiment_id, async_req=True)
         >>> result = thread.get()
 
         :param experiment_id: The ID of the experiment to be archived. (required)
@@ -112,14 +112,14 @@ class ExperimentServiceApi(object):
             if key not in all_params:
                 raise ApiTypeError(
                     "Got an unexpected keyword argument '%s'"
-                    " to method archive_experiment" % key
+                    " to method experiment_service_archive_experiment" % key
                 )
             local_var_params[key] = val
         del local_var_params['kwargs']
         # verify the required parameter 'experiment_id' is set
         if self.api_client.client_side_validation and ('experiment_id' not in local_var_params or  # noqa: E501
                                                         local_var_params['experiment_id'] is None):  # noqa: E501
-            raise ApiValueError("Missing the required parameter `experiment_id` when calling `archive_experiment`")  # noqa: E501
+            raise ApiValueError("Missing the required parameter `experiment_id` when calling `experiment_service_archive_experiment`")  # noqa: E501
 
         collection_formats = {}
 
@@ -158,13 +158,13 @@ class ExperimentServiceApi(object):
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
 
-    def create_experiment(self, body, **kwargs):  # noqa: E501
+    def experiment_service_create_experiment(self, body, **kwargs):  # noqa: E501
         """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)
+        >>> thread = api.experiment_service_create_experiment(body, async_req=True)
         >>> result = thread.get()
 
         :param body: The experiment to be created. (required)
@@ -184,15 +184,15 @@ class ExperimentServiceApi(object):
         :rtype: V2beta1Experiment
         """
         kwargs['_return_http_data_only'] = True
-        return self.create_experiment_with_http_info(body, **kwargs)  # noqa: E501
+        return self.experiment_service_create_experiment_with_http_info(body, **kwargs)  # noqa: E501
 
-    def create_experiment_with_http_info(self, body, **kwargs):  # noqa: E501
+    def experiment_service_create_experiment_with_http_info(self, body, **kwargs):  # noqa: E501
         """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)
+        >>> thread = api.experiment_service_create_experiment_with_http_info(body, async_req=True)
         >>> result = thread.get()
 
         :param body: The experiment to be created. (required)
@@ -234,14 +234,14 @@ class ExperimentServiceApi(object):
             if key not in all_params:
                 raise ApiTypeError(
                     "Got an unexpected keyword argument '%s'"
-                    " to method create_experiment" % key
+                    " to method experiment_service_create_experiment" % key
                 )
             local_var_params[key] = val
         del local_var_params['kwargs']
         # verify the required parameter 'body' is set
         if self.api_client.client_side_validation and ('body' not in local_var_params or  # noqa: E501
                                                         local_var_params['body'] is None):  # noqa: E501
-            raise ApiValueError("Missing the required parameter `body` when calling `create_experiment`")  # noqa: E501
+            raise ApiValueError("Missing the required parameter `body` when calling `experiment_service_create_experiment`")  # noqa: E501
 
         collection_formats = {}
 
@@ -284,13 +284,13 @@ class ExperimentServiceApi(object):
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
 
-    def delete_experiment(self, experiment_id, **kwargs):  # noqa: E501
+    def experiment_service_delete_experiment(self, experiment_id, **kwargs):  # noqa: E501
         """Deletes an experiment without deleting the experiment's runs and recurring  runs. To avoid unexpected behaviors, delete an experiment's runs and recurring  runs 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(experiment_id, async_req=True)
+        >>> thread = api.experiment_service_delete_experiment(experiment_id, async_req=True)
         >>> result = thread.get()
 
         :param experiment_id: The ID of the experiment to be deleted. (required)
@@ -310,15 +310,15 @@ class ExperimentServiceApi(object):
         :rtype: object
         """
         kwargs['_return_http_data_only'] = True
-        return self.delete_experiment_with_http_info(experiment_id, **kwargs)  # noqa: E501
+        return self.experiment_service_delete_experiment_with_http_info(experiment_id, **kwargs)  # noqa: E501
 
-    def delete_experiment_with_http_info(self, experiment_id, **kwargs):  # noqa: E501
+    def experiment_service_delete_experiment_with_http_info(self, experiment_id, **kwargs):  # noqa: E501
         """Deletes an experiment without deleting the experiment's runs and recurring  runs. To avoid unexpected behaviors, delete an experiment's runs and recurring  runs 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(experiment_id, async_req=True)
+        >>> thread = api.experiment_service_delete_experiment_with_http_info(experiment_id, async_req=True)
         >>> result = thread.get()
 
         :param experiment_id: The ID of the experiment to be deleted. (required)
@@ -360,14 +360,14 @@ class ExperimentServiceApi(object):
             if key not in all_params:
                 raise ApiTypeError(
                     "Got an unexpected keyword argument '%s'"
-                    " to method delete_experiment" % key
+                    " to method experiment_service_delete_experiment" % key
                 )
             local_var_params[key] = val
         del local_var_params['kwargs']
         # verify the required parameter 'experiment_id' is set
         if self.api_client.client_side_validation and ('experiment_id' not in local_var_params or  # noqa: E501
                                                         local_var_params['experiment_id'] is None):  # noqa: E501
-            raise ApiValueError("Missing the required parameter `experiment_id` when calling `delete_experiment`")  # noqa: E501
+            raise ApiValueError("Missing the required parameter `experiment_id` when calling `experiment_service_delete_experiment`")  # noqa: E501
 
         collection_formats = {}
 
@@ -406,13 +406,13 @@ class ExperimentServiceApi(object):
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
 
-    def get_experiment(self, experiment_id, **kwargs):  # noqa: E501
+    def experiment_service_get_experiment(self, experiment_id, **kwargs):  # noqa: E501
         """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(experiment_id, async_req=True)
+        >>> thread = api.experiment_service_get_experiment(experiment_id, async_req=True)
         >>> result = thread.get()
 
         :param experiment_id: The ID of the experiment to be retrieved. (required)
@@ -432,15 +432,15 @@ class ExperimentServiceApi(object):
         :rtype: V2beta1Experiment
         """
         kwargs['_return_http_data_only'] = True
-        return self.get_experiment_with_http_info(experiment_id, **kwargs)  # noqa: E501
+        return self.experiment_service_get_experiment_with_http_info(experiment_id, **kwargs)  # noqa: E501
 
-    def get_experiment_with_http_info(self, experiment_id, **kwargs):  # noqa: E501
+    def experiment_service_get_experiment_with_http_info(self, experiment_id, **kwargs):  # noqa: E501
         """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(experiment_id, async_req=True)
+        >>> thread = api.experiment_service_get_experiment_with_http_info(experiment_id, async_req=True)
         >>> result = thread.get()
 
         :param experiment_id: The ID of the experiment to be retrieved. (required)
@@ -482,14 +482,14 @@ class ExperimentServiceApi(object):
             if key not in all_params:
                 raise ApiTypeError(
                     "Got an unexpected keyword argument '%s'"
-                    " to method get_experiment" % key
+                    " to method experiment_service_get_experiment" % key
                 )
             local_var_params[key] = val
         del local_var_params['kwargs']
         # verify the required parameter 'experiment_id' is set
         if self.api_client.client_side_validation and ('experiment_id' not in local_var_params or  # noqa: E501
                                                         local_var_params['experiment_id'] is None):  # noqa: E501
-            raise ApiValueError("Missing the required parameter `experiment_id` when calling `get_experiment`")  # noqa: E501
+            raise ApiValueError("Missing the required parameter `experiment_id` when calling `experiment_service_get_experiment`")  # noqa: E501
 
         collection_formats = {}
 
@@ -528,13 +528,13 @@ class ExperimentServiceApi(object):
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
 
-    def list_experiments(self, **kwargs):  # noqa: E501
+    def experiment_service_list_experiments(self, **kwargs):  # noqa: E501
         """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_experiments(async_req=True)
+        >>> thread = api.experiment_service_list_experiments(async_req=True)
         >>> result = thread.get()
 
         :param page_token: A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListExperiments call or can be omitted when fetching the first page.
@@ -562,15 +562,15 @@ class ExperimentServiceApi(object):
         :rtype: V2beta1ListExperimentsResponse
         """
         kwargs['_return_http_data_only'] = True
-        return self.list_experiments_with_http_info(**kwargs)  # noqa: E501
+        return self.experiment_service_list_experiments_with_http_info(**kwargs)  # noqa: E501
 
-    def list_experiments_with_http_info(self, **kwargs):  # noqa: E501
+    def experiment_service_list_experiments_with_http_info(self, **kwargs):  # noqa: E501
         """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_experiments_with_http_info(async_req=True)
+        >>> thread = api.experiment_service_list_experiments_with_http_info(async_req=True)
         >>> result = thread.get()
 
         :param page_token: A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListExperiments call or can be omitted when fetching the first page.
@@ -624,7 +624,7 @@ class ExperimentServiceApi(object):
             if key not in all_params:
                 raise ApiTypeError(
                     "Got an unexpected keyword argument '%s'"
-                    " to method list_experiments" % key
+                    " to method experiment_service_list_experiments" % key
                 )
             local_var_params[key] = val
         del local_var_params['kwargs']
@@ -674,13 +674,13 @@ class ExperimentServiceApi(object):
             _request_timeout=local_var_params.get('_request_timeout'),
             collection_formats=collection_formats)
 
-    def unarchive_experiment(self, experiment_id, **kwargs):  # noqa: E501
+    def experiment_service_unarchive_experiment(self, experiment_id, **kwargs):  # noqa: E501
         """Restores an archived experiment. The experiment's archived runs and recurring runs 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(experiment_id, async_req=True)
+        >>> thread = api.experiment_service_unarchive_experiment(experiment_id, async_req=True)
         >>> result = thread.get()
 
         :param experiment_id: The ID of the experiment to be restored. (required)
@@ -700,15 +700,15 @@ class ExperimentServiceApi(object):
         :rtype: object
         """
         kwargs['_return_http_data_only'] = True
-        return self.unarchive_experiment_with_http_info(experiment_id, **kwargs)  # noqa: E501
+        return self.experiment_service_unarchive_experiment_with_http_info(experiment_id, **kwargs)  # noqa: E501
 
-    def unarchive_experiment_with_http_info(self, experiment_id, **kwargs):  # noqa: E501
+    def experiment_service_unarchive_experiment_with_http_info(self, experiment_id, **kwargs):  # noqa: E501
         """Restores an archived experiment. The experiment's archived runs and recurring runs 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(experiment_id, async_req=True)
+        >>> thread = api.experiment_service_unarchive_experiment_with_http_info(experiment_id, async_req=True)
         >>> result = thread.get()
 
         :param experiment_id: The ID of the experiment to be restored. (required)
@@ -750,14 +750,14 @@ class ExperimentServiceApi(object):
             if key not in all_params:
                 raise ApiTypeError(
                     "Got an unexpected keyword argument '%s'"
-                    " to method unarchive_experiment" % key
+                    " to method experiment_service_unarchive_experiment" % key
                 )
             local_var_params[key] = val
         del local_var_params['kwargs']
         # verify the required parameter 'experiment_id' is set
         if self.api_client.client_side_validation and ('experiment_id' not in local_var_params or  # noqa: E501
                                                         local_var_params['experiment_id'] is None):  # noqa: E501
-            raise ApiValueError("Missing the required parameter `experiment_id` when calling `unarchive_experiment`")  # noqa: E501
+            raise ApiValueError("Missing the required parameter `experiment_id` when calling `experiment_service_unarchive_experiment`")  # noqa: E501
 
         collection_formats = {}
 

{kfp-server-api-2.0.5 → kfp-server-api-2.2.0}/kfp_server_api/api/healthz_service_api.py

@@ -36,13 +36,13 @@ class HealthzServiceApi(object):
             api_client = ApiClient()
         self.api_client = api_client
 
-    def get_healthz(self, **kwargs):  # noqa: E501
+    def healthz_service_get_healthz(self, **kwargs):  # noqa: E501
         """Get healthz 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.get_healthz(async_req=True)
+        >>> thread = api.healthz_service_get_healthz(async_req=True)
         >>> result = thread.get()
 
         :param async_req: Whether to execute the request asynchronously.
@@ -60,15 +60,15 @@ class HealthzServiceApi(object):
         :rtype: V2beta1GetHealthzResponse
         """
         kwargs['_return_http_data_only'] = True
-        return self.get_healthz_with_http_info(**kwargs)  # noqa: E501
+        return self.healthz_service_get_healthz_with_http_info(**kwargs)  # noqa: E501
 
-    def get_healthz_with_http_info(self, **kwargs):  # noqa: E501
+    def healthz_service_get_healthz_with_http_info(self, **kwargs):  # noqa: E501
         """Get healthz 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.get_healthz_with_http_info(async_req=True)
+        >>> thread = api.healthz_service_get_healthz_with_http_info(async_req=True)
         >>> result = thread.get()
 
         :param async_req: Whether to execute the request asynchronously.
@@ -107,7 +107,7 @@ class HealthzServiceApi(object):
             if key not in all_params:
                 raise ApiTypeError(
                     "Got an unexpected keyword argument '%s'"
-                    " to method get_healthz" % key
+                    " to method healthz_service_get_healthz" % key
                 )
             local_var_params[key] = val
         del local_var_params['kwargs']