github.com/vmware/go-vmware-nsxt@v0.0.0-20230223012718-d31b8a1ca05e/api_services_api.go (about) 1 /* Copyright © 2017 VMware, Inc. All Rights Reserved. 2 SPDX-License-Identifier: BSD-2-Clause 3 4 Generated by: https://github.com/swagger-api/swagger-codegen.git */ 5 6 package nsxt 7 8 import ( 9 "context" 10 "encoding/json" 11 "fmt" 12 "github.com/vmware/go-vmware-nsxt/apiservice" 13 "net/http" 14 "net/url" 15 "strings" 16 ) 17 18 // Linger please 19 var ( 20 _ context.Context 21 ) 22 23 type ApiServicesApiService service 24 25 /* ApiServicesApiService Get information about all tasks 26 Get information about all tasks 27 * @param ctx context.Context Authentication Context 28 @param optional (nil or map[string]interface{}) with one or more of: 29 @param "cursor" (string) Opaque cursor to be used for getting next page of records (supplied by current result page) 30 @param "includedFields" (string) Comma separated list of fields that should be included to result of query 31 @param "pageSize" (int64) Maximum number of results to return in this page (server may return fewer) 32 @param "requestUri" (string) Request URI(s) to include in query result 33 @param "sortAscending" (bool) 34 @param "sortBy" (string) Field by which records are sorted 35 @param "status" (string) Status(es) to include in query result 36 @param "user" (string) Names of users to include in query result 37 @return apiservice.TaskListResult*/ 38 func (a *ApiServicesApiService) ListTasks(ctx context.Context, localVarOptionals map[string]interface{}) (apiservice.TaskListResult, *http.Response, error) { 39 var ( 40 localVarHttpMethod = strings.ToUpper("Get") 41 localVarPostBody interface{} 42 localVarFileName string 43 localVarFileBytes []byte 44 successPayload apiservice.TaskListResult 45 ) 46 47 // create path and map variables 48 localVarPath := a.client.cfg.BasePath + "/tasks" 49 50 localVarHeaderParams := make(map[string]string) 51 localVarQueryParams := url.Values{} 52 localVarFormParams := url.Values{} 53 54 if err := typeCheckParameter(localVarOptionals["cursor"], "string", "cursor"); err != nil { 55 return successPayload, nil, err 56 } 57 if err := typeCheckParameter(localVarOptionals["includedFields"], "string", "includedFields"); err != nil { 58 return successPayload, nil, err 59 } 60 if err := typeCheckParameter(localVarOptionals["pageSize"], "int64", "pageSize"); err != nil { 61 return successPayload, nil, err 62 } 63 if err := typeCheckParameter(localVarOptionals["requestUri"], "string", "requestUri"); err != nil { 64 return successPayload, nil, err 65 } 66 if err := typeCheckParameter(localVarOptionals["sortAscending"], "bool", "sortAscending"); err != nil { 67 return successPayload, nil, err 68 } 69 if err := typeCheckParameter(localVarOptionals["sortBy"], "string", "sortBy"); err != nil { 70 return successPayload, nil, err 71 } 72 if err := typeCheckParameter(localVarOptionals["status"], "string", "status"); err != nil { 73 return successPayload, nil, err 74 } 75 if err := typeCheckParameter(localVarOptionals["user"], "string", "user"); err != nil { 76 return successPayload, nil, err 77 } 78 79 if localVarTempParam, localVarOk := localVarOptionals["cursor"].(string); localVarOk { 80 localVarQueryParams.Add("cursor", parameterToString(localVarTempParam, "")) 81 } 82 if localVarTempParam, localVarOk := localVarOptionals["includedFields"].(string); localVarOk { 83 localVarQueryParams.Add("included_fields", parameterToString(localVarTempParam, "")) 84 } 85 if localVarTempParam, localVarOk := localVarOptionals["pageSize"].(int64); localVarOk { 86 localVarQueryParams.Add("page_size", parameterToString(localVarTempParam, "")) 87 } 88 if localVarTempParam, localVarOk := localVarOptionals["requestUri"].(string); localVarOk { 89 localVarQueryParams.Add("request_uri", parameterToString(localVarTempParam, "")) 90 } 91 if localVarTempParam, localVarOk := localVarOptionals["sortAscending"].(bool); localVarOk { 92 localVarQueryParams.Add("sort_ascending", parameterToString(localVarTempParam, "")) 93 } 94 if localVarTempParam, localVarOk := localVarOptionals["sortBy"].(string); localVarOk { 95 localVarQueryParams.Add("sort_by", parameterToString(localVarTempParam, "")) 96 } 97 if localVarTempParam, localVarOk := localVarOptionals["status"].(string); localVarOk { 98 localVarQueryParams.Add("status", parameterToString(localVarTempParam, "")) 99 } 100 if localVarTempParam, localVarOk := localVarOptionals["user"].(string); localVarOk { 101 localVarQueryParams.Add("user", parameterToString(localVarTempParam, "")) 102 } 103 // to determine the Content-Type header 104 localVarHttpContentTypes := []string{"application/json"} 105 106 // set Content-Type header 107 localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) 108 if localVarHttpContentType != "" { 109 localVarHeaderParams["Content-Type"] = localVarHttpContentType 110 } 111 112 // to determine the Accept header 113 localVarHttpHeaderAccepts := []string{ 114 "application/json", 115 } 116 117 // set Accept header 118 localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) 119 if localVarHttpHeaderAccept != "" { 120 localVarHeaderParams["Accept"] = localVarHttpHeaderAccept 121 } 122 r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes) 123 if err != nil { 124 return successPayload, nil, err 125 } 126 127 localVarHttpResponse, err := a.client.callAPI(r) 128 if err != nil || localVarHttpResponse == nil { 129 return successPayload, localVarHttpResponse, err 130 } 131 defer localVarHttpResponse.Body.Close() 132 if localVarHttpResponse.StatusCode >= 300 { 133 return successPayload, localVarHttpResponse, reportError(localVarHttpResponse.Status) 134 } 135 136 if err = json.NewDecoder(localVarHttpResponse.Body).Decode(&successPayload); err != nil { 137 return successPayload, localVarHttpResponse, err 138 } 139 140 return successPayload, localVarHttpResponse, err 141 } 142 143 /* ApiServicesApiService Read node authentication policy configuration 144 Returns information about the currently configured authentication policies on the node. 145 * @param ctx context.Context Authentication Context 146 @return apiservice.AuthenticationPolicyProperties*/ 147 func (a *ApiServicesApiService) ReadAuthenticationPolicyProperties(ctx context.Context) (apiservice.AuthenticationPolicyProperties, *http.Response, error) { 148 var ( 149 localVarHttpMethod = strings.ToUpper("Get") 150 localVarPostBody interface{} 151 localVarFileName string 152 localVarFileBytes []byte 153 successPayload apiservice.AuthenticationPolicyProperties 154 ) 155 156 // create path and map variables 157 localVarPath := a.client.cfg.BasePath + "/node/aaa/auth-policy" 158 159 localVarHeaderParams := make(map[string]string) 160 localVarQueryParams := url.Values{} 161 localVarFormParams := url.Values{} 162 163 // to determine the Content-Type header 164 localVarHttpContentTypes := []string{"application/json"} 165 166 // set Content-Type header 167 localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) 168 if localVarHttpContentType != "" { 169 localVarHeaderParams["Content-Type"] = localVarHttpContentType 170 } 171 172 // to determine the Accept header 173 localVarHttpHeaderAccepts := []string{ 174 "application/json", 175 } 176 177 // set Accept header 178 localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) 179 if localVarHttpHeaderAccept != "" { 180 localVarHeaderParams["Accept"] = localVarHttpHeaderAccept 181 } 182 r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes) 183 if err != nil { 184 return successPayload, nil, err 185 } 186 187 localVarHttpResponse, err := a.client.callAPI(r) 188 if err != nil || localVarHttpResponse == nil { 189 return successPayload, localVarHttpResponse, err 190 } 191 defer localVarHttpResponse.Body.Close() 192 if localVarHttpResponse.StatusCode >= 300 { 193 return successPayload, localVarHttpResponse, reportError(localVarHttpResponse.Status) 194 } 195 196 if err = json.NewDecoder(localVarHttpResponse.Body).Decode(&successPayload); err != nil { 197 return successPayload, localVarHttpResponse, err 198 } 199 200 return successPayload, localVarHttpResponse, err 201 } 202 203 /* ApiServicesApiService Get information about the specified task 204 Get information about the specified task 205 * @param ctx context.Context Authentication Context 206 @param taskId ID of task to read 207 @return apiservice.TaskProperties*/ 208 func (a *ApiServicesApiService) ReadTaskProperties(ctx context.Context, taskId string) (apiservice.TaskProperties, *http.Response, error) { 209 var ( 210 localVarHttpMethod = strings.ToUpper("Get") 211 localVarPostBody interface{} 212 localVarFileName string 213 localVarFileBytes []byte 214 successPayload apiservice.TaskProperties 215 ) 216 217 // create path and map variables 218 localVarPath := a.client.cfg.BasePath + "/tasks/{task-id}" 219 localVarPath = strings.Replace(localVarPath, "{"+"task-id"+"}", fmt.Sprintf("%v", taskId), -1) 220 221 localVarHeaderParams := make(map[string]string) 222 localVarQueryParams := url.Values{} 223 localVarFormParams := url.Values{} 224 225 // to determine the Content-Type header 226 localVarHttpContentTypes := []string{"application/json"} 227 228 // set Content-Type header 229 localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) 230 if localVarHttpContentType != "" { 231 localVarHeaderParams["Content-Type"] = localVarHttpContentType 232 } 233 234 // to determine the Accept header 235 localVarHttpHeaderAccepts := []string{ 236 "application/json", 237 } 238 239 // set Accept header 240 localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) 241 if localVarHttpHeaderAccept != "" { 242 localVarHeaderParams["Accept"] = localVarHttpHeaderAccept 243 } 244 r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes) 245 if err != nil { 246 return successPayload, nil, err 247 } 248 249 localVarHttpResponse, err := a.client.callAPI(r) 250 if err != nil || localVarHttpResponse == nil { 251 return successPayload, localVarHttpResponse, err 252 } 253 defer localVarHttpResponse.Body.Close() 254 if localVarHttpResponse.StatusCode >= 300 { 255 return successPayload, localVarHttpResponse, reportError(localVarHttpResponse.Status) 256 } 257 258 if err = json.NewDecoder(localVarHttpResponse.Body).Decode(&successPayload); err != nil { 259 return successPayload, localVarHttpResponse, err 260 } 261 262 return successPayload, localVarHttpResponse, err 263 } 264 265 /* ApiServicesApiService Get the response of a task 266 Get the response of a task 267 * @param ctx context.Context Authentication Context 268 @param taskId ID of task to read 269 @return interface{}*/ 270 func (a *ApiServicesApiService) ReadTaskResult(ctx context.Context, taskId string) (interface{}, *http.Response, error) { 271 var ( 272 localVarHttpMethod = strings.ToUpper("Get") 273 localVarPostBody interface{} 274 localVarFileName string 275 localVarFileBytes []byte 276 successPayload interface{} 277 ) 278 279 // create path and map variables 280 localVarPath := a.client.cfg.BasePath + "/tasks/{task-id}/response" 281 localVarPath = strings.Replace(localVarPath, "{"+"task-id"+"}", fmt.Sprintf("%v", taskId), -1) 282 283 localVarHeaderParams := make(map[string]string) 284 localVarQueryParams := url.Values{} 285 localVarFormParams := url.Values{} 286 287 // to determine the Content-Type header 288 localVarHttpContentTypes := []string{"application/json"} 289 290 // set Content-Type header 291 localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) 292 if localVarHttpContentType != "" { 293 localVarHeaderParams["Content-Type"] = localVarHttpContentType 294 } 295 296 // to determine the Accept header 297 localVarHttpHeaderAccepts := []string{ 298 "application/json", 299 } 300 301 // set Accept header 302 localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) 303 if localVarHttpHeaderAccept != "" { 304 localVarHeaderParams["Accept"] = localVarHttpHeaderAccept 305 } 306 r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes) 307 if err != nil { 308 return successPayload, nil, err 309 } 310 311 localVarHttpResponse, err := a.client.callAPI(r) 312 if err != nil || localVarHttpResponse == nil { 313 return successPayload, localVarHttpResponse, err 314 } 315 defer localVarHttpResponse.Body.Close() 316 if localVarHttpResponse.StatusCode >= 300 { 317 return successPayload, localVarHttpResponse, reportError(localVarHttpResponse.Status) 318 } 319 320 if err = json.NewDecoder(localVarHttpResponse.Body).Decode(&successPayload); err != nil { 321 return successPayload, localVarHttpResponse, err 322 } 323 324 return successPayload, localVarHttpResponse, err 325 } 326 327 /* ApiServicesApiService Register a Collection of API Calls at a Single End Point 328 Enables you to make multiple API requests using a single request. The batch API takes in an array of logical HTTP requests represented as JSON arrays. Each request has a method (GET, PUT, POST, or DELETE), a relative_url (the portion of the URL after https://<nsx-mgr>/api/), optional headers array (corresponding to HTTP headers) and an optional body (for POST and PUT requests). The batch API returns an array of logical HTTP responses represented as JSON arrays. Each response has a status code, an optional headers array and an optional body (which is a JSON-encoded string). 329 * @param ctx context.Context Authentication Context 330 @param batchRequest 331 @param optional (nil or map[string]interface{}) with one or more of: 332 @param "atomic" (bool) transactional atomicity for the batch of requests embedded in the batch list 333 @return apiservice.BatchResponse*/ 334 func (a *ApiServicesApiService) RegisterBatchRequest(ctx context.Context, batchRequest apiservice.BatchRequest, localVarOptionals map[string]interface{}) (apiservice.BatchResponse, *http.Response, error) { 335 var ( 336 localVarHttpMethod = strings.ToUpper("Post") 337 localVarPostBody interface{} 338 localVarFileName string 339 localVarFileBytes []byte 340 successPayload apiservice.BatchResponse 341 ) 342 343 // create path and map variables 344 localVarPath := a.client.cfg.BasePath + "/batch" 345 346 localVarHeaderParams := make(map[string]string) 347 localVarQueryParams := url.Values{} 348 localVarFormParams := url.Values{} 349 350 if err := typeCheckParameter(localVarOptionals["atomic"], "bool", "atomic"); err != nil { 351 return successPayload, nil, err 352 } 353 354 if localVarTempParam, localVarOk := localVarOptionals["atomic"].(bool); localVarOk { 355 localVarQueryParams.Add("atomic", parameterToString(localVarTempParam, "")) 356 } 357 // to determine the Content-Type header 358 localVarHttpContentTypes := []string{"application/json"} 359 360 // set Content-Type header 361 localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) 362 if localVarHttpContentType != "" { 363 localVarHeaderParams["Content-Type"] = localVarHttpContentType 364 } 365 366 // to determine the Accept header 367 localVarHttpHeaderAccepts := []string{ 368 "application/json", 369 } 370 371 // set Accept header 372 localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) 373 if localVarHttpHeaderAccept != "" { 374 localVarHeaderParams["Accept"] = localVarHttpHeaderAccept 375 } 376 // body params 377 localVarPostBody = &batchRequest 378 r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes) 379 if err != nil { 380 return successPayload, nil, err 381 } 382 383 localVarHttpResponse, err := a.client.callAPI(r) 384 if err != nil || localVarHttpResponse == nil { 385 return successPayload, localVarHttpResponse, err 386 } 387 defer localVarHttpResponse.Body.Close() 388 if localVarHttpResponse.StatusCode >= 300 { 389 return successPayload, localVarHttpResponse, reportError(localVarHttpResponse.Status) 390 } 391 392 if err = json.NewDecoder(localVarHttpResponse.Body).Decode(&successPayload); err != nil { 393 return successPayload, localVarHttpResponse, err 394 } 395 396 return successPayload, localVarHttpResponse, err 397 } 398 399 /* ApiServicesApiService Update node authentication policy configuration 400 Update the currently configured authentication policy on the node. If any of api_max_auth_failures, api_failed_auth_reset_period, or api_failed_auth_lockout_period are modified, the http service is automatically restarted. 401 * @param ctx context.Context Authentication Context 402 @param authenticationPolicyProperties 403 @return apiservice.AuthenticationPolicyProperties*/ 404 func (a *ApiServicesApiService) UpdateAuthenticationPolicyProperties(ctx context.Context, authenticationPolicyProperties apiservice.AuthenticationPolicyProperties) (apiservice.AuthenticationPolicyProperties, *http.Response, error) { 405 var ( 406 localVarHttpMethod = strings.ToUpper("Put") 407 localVarPostBody interface{} 408 localVarFileName string 409 localVarFileBytes []byte 410 successPayload apiservice.AuthenticationPolicyProperties 411 ) 412 413 // create path and map variables 414 localVarPath := a.client.cfg.BasePath + "/node/aaa/auth-policy" 415 416 localVarHeaderParams := make(map[string]string) 417 localVarQueryParams := url.Values{} 418 localVarFormParams := url.Values{} 419 420 // to determine the Content-Type header 421 localVarHttpContentTypes := []string{"application/json"} 422 423 // set Content-Type header 424 localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes) 425 if localVarHttpContentType != "" { 426 localVarHeaderParams["Content-Type"] = localVarHttpContentType 427 } 428 429 // to determine the Accept header 430 localVarHttpHeaderAccepts := []string{ 431 "application/json", 432 } 433 434 // set Accept header 435 localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts) 436 if localVarHttpHeaderAccept != "" { 437 localVarHeaderParams["Accept"] = localVarHttpHeaderAccept 438 } 439 // body params 440 localVarPostBody = &authenticationPolicyProperties 441 r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes) 442 if err != nil { 443 return successPayload, nil, err 444 } 445 446 localVarHttpResponse, err := a.client.callAPI(r) 447 if err != nil || localVarHttpResponse == nil { 448 return successPayload, localVarHttpResponse, err 449 } 450 defer localVarHttpResponse.Body.Close() 451 if localVarHttpResponse.StatusCode >= 300 { 452 return successPayload, localVarHttpResponse, reportError(localVarHttpResponse.Status) 453 } 454 455 if err = json.NewDecoder(localVarHttpResponse.Body).Decode(&successPayload); err != nil { 456 return successPayload, localVarHttpResponse, err 457 } 458 459 return successPayload, localVarHttpResponse, err 460 }