generated from Luis/nextjs-python-web-template
790 lines
31 KiB
Python
790 lines
31 KiB
Python
# coding: utf-8
|
|
|
|
"""
|
|
FastAPI
|
|
|
|
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
|
|
The version of the OpenAPI document: 0.1.0
|
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
|
|
Do not edit the class manually.
|
|
""" # noqa: E501
|
|
|
|
|
|
import re # noqa: F401
|
|
import io
|
|
import warnings
|
|
|
|
from pydantic import validate_arguments, ValidationError
|
|
|
|
from pydantic import StrictInt, StrictStr
|
|
|
|
from typing import Any, List, Optional, Dict
|
|
|
|
from openapi_client.models.service import Service
|
|
from openapi_client.models.service_create import ServiceCreate
|
|
from openapi_client.models.services_by_name import ServicesByName
|
|
|
|
from openapi_client.api_client import ApiClient
|
|
from openapi_client.api_response import ApiResponse
|
|
from openapi_client.exceptions import ( # noqa: F401
|
|
ApiTypeError,
|
|
ApiValueError
|
|
)
|
|
|
|
|
|
class ServicesApi:
|
|
"""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) -> None:
|
|
if api_client is None:
|
|
api_client = ApiClient.get_default()
|
|
self.api_client = api_client
|
|
|
|
@validate_arguments
|
|
def create_service(self, service_create : ServiceCreate, **kwargs) -> Service: # noqa: E501
|
|
"""Create Service # 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_service(service_create, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param service_create: (required)
|
|
:type service_create: ServiceCreate
|
|
:param async_req: Whether to execute the request asynchronously.
|
|
:type async_req: 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: Service
|
|
"""
|
|
kwargs['_return_http_data_only'] = True
|
|
if '_preload_content' in kwargs:
|
|
message = "Error! Please call the create_service_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
|
raise ValueError(message)
|
|
return self.create_service_with_http_info(service_create, **kwargs) # noqa: E501
|
|
|
|
@validate_arguments
|
|
def create_service_with_http_info(self, service_create : ServiceCreate, **kwargs) -> ApiResponse: # noqa: E501
|
|
"""Create Service # 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_service_with_http_info(service_create, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param service_create: (required)
|
|
:type service_create: ServiceCreate
|
|
:param async_req: Whether to execute the request asynchronously.
|
|
:type async_req: bool, optional
|
|
:param _preload_content: if False, the ApiResponse.data will
|
|
be set to none and raw_data will store the
|
|
HTTP response body without reading/decoding.
|
|
Default is True.
|
|
:type _preload_content: bool, optional
|
|
:param _return_http_data_only: response data instead of ApiResponse
|
|
object with status code, headers, etc
|
|
:type _return_http_data_only: 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.
|
|
:param _request_auth: set to override the auth_settings for an a single
|
|
request; this effectively ignores the authentication
|
|
in the spec for a single request.
|
|
:type _request_auth: dict, optional
|
|
:type _content_type: string, optional: force content-type for the request
|
|
:return: Returns the result object.
|
|
If the method is called asynchronously,
|
|
returns the request thread.
|
|
:rtype: tuple(Service, status_code(int), headers(HTTPHeaderDict))
|
|
"""
|
|
|
|
_params = locals()
|
|
|
|
_all_params = [
|
|
'service_create'
|
|
]
|
|
_all_params.extend(
|
|
[
|
|
'async_req',
|
|
'_return_http_data_only',
|
|
'_preload_content',
|
|
'_request_timeout',
|
|
'_request_auth',
|
|
'_content_type',
|
|
'_headers'
|
|
]
|
|
)
|
|
|
|
# validate the arguments
|
|
for _key, _val in _params['kwargs'].items():
|
|
if _key not in _all_params:
|
|
raise ApiTypeError(
|
|
"Got an unexpected keyword argument '%s'"
|
|
" to method create_service" % _key
|
|
)
|
|
_params[_key] = _val
|
|
del _params['kwargs']
|
|
|
|
_collection_formats = {}
|
|
|
|
# process the path parameters
|
|
_path_params = {}
|
|
|
|
# process the query parameters
|
|
_query_params = []
|
|
# process the header parameters
|
|
_header_params = dict(_params.get('_headers', {}))
|
|
# process the form parameters
|
|
_form_params = []
|
|
_files = {}
|
|
# process the body parameter
|
|
_body_params = None
|
|
if _params['service_create'] is not None:
|
|
_body_params = _params['service_create']
|
|
|
|
# set the HTTP header `Accept`
|
|
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
['application/json']) # noqa: E501
|
|
|
|
# set the HTTP header `Content-Type`
|
|
_content_types_list = _params.get('_content_type',
|
|
self.api_client.select_header_content_type(
|
|
['application/json']))
|
|
if _content_types_list:
|
|
_header_params['Content-Type'] = _content_types_list
|
|
|
|
# authentication setting
|
|
_auth_settings = [] # noqa: E501
|
|
|
|
_response_types_map = {
|
|
'200': "Service",
|
|
'422': "HTTPValidationError",
|
|
}
|
|
|
|
return self.api_client.call_api(
|
|
'/api/v1/service', 'POST',
|
|
_path_params,
|
|
_query_params,
|
|
_header_params,
|
|
body=_body_params,
|
|
post_params=_form_params,
|
|
files=_files,
|
|
response_types_map=_response_types_map,
|
|
auth_settings=_auth_settings,
|
|
async_req=_params.get('async_req'),
|
|
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
|
_preload_content=_params.get('_preload_content', True),
|
|
_request_timeout=_params.get('_request_timeout'),
|
|
collection_formats=_collection_formats,
|
|
_request_auth=_params.get('_request_auth'))
|
|
|
|
@validate_arguments
|
|
def delete_service(self, entity_did : StrictStr, **kwargs) -> Dict[str, str]: # noqa: E501
|
|
"""Delete Service # 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_service(entity_did, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param entity_did: (required)
|
|
:type entity_did: str
|
|
:param async_req: Whether to execute the request asynchronously.
|
|
:type async_req: 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: Dict[str, str]
|
|
"""
|
|
kwargs['_return_http_data_only'] = True
|
|
if '_preload_content' in kwargs:
|
|
message = "Error! Please call the delete_service_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
|
raise ValueError(message)
|
|
return self.delete_service_with_http_info(entity_did, **kwargs) # noqa: E501
|
|
|
|
@validate_arguments
|
|
def delete_service_with_http_info(self, entity_did : StrictStr, **kwargs) -> ApiResponse: # noqa: E501
|
|
"""Delete Service # 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_service_with_http_info(entity_did, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param entity_did: (required)
|
|
:type entity_did: str
|
|
:param async_req: Whether to execute the request asynchronously.
|
|
:type async_req: bool, optional
|
|
:param _preload_content: if False, the ApiResponse.data will
|
|
be set to none and raw_data will store the
|
|
HTTP response body without reading/decoding.
|
|
Default is True.
|
|
:type _preload_content: bool, optional
|
|
:param _return_http_data_only: response data instead of ApiResponse
|
|
object with status code, headers, etc
|
|
:type _return_http_data_only: 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.
|
|
:param _request_auth: set to override the auth_settings for an a single
|
|
request; this effectively ignores the authentication
|
|
in the spec for a single request.
|
|
:type _request_auth: dict, optional
|
|
:type _content_type: string, optional: force content-type for the request
|
|
:return: Returns the result object.
|
|
If the method is called asynchronously,
|
|
returns the request thread.
|
|
:rtype: tuple(Dict[str, str], status_code(int), headers(HTTPHeaderDict))
|
|
"""
|
|
|
|
_params = locals()
|
|
|
|
_all_params = [
|
|
'entity_did'
|
|
]
|
|
_all_params.extend(
|
|
[
|
|
'async_req',
|
|
'_return_http_data_only',
|
|
'_preload_content',
|
|
'_request_timeout',
|
|
'_request_auth',
|
|
'_content_type',
|
|
'_headers'
|
|
]
|
|
)
|
|
|
|
# validate the arguments
|
|
for _key, _val in _params['kwargs'].items():
|
|
if _key not in _all_params:
|
|
raise ApiTypeError(
|
|
"Got an unexpected keyword argument '%s'"
|
|
" to method delete_service" % _key
|
|
)
|
|
_params[_key] = _val
|
|
del _params['kwargs']
|
|
|
|
_collection_formats = {}
|
|
|
|
# process the path parameters
|
|
_path_params = {}
|
|
if _params['entity_did']:
|
|
_path_params['entity_did'] = _params['entity_did']
|
|
|
|
|
|
# process the query parameters
|
|
_query_params = []
|
|
# process the header parameters
|
|
_header_params = dict(_params.get('_headers', {}))
|
|
# process the form parameters
|
|
_form_params = []
|
|
_files = {}
|
|
# process the body parameter
|
|
_body_params = None
|
|
# set the HTTP header `Accept`
|
|
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
['application/json']) # noqa: E501
|
|
|
|
# authentication setting
|
|
_auth_settings = [] # noqa: E501
|
|
|
|
_response_types_map = {
|
|
'200': "Dict[str, str]",
|
|
'422': "HTTPValidationError",
|
|
}
|
|
|
|
return self.api_client.call_api(
|
|
'/api/v1/{entity_did}/service', 'DELETE',
|
|
_path_params,
|
|
_query_params,
|
|
_header_params,
|
|
body=_body_params,
|
|
post_params=_form_params,
|
|
files=_files,
|
|
response_types_map=_response_types_map,
|
|
auth_settings=_auth_settings,
|
|
async_req=_params.get('async_req'),
|
|
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
|
_preload_content=_params.get('_preload_content', True),
|
|
_request_timeout=_params.get('_request_timeout'),
|
|
collection_formats=_collection_formats,
|
|
_request_auth=_params.get('_request_auth'))
|
|
|
|
@validate_arguments
|
|
def get_all_services(self, skip : Optional[StrictInt] = None, limit : Optional[StrictInt] = None, **kwargs) -> List[Service]: # noqa: E501
|
|
"""Get All Services # 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_all_services(skip, limit, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param skip:
|
|
:type skip: int
|
|
:param limit:
|
|
:type limit: int
|
|
:param async_req: Whether to execute the request asynchronously.
|
|
:type async_req: 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: List[Service]
|
|
"""
|
|
kwargs['_return_http_data_only'] = True
|
|
if '_preload_content' in kwargs:
|
|
message = "Error! Please call the get_all_services_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
|
raise ValueError(message)
|
|
return self.get_all_services_with_http_info(skip, limit, **kwargs) # noqa: E501
|
|
|
|
@validate_arguments
|
|
def get_all_services_with_http_info(self, skip : Optional[StrictInt] = None, limit : Optional[StrictInt] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
"""Get All Services # 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_all_services_with_http_info(skip, limit, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param skip:
|
|
:type skip: int
|
|
:param limit:
|
|
:type limit: int
|
|
:param async_req: Whether to execute the request asynchronously.
|
|
:type async_req: bool, optional
|
|
:param _preload_content: if False, the ApiResponse.data will
|
|
be set to none and raw_data will store the
|
|
HTTP response body without reading/decoding.
|
|
Default is True.
|
|
:type _preload_content: bool, optional
|
|
:param _return_http_data_only: response data instead of ApiResponse
|
|
object with status code, headers, etc
|
|
:type _return_http_data_only: 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.
|
|
:param _request_auth: set to override the auth_settings for an a single
|
|
request; this effectively ignores the authentication
|
|
in the spec for a single request.
|
|
:type _request_auth: dict, optional
|
|
:type _content_type: string, optional: force content-type for the request
|
|
:return: Returns the result object.
|
|
If the method is called asynchronously,
|
|
returns the request thread.
|
|
:rtype: tuple(List[Service], status_code(int), headers(HTTPHeaderDict))
|
|
"""
|
|
|
|
_params = locals()
|
|
|
|
_all_params = [
|
|
'skip',
|
|
'limit'
|
|
]
|
|
_all_params.extend(
|
|
[
|
|
'async_req',
|
|
'_return_http_data_only',
|
|
'_preload_content',
|
|
'_request_timeout',
|
|
'_request_auth',
|
|
'_content_type',
|
|
'_headers'
|
|
]
|
|
)
|
|
|
|
# validate the arguments
|
|
for _key, _val in _params['kwargs'].items():
|
|
if _key not in _all_params:
|
|
raise ApiTypeError(
|
|
"Got an unexpected keyword argument '%s'"
|
|
" to method get_all_services" % _key
|
|
)
|
|
_params[_key] = _val
|
|
del _params['kwargs']
|
|
|
|
_collection_formats = {}
|
|
|
|
# process the path parameters
|
|
_path_params = {}
|
|
|
|
# process the query parameters
|
|
_query_params = []
|
|
if _params.get('skip') is not None: # noqa: E501
|
|
_query_params.append(('skip', _params['skip']))
|
|
|
|
if _params.get('limit') is not None: # noqa: E501
|
|
_query_params.append(('limit', _params['limit']))
|
|
|
|
# process the header parameters
|
|
_header_params = dict(_params.get('_headers', {}))
|
|
# process the form parameters
|
|
_form_params = []
|
|
_files = {}
|
|
# process the body parameter
|
|
_body_params = None
|
|
# set the HTTP header `Accept`
|
|
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
['application/json']) # noqa: E501
|
|
|
|
# authentication setting
|
|
_auth_settings = [] # noqa: E501
|
|
|
|
_response_types_map = {
|
|
'200': "List[Service]",
|
|
'422': "HTTPValidationError",
|
|
}
|
|
|
|
return self.api_client.call_api(
|
|
'/api/v1/services', 'GET',
|
|
_path_params,
|
|
_query_params,
|
|
_header_params,
|
|
body=_body_params,
|
|
post_params=_form_params,
|
|
files=_files,
|
|
response_types_map=_response_types_map,
|
|
auth_settings=_auth_settings,
|
|
async_req=_params.get('async_req'),
|
|
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
|
_preload_content=_params.get('_preload_content', True),
|
|
_request_timeout=_params.get('_request_timeout'),
|
|
collection_formats=_collection_formats,
|
|
_request_auth=_params.get('_request_auth'))
|
|
|
|
@validate_arguments
|
|
def get_service_by_did(self, entity_did : StrictStr, skip : Optional[StrictInt] = None, limit : Optional[StrictInt] = None, **kwargs) -> List[Service]: # noqa: E501
|
|
"""Get Service By Did # 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_service_by_did(entity_did, skip, limit, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param entity_did: (required)
|
|
:type entity_did: str
|
|
:param skip:
|
|
:type skip: int
|
|
:param limit:
|
|
:type limit: int
|
|
:param async_req: Whether to execute the request asynchronously.
|
|
:type async_req: 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: List[Service]
|
|
"""
|
|
kwargs['_return_http_data_only'] = True
|
|
if '_preload_content' in kwargs:
|
|
message = "Error! Please call the get_service_by_did_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
|
raise ValueError(message)
|
|
return self.get_service_by_did_with_http_info(entity_did, skip, limit, **kwargs) # noqa: E501
|
|
|
|
@validate_arguments
|
|
def get_service_by_did_with_http_info(self, entity_did : StrictStr, skip : Optional[StrictInt] = None, limit : Optional[StrictInt] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
"""Get Service By Did # 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_service_by_did_with_http_info(entity_did, skip, limit, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param entity_did: (required)
|
|
:type entity_did: str
|
|
:param skip:
|
|
:type skip: int
|
|
:param limit:
|
|
:type limit: int
|
|
:param async_req: Whether to execute the request asynchronously.
|
|
:type async_req: bool, optional
|
|
:param _preload_content: if False, the ApiResponse.data will
|
|
be set to none and raw_data will store the
|
|
HTTP response body without reading/decoding.
|
|
Default is True.
|
|
:type _preload_content: bool, optional
|
|
:param _return_http_data_only: response data instead of ApiResponse
|
|
object with status code, headers, etc
|
|
:type _return_http_data_only: 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.
|
|
:param _request_auth: set to override the auth_settings for an a single
|
|
request; this effectively ignores the authentication
|
|
in the spec for a single request.
|
|
:type _request_auth: dict, optional
|
|
:type _content_type: string, optional: force content-type for the request
|
|
:return: Returns the result object.
|
|
If the method is called asynchronously,
|
|
returns the request thread.
|
|
:rtype: tuple(List[Service], status_code(int), headers(HTTPHeaderDict))
|
|
"""
|
|
|
|
_params = locals()
|
|
|
|
_all_params = [
|
|
'entity_did',
|
|
'skip',
|
|
'limit'
|
|
]
|
|
_all_params.extend(
|
|
[
|
|
'async_req',
|
|
'_return_http_data_only',
|
|
'_preload_content',
|
|
'_request_timeout',
|
|
'_request_auth',
|
|
'_content_type',
|
|
'_headers'
|
|
]
|
|
)
|
|
|
|
# validate the arguments
|
|
for _key, _val in _params['kwargs'].items():
|
|
if _key not in _all_params:
|
|
raise ApiTypeError(
|
|
"Got an unexpected keyword argument '%s'"
|
|
" to method get_service_by_did" % _key
|
|
)
|
|
_params[_key] = _val
|
|
del _params['kwargs']
|
|
|
|
_collection_formats = {}
|
|
|
|
# process the path parameters
|
|
_path_params = {}
|
|
if _params['entity_did']:
|
|
_path_params['entity_did'] = _params['entity_did']
|
|
|
|
|
|
# process the query parameters
|
|
_query_params = []
|
|
if _params.get('skip') is not None: # noqa: E501
|
|
_query_params.append(('skip', _params['skip']))
|
|
|
|
if _params.get('limit') is not None: # noqa: E501
|
|
_query_params.append(('limit', _params['limit']))
|
|
|
|
# process the header parameters
|
|
_header_params = dict(_params.get('_headers', {}))
|
|
# process the form parameters
|
|
_form_params = []
|
|
_files = {}
|
|
# process the body parameter
|
|
_body_params = None
|
|
# set the HTTP header `Accept`
|
|
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
['application/json']) # noqa: E501
|
|
|
|
# authentication setting
|
|
_auth_settings = [] # noqa: E501
|
|
|
|
_response_types_map = {
|
|
'200': "List[Service]",
|
|
'422': "HTTPValidationError",
|
|
}
|
|
|
|
return self.api_client.call_api(
|
|
'/api/v1/{entity_did}/service', 'GET',
|
|
_path_params,
|
|
_query_params,
|
|
_header_params,
|
|
body=_body_params,
|
|
post_params=_form_params,
|
|
files=_files,
|
|
response_types_map=_response_types_map,
|
|
auth_settings=_auth_settings,
|
|
async_req=_params.get('async_req'),
|
|
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
|
_preload_content=_params.get('_preload_content', True),
|
|
_request_timeout=_params.get('_request_timeout'),
|
|
collection_formats=_collection_formats,
|
|
_request_auth=_params.get('_request_auth'))
|
|
|
|
@validate_arguments
|
|
def get_services_by_name(self, entity_name : StrictStr, skip : Optional[StrictInt] = None, limit : Optional[StrictInt] = None, **kwargs) -> ServicesByName: # noqa: E501
|
|
"""Get Services By Name # 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_services_by_name(entity_name, skip, limit, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param entity_name: (required)
|
|
:type entity_name: str
|
|
:param skip:
|
|
:type skip: int
|
|
:param limit:
|
|
:type limit: int
|
|
:param async_req: Whether to execute the request asynchronously.
|
|
:type async_req: 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: ServicesByName
|
|
"""
|
|
kwargs['_return_http_data_only'] = True
|
|
if '_preload_content' in kwargs:
|
|
message = "Error! Please call the get_services_by_name_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
|
raise ValueError(message)
|
|
return self.get_services_by_name_with_http_info(entity_name, skip, limit, **kwargs) # noqa: E501
|
|
|
|
@validate_arguments
|
|
def get_services_by_name_with_http_info(self, entity_name : StrictStr, skip : Optional[StrictInt] = None, limit : Optional[StrictInt] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
"""Get Services By Name # 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_services_by_name_with_http_info(entity_name, skip, limit, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param entity_name: (required)
|
|
:type entity_name: str
|
|
:param skip:
|
|
:type skip: int
|
|
:param limit:
|
|
:type limit: int
|
|
:param async_req: Whether to execute the request asynchronously.
|
|
:type async_req: bool, optional
|
|
:param _preload_content: if False, the ApiResponse.data will
|
|
be set to none and raw_data will store the
|
|
HTTP response body without reading/decoding.
|
|
Default is True.
|
|
:type _preload_content: bool, optional
|
|
:param _return_http_data_only: response data instead of ApiResponse
|
|
object with status code, headers, etc
|
|
:type _return_http_data_only: 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.
|
|
:param _request_auth: set to override the auth_settings for an a single
|
|
request; this effectively ignores the authentication
|
|
in the spec for a single request.
|
|
:type _request_auth: dict, optional
|
|
:type _content_type: string, optional: force content-type for the request
|
|
:return: Returns the result object.
|
|
If the method is called asynchronously,
|
|
returns the request thread.
|
|
:rtype: tuple(ServicesByName, status_code(int), headers(HTTPHeaderDict))
|
|
"""
|
|
|
|
_params = locals()
|
|
|
|
_all_params = [
|
|
'entity_name',
|
|
'skip',
|
|
'limit'
|
|
]
|
|
_all_params.extend(
|
|
[
|
|
'async_req',
|
|
'_return_http_data_only',
|
|
'_preload_content',
|
|
'_request_timeout',
|
|
'_request_auth',
|
|
'_content_type',
|
|
'_headers'
|
|
]
|
|
)
|
|
|
|
# validate the arguments
|
|
for _key, _val in _params['kwargs'].items():
|
|
if _key not in _all_params:
|
|
raise ApiTypeError(
|
|
"Got an unexpected keyword argument '%s'"
|
|
" to method get_services_by_name" % _key
|
|
)
|
|
_params[_key] = _val
|
|
del _params['kwargs']
|
|
|
|
_collection_formats = {}
|
|
|
|
# process the path parameters
|
|
_path_params = {}
|
|
|
|
# process the query parameters
|
|
_query_params = []
|
|
if _params.get('entity_name') is not None: # noqa: E501
|
|
_query_params.append(('entity_name', _params['entity_name']))
|
|
|
|
if _params.get('skip') is not None: # noqa: E501
|
|
_query_params.append(('skip', _params['skip']))
|
|
|
|
if _params.get('limit') is not None: # noqa: E501
|
|
_query_params.append(('limit', _params['limit']))
|
|
|
|
# process the header parameters
|
|
_header_params = dict(_params.get('_headers', {}))
|
|
# process the form parameters
|
|
_form_params = []
|
|
_files = {}
|
|
# process the body parameter
|
|
_body_params = None
|
|
# set the HTTP header `Accept`
|
|
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
['application/json']) # noqa: E501
|
|
|
|
# authentication setting
|
|
_auth_settings = [] # noqa: E501
|
|
|
|
_response_types_map = {
|
|
'200': "ServicesByName",
|
|
'422': "HTTPValidationError",
|
|
}
|
|
|
|
return self.api_client.call_api(
|
|
'/api/v1/services_by_entity_name', 'GET',
|
|
_path_params,
|
|
_query_params,
|
|
_header_params,
|
|
body=_body_params,
|
|
post_params=_form_params,
|
|
files=_files,
|
|
response_types_map=_response_types_map,
|
|
auth_settings=_auth_settings,
|
|
async_req=_params.get('async_req'),
|
|
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
|
_preload_content=_params.get('_preload_content', True),
|
|
_request_timeout=_params.get('_request_timeout'),
|
|
collection_formats=_collection_formats,
|
|
_request_auth=_params.get('_request_auth'))
|