55
66 Provides access to BMC Control-M Services # noqa: E501
77
8- OpenAPI spec version: 9.20.215
8+ The version of the OpenAPI document : 9.22.30
99 Contact: customer_support@bmc.com
10- Generated by: https://github.com/swagger-api/swagger-codegen.git
10+ Generated by: https://openapi-generator.tech
1111"""
1212
1313
1919import six
2020
2121from clients .ctm_api_client .api_client import ApiClient
22+ from clients .ctm_api_client .exceptions import ( # noqa: F401
23+ ApiTypeError ,
24+ ApiValueError
25+ )
2226
2327
2428class BuildApi (object ):
25- """NOTE: This class is auto generated by the swagger code generator program.
29+ """NOTE: This class is auto generated by OpenAPI Generator
30+ Ref: https://openapi-generator.tech
2631
2732 Do not edit the class manually.
28- Ref: https://github.com/swagger-api/swagger-codegen
2933 """
3034
3135 def __init__ (self , api_client = None ):
@@ -39,116 +43,149 @@ def build_file(self, definitions_file, **kwargs): # noqa: E501
3943 Compile the provided definition file (JSON or zip) to verify it is valid for Control-M. # noqa: E501
4044 This method makes a synchronous HTTP request by default. To make an
4145 asynchronous HTTP request, please pass async_req=True
46+
4247 >>> thread = api.build_file(definitions_file, async_req=True)
4348 >>> result = thread.get()
4449
45- :param async_req bool
46- :param file definitions_file: A file that contains definitions to be compiled. Can be either a JSON definition file, or a zip file that contains multiple JSON definition files. (required)
47- :param file deploy_descriptor_file: Deploy Descriptor JSON file.
48- :return: list[DeploymentFileResults]
50+ :param definitions_file: A file that contains definitions to be compiled. Can be either a JSON definition file, or a zip file that contains multiple JSON definition files. (required)
51+ :type definitions_file: file
52+ :param deploy_descriptor_file: Deploy Descriptor JSON file.
53+ :type deploy_descriptor_file: file
54+ :param async_req: Whether to execute the request asynchronously.
55+ :type async_req: bool, optional
56+ :param _preload_content: if False, the urllib3.HTTPResponse object will
57+ be returned without reading/decoding response
58+ data. Default is True.
59+ :type _preload_content: bool, optional
60+ :param _request_timeout: timeout setting for this request. If one
61+ number provided, it will be total request
62+ timeout. It can also be a pair (tuple) of
63+ (connection, read) timeouts.
64+ :return: Returns the result object.
4965 If the method is called asynchronously,
5066 returns the request thread.
67+ :rtype: list[DeploymentFileResults]
5168 """
52- kwargs ["_return_http_data_only" ] = True
53- if kwargs .get ("async_req" ):
54- return self .build_file_with_http_info (
55- definitions_file , ** kwargs
56- ) # noqa: E501
57- else :
58- (data ) = self .build_file_with_http_info (
59- definitions_file , ** kwargs
60- ) # noqa: E501
61- return data
69+ kwargs ['_return_http_data_only' ] = True
70+ return self .build_file_with_http_info (definitions_file , ** kwargs ) # noqa: E501
6271
6372 def build_file_with_http_info (self , definitions_file , ** kwargs ): # noqa: E501
6473 """Compile definitions file to check its validity # noqa: E501
6574
6675 Compile the provided definition file (JSON or zip) to verify it is valid for Control-M. # noqa: E501
6776 This method makes a synchronous HTTP request by default. To make an
6877 asynchronous HTTP request, please pass async_req=True
78+
6979 >>> thread = api.build_file_with_http_info(definitions_file, async_req=True)
7080 >>> result = thread.get()
7181
72- :param async_req bool
73- :param file definitions_file: A file that contains definitions to be compiled. Can be either a JSON definition file, or a zip file that contains multiple JSON definition files. (required)
74- :param file deploy_descriptor_file: Deploy Descriptor JSON file.
75- :return: list[DeploymentFileResults]
82+ :param definitions_file: A file that contains definitions to be compiled. Can be either a JSON definition file, or a zip file that contains multiple JSON definition files. (required)
83+ :type definitions_file: file
84+ :param deploy_descriptor_file: Deploy Descriptor JSON file.
85+ :type deploy_descriptor_file: file
86+ :param async_req: Whether to execute the request asynchronously.
87+ :type async_req: bool, optional
88+ :param _return_http_data_only: response data without head status code
89+ and headers
90+ :type _return_http_data_only: bool, optional
91+ :param _preload_content: if False, the urllib3.HTTPResponse object will
92+ be returned without reading/decoding response
93+ data. Default is True.
94+ :type _preload_content: bool, optional
95+ :param _request_timeout: timeout setting for this request. If one
96+ number provided, it will be total request
97+ timeout. It can also be a pair (tuple) of
98+ (connection, read) timeouts.
99+ :param _request_auth: set to override the auth_settings for an a single
100+ request; this effectively ignores the authentication
101+ in the spec for a single request.
102+ :type _request_auth: dict, optional
103+ :type _content_type: string, optional: force content-type for the request
104+ :return: Returns the result object.
76105 If the method is called asynchronously,
77106 returns the request thread.
107+ :rtype: tuple(list[DeploymentFileResults], status_code(int), headers(HTTPHeaderDict))
78108 """
79109
80- all_params = ["definitions_file" , "deploy_descriptor_file" ] # noqa: E501
81- all_params .append ("async_req" )
82- all_params .append ("_return_http_data_only" )
83- all_params .append ("_preload_content" )
84- all_params .append ("_request_timeout" )
110+ local_var_params = locals ()
111+
112+ all_params = [
113+ 'definitions_file' ,
114+ 'deploy_descriptor_file'
115+ ]
116+ all_params .extend (
117+ [
118+ 'async_req' ,
119+ '_return_http_data_only' ,
120+ '_preload_content' ,
121+ '_request_timeout' ,
122+ '_request_auth' ,
123+ '_content_type' ,
124+ '_headers'
125+ ]
126+ )
85127
86- params = locals ()
87- for key , val in six .iteritems (params ["kwargs" ]):
128+ for key , val in six .iteritems (local_var_params ['kwargs' ]):
88129 if key not in all_params :
89- raise TypeError (
130+ raise ApiTypeError (
90131 "Got an unexpected keyword argument '%s'"
91132 " to method build_file" % key
92133 )
93- params [key ] = val
94- del params [ " kwargs" ]
134+ local_var_params [key ] = val
135+ del local_var_params [ ' kwargs' ]
95136 # verify the required parameter 'definitions_file' is set
96- if self .api_client .client_side_validation and (
97- "definitions_file" not in params or params ["definitions_file" ] is None
98- ): # noqa: E501
99- raise ValueError (
100- "Missing the required parameter `definitions_file` when calling `build_file`"
101- ) # noqa: E501
137+ if self .api_client .client_side_validation and ('definitions_file' not in local_var_params or # noqa: E501
138+ local_var_params ['definitions_file' ] is None ): # noqa: E501
139+ raise ApiValueError ("Missing the required parameter `definitions_file` when calling `build_file`" ) # noqa: E501
102140
103141 collection_formats = {}
104142
105143 path_params = {}
106144
107145 query_params = []
108146
109- header_params = {}
147+ header_params = dict ( local_var_params . get ( '_headers' , {}))
110148
111149 form_params = []
112150 local_var_files = {}
113- if "definitions_file" in params :
114- local_var_files ["definitionsFile" ] = params [
115- "definitions_file"
116- ] # noqa: E501
117- if "deploy_descriptor_file" in params :
118- local_var_files ["deployDescriptorFile" ] = params [
119- "deploy_descriptor_file"
120- ] # noqa: E501
151+ if 'definitions_file' in local_var_params :
152+ local_var_files ['definitionsFile' ] = local_var_params ['definitions_file' ] # noqa: E501
153+ if 'deploy_descriptor_file' in local_var_params :
154+ local_var_files ['deployDescriptorFile' ] = local_var_params ['deploy_descriptor_file' ] # noqa: E501
121155
122156 body_params = None
123157 # HTTP header `Accept`
124- header_params ["Accept" ] = self .api_client .select_header_accept (
125- ["application/json" ]
126- ) # noqa: E501
158+ header_params ['Accept' ] = self .api_client .select_header_accept (
159+ ['application/json' ]) # noqa: E501
127160
128161 # HTTP header `Content-Type`
129- header_params [
130- "Content-Type"
131- ] = self .api_client .select_header_content_type ( # noqa: E501
132- ["multipart/form-data" ]
133- ) # noqa: E501
162+ header_params ['Content-Type' ] = local_var_params .get ('_content_type' ,
163+ self .api_client .select_header_content_type (
164+ ['multipart/form-data' ],
165+ 'POST' , body_params )) # noqa: E501
134166
135167 # Authentication setting
136- auth_settings = ["Bearer" ] # noqa: E501
168+ auth_settings = ['ApiKeyAuth' , 'Bearer' ] # noqa: E501
169+
170+ response_types_map = {
171+ 200 : "list[DeploymentFileResults]" ,
172+ 400 : "ErrorList" ,
173+ 500 : "ErrorList" ,
174+ }
137175
138176 return self .api_client .call_api (
139- "/build" ,
140- "POST" ,
177+ '/build' , 'POST' ,
141178 path_params ,
142179 query_params ,
143180 header_params ,
144181 body = body_params ,
145182 post_params = form_params ,
146183 files = local_var_files ,
147- response_type = "list[DeploymentFileResults]" , # noqa: E501
184+ response_types_map = response_types_map ,
148185 auth_settings = auth_settings ,
149- async_req = params .get (" async_req" ),
150- _return_http_data_only = params .get (" _return_http_data_only" ),
151- _preload_content = params .get (" _preload_content" , True ),
152- _request_timeout = params .get (" _request_timeout" ),
186+ async_req = local_var_params .get (' async_req' ),
187+ _return_http_data_only = local_var_params .get (' _return_http_data_only' ), # noqa: E501
188+ _preload_content = local_var_params .get (' _preload_content' , True ),
189+ _request_timeout = local_var_params .get (' _request_timeout' ),
153190 collection_formats = collection_formats ,
154- )
191+ _request_auth = local_var_params . get ( '_request_auth' ) )
0 commit comments