# coding: utf-8
"""
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
"""
from __future__ import absolute_import
import re # noqa: F401
# python 2 and python 3 compatibility library
import six
from kfp_server_api.api_client import ApiClient
from kfp_server_api.exceptions import ( # noqa: F401
ApiTypeError,
ApiValueError
)
[docs]class PipelineUploadServiceApi(object):
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
[docs] def upload_pipeline(self, uploadfile, **kwargs): # noqa: E501
"""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()
:param uploadfile: The pipeline to upload. Maximum size of 32MB is supported. (required)
:type uploadfile: file
:param name:
:type name: str
:param description:
:type description: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _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.
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: ApiPipeline
"""
kwargs['_return_http_data_only'] = True
return self.upload_pipeline_with_http_info(uploadfile, **kwargs) # noqa: E501
[docs] def upload_pipeline_with_http_info(self, uploadfile, **kwargs): # noqa: E501
"""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()
:param uploadfile: The pipeline to upload. Maximum size of 32MB is supported. (required)
:type uploadfile: file
:param name:
:type name: str
:param description:
:type description: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _return_http_data_only: response data without head status code
and headers
:type _return_http_data_only: bool, optional
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:type _preload_content: bool, optional
:param _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.
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(ApiPipeline, status_code(int), headers(HTTPHeaderDict))
"""
local_var_params = locals()
all_params = [
'uploadfile',
'name',
'description'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method upload_pipeline" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'uploadfile' is set
if self.api_client.client_side_validation and ('uploadfile' not in local_var_params or # noqa: E501
local_var_params['uploadfile'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `uploadfile` when calling `upload_pipeline`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'name' in local_var_params and local_var_params['name'] is not None: # noqa: E501
query_params.append(('name', local_var_params['name'])) # noqa: E501
if 'description' in local_var_params and local_var_params['description'] is not None: # noqa: E501
query_params.append(('description', local_var_params['description'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
if 'uploadfile' in local_var_params:
local_var_files['uploadfile'] = local_var_params['uploadfile'] # noqa: E501
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['multipart/form-data']) # noqa: E501
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/apis/v1beta1/pipelines/upload', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiPipeline', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
[docs] def upload_pipeline_version(self, uploadfile, **kwargs): # noqa: E501
"""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()
:param uploadfile: The pipeline to upload. Maximum size of 32MB is supported. (required)
:type uploadfile: file
:param name:
:type name: str
:param pipelineid:
:type pipelineid: str
:param description:
:type description: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _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.
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: ApiPipelineVersion
"""
kwargs['_return_http_data_only'] = True
return self.upload_pipeline_version_with_http_info(uploadfile, **kwargs) # noqa: E501
[docs] def upload_pipeline_version_with_http_info(self, uploadfile, **kwargs): # noqa: E501
"""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()
:param uploadfile: The pipeline to upload. Maximum size of 32MB is supported. (required)
:type uploadfile: file
:param name:
:type name: str
:param pipelineid:
:type pipelineid: str
:param description:
:type description: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _return_http_data_only: response data without head status code
and headers
:type _return_http_data_only: bool, optional
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:type _preload_content: bool, optional
:param _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.
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(ApiPipelineVersion, status_code(int), headers(HTTPHeaderDict))
"""
local_var_params = locals()
all_params = [
'uploadfile',
'name',
'pipelineid',
'description'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method upload_pipeline_version" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'uploadfile' is set
if self.api_client.client_side_validation and ('uploadfile' not in local_var_params or # noqa: E501
local_var_params['uploadfile'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `uploadfile` when calling `upload_pipeline_version`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'name' in local_var_params and local_var_params['name'] is not None: # noqa: E501
query_params.append(('name', local_var_params['name'])) # noqa: E501
if 'pipelineid' in local_var_params and local_var_params['pipelineid'] is not None: # noqa: E501
query_params.append(('pipelineid', local_var_params['pipelineid'])) # noqa: E501
if 'description' in local_var_params and local_var_params['description'] is not None: # noqa: E501
query_params.append(('description', local_var_params['description'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
if 'uploadfile' in local_var_params:
local_var_files['uploadfile'] = local_var_params['uploadfile'] # noqa: E501
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['multipart/form-data']) # noqa: E501
# Authentication setting
auth_settings = ['Bearer'] # noqa: E501
return self.api_client.call_api(
'/apis/v1beta1/pipelines/upload_version', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiPipelineVersion', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)