openspg/python/knext/rest/api/schema_api.py

572 lines
22 KiB
Python

# coding: utf-8
# Copyright 2023 Ant Group CO., Ltd.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
# in compliance with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under the License
# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
# or implied.
"""
knext
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
The version of the OpenAPI document: 1.0.0
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 knext.rest.api_client import ApiClient
from knext.rest.exceptions import ApiTypeError, ApiValueError # noqa: F401
class SchemaApi(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
def schema_alter_schema_post(self, **kwargs): # noqa: E501
"""alter_schema # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.schema_alter_schema_post(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param SchemaAlterRequest schema_alter_request:
: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: object
If the method is called asynchronously,
returns the request thread.
"""
kwargs["_return_http_data_only"] = True
return self.schema_alter_schema_post_with_http_info(**kwargs) # noqa: E501
def schema_alter_schema_post_with_http_info(self, **kwargs): # noqa: E501
"""alter_schema # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.schema_alter_schema_post_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param SchemaAlterRequest schema_alter_request:
:param _return_http_data_only: response data without head status code
and headers
: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: tuple(object, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ["schema_alter_request"]
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 schema_alter_schema_post" % key
)
local_var_params[key] = val
del local_var_params["kwargs"]
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if "schema_alter_request" in local_var_params:
body_params = local_var_params["schema_alter_request"]
# 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
["application/json"]
) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
"/schema/alterSchema",
"POST",
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type="object", # 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,
)
def schema_query_project_schema_get(self, project_id, **kwargs): # noqa: E501
"""query_project_schema # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.schema_query_project_schema_get(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int project_id: (required)
: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: ProjectSchema
If the method is called asynchronously,
returns the request thread.
"""
kwargs["_return_http_data_only"] = True
return self.schema_query_project_schema_get_with_http_info(
project_id, **kwargs
) # noqa: E501
def schema_query_project_schema_get_with_http_info(
self, project_id, **kwargs
): # noqa: E501
"""query_project_schema # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.schema_query_project_schema_get_with_http_info(project_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int project_id: (required)
:param _return_http_data_only: response data without head status code
and headers
: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: tuple(ProjectSchema, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ["project_id"]
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 schema_query_project_schema_get" % key
)
local_var_params[key] = val
del local_var_params["kwargs"]
# verify the required parameter 'project_id' is set
if self.api_client.client_side_validation and (
"project_id" not in local_var_params
or local_var_params["project_id"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `project_id` when calling `schema_query_project_schema_get`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if (
"project_id" in local_var_params
and local_var_params["project_id"] is not None
): # noqa: E501
query_params.append(
("projectId", local_var_params["project_id"])
) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params["Accept"] = self.api_client.select_header_accept(
["application/json"]
) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
"/schema/queryProjectSchema",
"GET",
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type="ProjectSchema", # 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,
)
def schema_query_relation_get(
self, s_name, relation, o_name, **kwargs
): # noqa: E501
"""query_relation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.schema_query_relation_get(s_name, relation, o_name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str s_name: (required)
:param str relation: (required)
:param str o_name: (required)
: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: Relation
If the method is called asynchronously,
returns the request thread.
"""
kwargs["_return_http_data_only"] = True
return self.schema_query_relation_get_with_http_info(
s_name, relation, o_name, **kwargs
) # noqa: E501
def schema_query_relation_get_with_http_info(
self, s_name, relation, o_name, **kwargs
): # noqa: E501
"""query_relation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.schema_query_relation_get_with_http_info(s_name, relation, o_name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str s_name: (required)
:param str relation: (required)
:param str o_name: (required)
:param _return_http_data_only: response data without head status code
and headers
: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: tuple(Relation, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ["s_name", "relation", "o_name"]
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 schema_query_relation_get" % key
)
local_var_params[key] = val
del local_var_params["kwargs"]
# verify the required parameter 's_name' is set
if self.api_client.client_side_validation and (
"s_name" not in local_var_params
or local_var_params["s_name"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `s_name` when calling `schema_query_relation_get`"
) # noqa: E501
# verify the required parameter 'relation' is set
if self.api_client.client_side_validation and (
"relation" not in local_var_params
or local_var_params["relation"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `relation` when calling `schema_query_relation_get`"
) # noqa: E501
# verify the required parameter 'o_name' is set
if self.api_client.client_side_validation and (
"o_name" not in local_var_params
or local_var_params["o_name"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `o_name` when calling `schema_query_relation_get`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if (
"s_name" in local_var_params and local_var_params["s_name"] is not None
): # noqa: E501
query_params.append(("sName", local_var_params["s_name"])) # noqa: E501
if (
"relation" in local_var_params and local_var_params["relation"] is not None
): # noqa: E501
query_params.append(
("relation", local_var_params["relation"])
) # noqa: E501
if (
"o_name" in local_var_params and local_var_params["o_name"] is not None
): # noqa: E501
query_params.append(("oName", local_var_params["o_name"])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params["Accept"] = self.api_client.select_header_accept(
["application/json"]
) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
"/schema/queryRelation",
"GET",
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type="Relation", # 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,
)
def schema_query_spg_type_get(self, name, **kwargs): # noqa: E501
"""query_spg_type # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.schema_query_spg_type_get(name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str name: 实体类型名称 (required)
: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: BaseSpgType
If the method is called asynchronously,
returns the request thread.
"""
kwargs["_return_http_data_only"] = True
return self.schema_query_spg_type_get_with_http_info(
name, **kwargs
) # noqa: E501
def schema_query_spg_type_get_with_http_info(self, name, **kwargs): # noqa: E501
"""query_spg_type # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.schema_query_spg_type_get_with_http_info(name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str name: 实体类型名称 (required)
:param _return_http_data_only: response data without head status code
and headers
: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: tuple(BaseSpgType, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ["name"]
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 schema_query_spg_type_get" % key
)
local_var_params[key] = val
del local_var_params["kwargs"]
# verify the required parameter 'name' is set
if self.api_client.client_side_validation and (
"name" not in local_var_params
or local_var_params["name"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `name` when calling `schema_query_spg_type_get`"
) # 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
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params["Accept"] = self.api_client.select_header_accept(
["application/json"]
) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
"/schema/querySpgType",
"GET",
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type="BaseSpgType", # 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,
)