vsphere-automation-cis 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +3 -0
- data/Gemfile.lock +81 -0
- data/README.md +173 -0
- data/Rakefile +10 -0
- data/docs/CisSessionCreateResult.md +8 -0
- data/docs/CisSessionInfo.md +10 -0
- data/docs/CisSessionResult.md +8 -0
- data/docs/CisTaggingCategoryAddToUsedBy.md +8 -0
- data/docs/CisTaggingCategoryCreate.md +8 -0
- data/docs/CisTaggingCategoryCreateResult.md +8 -0
- data/docs/CisTaggingCategoryCreateSpec.md +12 -0
- data/docs/CisTaggingCategoryListResult.md +8 -0
- data/docs/CisTaggingCategoryListUsedCategories.md +8 -0
- data/docs/CisTaggingCategoryListUsedCategoriesResult.md +8 -0
- data/docs/CisTaggingCategoryModel.md +13 -0
- data/docs/CisTaggingCategoryModelCardinality.md +7 -0
- data/docs/CisTaggingCategoryRemoveFromUsedBy.md +8 -0
- data/docs/CisTaggingCategoryResult.md +8 -0
- data/docs/CisTaggingCategoryUpdate.md +8 -0
- data/docs/CisTaggingCategoryUpdateSpec.md +11 -0
- data/docs/CisTaggingTagAddToUsedBy.md +8 -0
- data/docs/CisTaggingTagAssociationAttach.md +8 -0
- data/docs/CisTaggingTagAssociationAttachMultipleTagsToObject.md +9 -0
- data/docs/CisTaggingTagAssociationAttachMultipleTagsToObjectResult.md +8 -0
- data/docs/CisTaggingTagAssociationAttachTagToMultipleObjects.md +8 -0
- data/docs/CisTaggingTagAssociationAttachTagToMultipleObjectsResult.md +8 -0
- data/docs/CisTaggingTagAssociationBatchResult.md +9 -0
- data/docs/CisTaggingTagAssociationDetach.md +8 -0
- data/docs/CisTaggingTagAssociationDetachMultipleTagsFromObject.md +9 -0
- data/docs/CisTaggingTagAssociationDetachMultipleTagsFromObjectResult.md +8 -0
- data/docs/CisTaggingTagAssociationDetachTagFromMultipleObjects.md +8 -0
- data/docs/CisTaggingTagAssociationDetachTagFromMultipleObjectsResult.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachableTags.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachableTagsResult.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedObjectsOnTags.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedObjectsOnTagsResult.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedObjectsResult.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedTags.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedTagsOnObjects.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedTagsOnObjectsResult.md +8 -0
- data/docs/CisTaggingTagAssociationListAttachedTagsResult.md +8 -0
- data/docs/CisTaggingTagAssociationObjectToTags.md +9 -0
- data/docs/CisTaggingTagAssociationTagToObjects.md +9 -0
- data/docs/CisTaggingTagCreate.md +8 -0
- data/docs/CisTaggingTagCreateResult.md +8 -0
- data/docs/CisTaggingTagCreateSpec.md +11 -0
- data/docs/CisTaggingTagListResult.md +8 -0
- data/docs/CisTaggingTagListTagsForCategoryResult.md +8 -0
- data/docs/CisTaggingTagListUsedTags.md +8 -0
- data/docs/CisTaggingTagListUsedTagsResult.md +8 -0
- data/docs/CisTaggingTagModel.md +12 -0
- data/docs/CisTaggingTagRemoveFromUsedBy.md +8 -0
- data/docs/CisTaggingTagResult.md +8 -0
- data/docs/CisTaggingTagUpdate.md +8 -0
- data/docs/CisTaggingTagUpdateSpec.md +9 -0
- data/docs/CisTaskInfo.md +19 -0
- data/docs/CisTaskProgress.md +10 -0
- data/docs/CisTaskStatus.md +7 -0
- data/docs/CisTasksFilterSpec.md +12 -0
- data/docs/CisTasksGetSpec.md +9 -0
- data/docs/CisTasksListResult.md +8 -0
- data/docs/CisTasksListResultValue.md +9 -0
- data/docs/CisTasksResult.md +8 -0
- data/docs/FilterSpecTargets.md +9 -0
- data/docs/SessionApi.md +131 -0
- data/docs/TaggingCategoryApi.md +401 -0
- data/docs/TaggingTagApi.md +445 -0
- data/docs/TaggingTagAssociationApi.md +498 -0
- data/docs/TasksApi.md +159 -0
- data/docs/VapiStdDynamicID.md +9 -0
- data/docs/VapiStdErrorsAlreadyExists.md +9 -0
- data/docs/VapiStdErrorsAlreadyExistsError.md +9 -0
- data/docs/VapiStdErrorsError.md +9 -0
- data/docs/VapiStdErrorsErrorError.md +9 -0
- data/docs/VapiStdErrorsInvalidArgument.md +9 -0
- data/docs/VapiStdErrorsInvalidArgumentError.md +9 -0
- data/docs/VapiStdErrorsNotAllowedInCurrentState.md +9 -0
- data/docs/VapiStdErrorsNotAllowedInCurrentStateError.md +9 -0
- data/docs/VapiStdErrorsNotFound.md +9 -0
- data/docs/VapiStdErrorsNotFoundError.md +9 -0
- data/docs/VapiStdErrorsResourceInaccessible.md +9 -0
- data/docs/VapiStdErrorsResourceInaccessibleError.md +9 -0
- data/docs/VapiStdErrorsServiceUnavailable.md +9 -0
- data/docs/VapiStdErrorsServiceUnavailableError.md +9 -0
- data/docs/VapiStdErrorsUnauthenticated.md +9 -0
- data/docs/VapiStdErrorsUnauthenticatedError.md +9 -0
- data/docs/VapiStdErrorsUnauthorized.md +9 -0
- data/docs/VapiStdErrorsUnauthorizedError.md +9 -0
- data/docs/VapiStdErrorsUnsupported.md +9 -0
- data/docs/VapiStdErrorsUnsupportedError.md +9 -0
- data/docs/VapiStdLocalizableMessage.md +10 -0
- data/git_push.sh +55 -0
- data/lib/vsphere-automation-cis.rb +124 -0
- data/lib/vsphere-automation-cis/api/session_api.rb +172 -0
- data/lib/vsphere-automation-cis/api/tagging_category_api.rb +511 -0
- data/lib/vsphere-automation-cis/api/tagging_tag_api.rb +567 -0
- data/lib/vsphere-automation-cis/api/tagging_tag_association_api.rb +654 -0
- data/lib/vsphere-automation-cis/api/tasks_api.rb +212 -0
- data/lib/vsphere-automation-cis/api_client.rb +386 -0
- data/lib/vsphere-automation-cis/api_error.rb +36 -0
- data/lib/vsphere-automation-cis/configuration.rb +200 -0
- data/lib/vsphere-automation-cis/models/cis_session_create_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_session_info.rb +219 -0
- data/lib/vsphere-automation-cis/models/cis_session_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_add_to_used_by.rb +189 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_create.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_create_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_create_spec.rb +245 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_list_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_list_used_categories.rb +189 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_list_used_categories_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_model.rb +267 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_model_cardinality.rb +30 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_remove_from_used_by.rb +189 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_update.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_category_update_spec.rb +215 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_add_to_used_by.rb +189 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach_multiple_tags_to_object.rb +205 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach_multiple_tags_to_object_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach_tag_to_multiple_objects.rb +191 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_attach_tag_to_multiple_objects_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_batch_result.rb +206 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach_multiple_tags_from_object.rb +205 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach_multiple_tags_from_object_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach_tag_from_multiple_objects.rb +191 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_detach_tag_from_multiple_objects_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attachable_tags.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attachable_tags_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_objects_on_tags.rb +191 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_objects_on_tags_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_objects_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_tags.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_tags_on_objects.rb +191 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_tags_on_objects_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_list_attached_tags_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_object_to_tags.rb +205 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_association_tag_to_objects.rb +206 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_create.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_create_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_create_spec.rb +229 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_list_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_list_tags_for_category_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_list_used_tags.rb +189 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_list_used_tags_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_model.rb +251 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_remove_from_used_by.rb +189 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_update.rb +188 -0
- data/lib/vsphere-automation-cis/models/cis_tagging_tag_update_spec.rb +194 -0
- data/lib/vsphere-automation-cis/models/cis_task_info.rb +315 -0
- data/lib/vsphere-automation-cis/models/cis_task_progress.rb +218 -0
- data/lib/vsphere-automation-cis/models/cis_task_status.rb +33 -0
- data/lib/vsphere-automation-cis/models/cis_tasks_filter_spec.rb +234 -0
- data/lib/vsphere-automation-cis/models/cis_tasks_get_spec.rb +194 -0
- data/lib/vsphere-automation-cis/models/cis_tasks_list_result.rb +190 -0
- data/lib/vsphere-automation-cis/models/cis_tasks_list_result_value.rb +192 -0
- data/lib/vsphere-automation-cis/models/cis_tasks_result.rb +188 -0
- data/lib/vsphere-automation-cis/models/filter_spec_targets.rb +204 -0
- data/lib/vsphere-automation-cis/models/vapi_std_dynamic_id.rb +204 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_already_exists.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_already_exists_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_error.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_error_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_invalid_argument.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_invalid_argument_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_not_allowed_in_current_state.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_not_allowed_in_current_state_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_not_found.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_not_found_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_resource_inaccessible.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_resource_inaccessible_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_service_unavailable.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_service_unavailable_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unauthenticated.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unauthenticated_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unauthorized.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unauthorized_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unsupported.rb +201 -0
- data/lib/vsphere-automation-cis/models/vapi_std_errors_unsupported_error.rb +192 -0
- data/lib/vsphere-automation-cis/models/vapi_std_localizable_message.rb +221 -0
- data/lib/vsphere-automation-cis/version.rb +15 -0
- data/spec/api/session_api_spec.rb +64 -0
- data/spec/api/tagging_category_api_spec.rb +134 -0
- data/spec/api/tagging_tag_api_spec.rb +145 -0
- data/spec/api/tagging_tag_association_api_spec.rb +158 -0
- data/spec/api/tasks_api_spec.rb +74 -0
- data/spec/api_client_spec.rb +224 -0
- data/spec/configuration_spec.rb +40 -0
- data/spec/models/cis_session_create_result_spec.rb +39 -0
- data/spec/models/cis_session_info_spec.rb +51 -0
- data/spec/models/cis_session_result_spec.rb +39 -0
- data/spec/models/cis_tagging_category_add_to_used_by_spec.rb +39 -0
- data/spec/models/cis_tagging_category_create_result_spec.rb +39 -0
- data/spec/models/cis_tagging_category_create_spec.rb +39 -0
- data/spec/models/cis_tagging_category_create_spec_spec.rb +63 -0
- data/spec/models/cis_tagging_category_list_result_spec.rb +39 -0
- data/spec/models/cis_tagging_category_list_used_categories_result_spec.rb +39 -0
- data/spec/models/cis_tagging_category_list_used_categories_spec.rb +39 -0
- data/spec/models/cis_tagging_category_model_cardinality_spec.rb +33 -0
- data/spec/models/cis_tagging_category_model_spec.rb +69 -0
- data/spec/models/cis_tagging_category_remove_from_used_by_spec.rb +39 -0
- data/spec/models/cis_tagging_category_result_spec.rb +39 -0
- data/spec/models/cis_tagging_category_update_spec.rb +39 -0
- data/spec/models/cis_tagging_category_update_spec_spec.rb +57 -0
- data/spec/models/cis_tagging_tag_add_to_used_by_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_attach_multiple_tags_to_object_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_attach_multiple_tags_to_object_spec.rb +45 -0
- data/spec/models/cis_tagging_tag_association_attach_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_attach_tag_to_multiple_objects_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_attach_tag_to_multiple_objects_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_batch_result_spec.rb +45 -0
- data/spec/models/cis_tagging_tag_association_detach_multiple_tags_from_object_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_detach_multiple_tags_from_object_spec.rb +45 -0
- data/spec/models/cis_tagging_tag_association_detach_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_detach_tag_from_multiple_objects_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_detach_tag_from_multiple_objects_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attachable_tags_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attachable_tags_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_objects_on_tags_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_objects_on_tags_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_objects_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_tags_on_objects_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_tags_on_objects_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_tags_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_list_attached_tags_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_association_object_to_tags_spec.rb +45 -0
- data/spec/models/cis_tagging_tag_association_tag_to_objects_spec.rb +45 -0
- data/spec/models/cis_tagging_tag_create_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_create_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_create_spec_spec.rb +57 -0
- data/spec/models/cis_tagging_tag_list_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_list_tags_for_category_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_list_used_tags_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_list_used_tags_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_model_spec.rb +63 -0
- data/spec/models/cis_tagging_tag_remove_from_used_by_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_result_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_update_spec.rb +39 -0
- data/spec/models/cis_tagging_tag_update_spec_spec.rb +45 -0
- data/spec/models/cis_task_info_spec.rb +105 -0
- data/spec/models/cis_task_progress_spec.rb +51 -0
- data/spec/models/cis_task_status_spec.rb +33 -0
- data/spec/models/cis_tasks_filter_spec_spec.rb +63 -0
- data/spec/models/cis_tasks_get_spec_spec.rb +45 -0
- data/spec/models/cis_tasks_list_result_spec.rb +39 -0
- data/spec/models/cis_tasks_list_result_value_spec.rb +45 -0
- data/spec/models/cis_tasks_result_spec.rb +39 -0
- data/spec/models/filter_spec_targets_spec.rb +45 -0
- data/spec/models/vapi_std_dynamic_id_spec.rb +45 -0
- data/spec/models/vapi_std_errors_already_exists_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_already_exists_spec.rb +45 -0
- data/spec/models/vapi_std_errors_error_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_invalid_argument_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_invalid_argument_spec.rb +45 -0
- data/spec/models/vapi_std_errors_not_allowed_in_current_state_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_not_allowed_in_current_state_spec.rb +45 -0
- data/spec/models/vapi_std_errors_not_found_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_not_found_spec.rb +45 -0
- data/spec/models/vapi_std_errors_resource_inaccessible_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_resource_inaccessible_spec.rb +45 -0
- data/spec/models/vapi_std_errors_service_unavailable_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_service_unavailable_spec.rb +45 -0
- data/spec/models/vapi_std_errors_unauthenticated_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_unauthenticated_spec.rb +45 -0
- data/spec/models/vapi_std_errors_unauthorized_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_unauthorized_spec.rb +45 -0
- data/spec/models/vapi_std_errors_unsupported_error_spec.rb +45 -0
- data/spec/models/vapi_std_errors_unsupported_spec.rb +45 -0
- data/spec/models/vapi_std_localizable_message_spec.rb +51 -0
- data/spec/spec_helper.rb +109 -0
- data/vsphere-automation-cis.gemspec +43 -0
- metadata +535 -0
@@ -0,0 +1,212 @@
|
|
1
|
+
=begin
|
2
|
+
# DO NOT MODIFY. THIS CODE IS GENERATED. CHANGES WILL BE OVERWRITTEN.
|
3
|
+
|
4
|
+
# cis
|
5
|
+
|
6
|
+
# No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
7
|
+
|
8
|
+
|
9
|
+
=end
|
10
|
+
|
11
|
+
require 'uri'
|
12
|
+
|
13
|
+
module VSphereAutomation
|
14
|
+
module CIS
|
15
|
+
class TasksApi
|
16
|
+
attr_accessor :api_client
|
17
|
+
|
18
|
+
def initialize(api_client = ApiClient.default)
|
19
|
+
@api_client = api_client
|
20
|
+
end
|
21
|
+
# Cancel a running operation associated with the task. This is the best effort attempt. Operation may not be cancelled anymore once it reaches certain stage.
|
22
|
+
# @param task Task identifier. The parameter must be an identifier for the resource type: cis.task.
|
23
|
+
# @param [Hash] opts the optional parameters
|
24
|
+
# @return [|VapiStdErrorsUnsupportedError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil]
|
25
|
+
def cancel(task, opts = {})
|
26
|
+
cancel_with_http_info(task, opts)
|
27
|
+
nil
|
28
|
+
end
|
29
|
+
|
30
|
+
# Cancel a running operation associated with the task. This is the best effort attempt. Operation may not be cancelled anymore once it reaches certain stage.
|
31
|
+
# @api private
|
32
|
+
# @param task Task identifier. The parameter must be an identifier for the resource type: cis.task.
|
33
|
+
# @param [Hash] opts the optional parameters
|
34
|
+
# @return [Array<(|VapiStdErrorsUnsupportedError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil, Fixnum, Hash)>] nil, response status code and response headers
|
35
|
+
def cancel_with_http_info(task, opts = {})
|
36
|
+
if @api_client.config.debugging
|
37
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.cancel ...'
|
38
|
+
end
|
39
|
+
# verify the required parameter 'task' is set
|
40
|
+
if @api_client.config.client_side_validation && task.nil?
|
41
|
+
fail ArgumentError, "Missing the required parameter 'task' when calling TasksApi.cancel"
|
42
|
+
end
|
43
|
+
# resource path
|
44
|
+
local_var_path = '/cis/tasks/{task}?action=cancel'.sub('{' + 'task' + '}', task.to_s)
|
45
|
+
|
46
|
+
# query parameters
|
47
|
+
query_params = {}
|
48
|
+
|
49
|
+
# header parameters
|
50
|
+
header_params = {}
|
51
|
+
# HTTP header 'Accept' (if needed)
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
53
|
+
|
54
|
+
# form parameters
|
55
|
+
form_params = {}
|
56
|
+
|
57
|
+
# http body (model)
|
58
|
+
post_body = nil
|
59
|
+
auth_names = []
|
60
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
61
|
+
:header_params => header_params,
|
62
|
+
:query_params => query_params,
|
63
|
+
:form_params => form_params,
|
64
|
+
:body => post_body,
|
65
|
+
:auth_names => auth_names)
|
66
|
+
if @api_client.config.debugging
|
67
|
+
@api_client.config.logger.debug "API called: TasksApi#cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
68
|
+
end
|
69
|
+
return data, status_code, headers
|
70
|
+
end
|
71
|
+
# Returns information about a task.
|
72
|
+
# @param task Task identifier. The parameter must be an identifier for the resource type: cis.task.
|
73
|
+
# @param [Hash] opts the optional parameters
|
74
|
+
# @option opts [BOOLEAN] :spec_return_all If true, all data, including operation-specific data, will be returned, otherwise only the data described in Info will be returned. If unset, only the data described in Info will be returned.
|
75
|
+
# @option opts [BOOLEAN] :spec_exclude_result If true, the result will not be included in the task information, otherwise it will be included. If unset, the result of the operation will be included in the task information.
|
76
|
+
# @return [CisTasksResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|]
|
77
|
+
def get(task, opts = {})
|
78
|
+
data, _status_code, _headers = get_with_http_info(task, opts)
|
79
|
+
data
|
80
|
+
end
|
81
|
+
|
82
|
+
# Returns information about a task.
|
83
|
+
# @api private
|
84
|
+
# @param task Task identifier. The parameter must be an identifier for the resource type: cis.task.
|
85
|
+
# @param [Hash] opts the optional parameters
|
86
|
+
# @option opts [BOOLEAN] :spec_return_all If true, all data, including operation-specific data, will be returned, otherwise only the data described in Info will be returned. If unset, only the data described in Info will be returned.
|
87
|
+
# @option opts [BOOLEAN] :spec_exclude_result If true, the result will not be included in the task information, otherwise it will be included. If unset, the result of the operation will be included in the task information.
|
88
|
+
# @return [Array<(CisTasksResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>] data, response status code and response headers
|
89
|
+
def get_with_http_info(task, opts = {})
|
90
|
+
if @api_client.config.debugging
|
91
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get ...'
|
92
|
+
end
|
93
|
+
# verify the required parameter 'task' is set
|
94
|
+
if @api_client.config.client_side_validation && task.nil?
|
95
|
+
fail ArgumentError, "Missing the required parameter 'task' when calling TasksApi.get"
|
96
|
+
end
|
97
|
+
# resource path
|
98
|
+
local_var_path = '/cis/tasks/{task}'.sub('{' + 'task' + '}', task.to_s)
|
99
|
+
|
100
|
+
# query parameters
|
101
|
+
query_params = {}
|
102
|
+
query_params[:'spec.return_all'] = opts[:'spec_return_all'] if !opts[:'spec_return_all'].nil?
|
103
|
+
query_params[:'spec.exclude_result'] = opts[:'spec_exclude_result'] if !opts[:'spec_exclude_result'].nil?
|
104
|
+
|
105
|
+
# header parameters
|
106
|
+
header_params = {}
|
107
|
+
# HTTP header 'Accept' (if needed)
|
108
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
109
|
+
|
110
|
+
# form parameters
|
111
|
+
form_params = {}
|
112
|
+
|
113
|
+
# http body (model)
|
114
|
+
post_body = nil
|
115
|
+
auth_names = []
|
116
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
117
|
+
:header_params => header_params,
|
118
|
+
:query_params => query_params,
|
119
|
+
:form_params => form_params,
|
120
|
+
:body => post_body,
|
121
|
+
:auth_names => auth_names,
|
122
|
+
:return_type => {
|
123
|
+
'200' => 'CIS::CisTasksResult',
|
124
|
+
'400' => 'CIS::VapiStdErrorsResourceInaccessibleError',
|
125
|
+
'401' => 'CIS::VapiStdErrorsUnauthenticatedError',
|
126
|
+
'403' => 'CIS::VapiStdErrorsUnauthorizedError',
|
127
|
+
'404' => 'CIS::VapiStdErrorsNotFoundError',
|
128
|
+
'503' => 'CIS::VapiStdErrorsServiceUnavailableError',
|
129
|
+
})
|
130
|
+
if @api_client.config.debugging
|
131
|
+
@api_client.config.logger.debug "API called: TasksApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
132
|
+
end
|
133
|
+
return data, status_code, headers
|
134
|
+
end
|
135
|
+
# Returns information about at most 1000 visible (subject to permission checks) tasks matching the Tasks.FilterSpec. All tasks must be in the same provider.
|
136
|
+
# @param [Hash] opts the optional parameters
|
137
|
+
# @option opts [Array<String>] :filter_spec_tasks Identifiers of tasks that can match the filter. This field may be unset if Tasks.FilterSpec.services is specified. Currently all tasks must be from the same provider. If unset or empty, tasks with any identifier will match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: cis.task. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: cis.task.
|
138
|
+
# @option opts [BOOLEAN] :result_spec_return_all If true, all data, including operation-specific data, will be returned, otherwise only the data described in Info will be returned. If unset, only the data described in Info will be returned.
|
139
|
+
# @option opts [BOOLEAN] :result_spec_exclude_result If true, the result will not be included in the task information, otherwise it will be included. If unset, the result of the operation will be included in the task information.
|
140
|
+
# @option opts [Array<String>] :filter_spec_services Identifiers of services. Tasks created by operations in these services match the filter (see CommonInfo.service). This field may be unset if Tasks.FilterSpec.tasks is specified. Currently all services must be from the same provider. If this field is unset or empty, tasks for all services will match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: vapi.service. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: vapi.service.
|
141
|
+
# @option opts [Array<String>] :filter_spec_status Status that a task must have to match the filter (see CommonInfo.status). If unset or empty, tasks with any status match the filter.
|
142
|
+
# @option opts [Array<Object>] :filter_spec_targets Identifiers of the targets the operation for the associated task created or was performed on (see CommonInfo.target). If unset or empty, tasks associated with operations on any target match the filter.
|
143
|
+
# @option opts [Array<String>] :filter_spec_users Users who must have initiated the operation for the associated task to match the filter (see CommonInfo.user). If unset or empty, tasks associated with operations initiated by any user match the filter.
|
144
|
+
# @return [CisTasksListResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|]
|
145
|
+
def list(opts = {})
|
146
|
+
data, _status_code, _headers = list_with_http_info(opts)
|
147
|
+
data
|
148
|
+
end
|
149
|
+
|
150
|
+
# Returns information about at most 1000 visible (subject to permission checks) tasks matching the Tasks.FilterSpec. All tasks must be in the same provider.
|
151
|
+
# @api private
|
152
|
+
# @param [Hash] opts the optional parameters
|
153
|
+
# @option opts [Array<String>] :filter_spec_tasks Identifiers of tasks that can match the filter. This field may be unset if Tasks.FilterSpec.services is specified. Currently all tasks must be from the same provider. If unset or empty, tasks with any identifier will match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: cis.task. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: cis.task.
|
154
|
+
# @option opts [BOOLEAN] :result_spec_return_all If true, all data, including operation-specific data, will be returned, otherwise only the data described in Info will be returned. If unset, only the data described in Info will be returned.
|
155
|
+
# @option opts [BOOLEAN] :result_spec_exclude_result If true, the result will not be included in the task information, otherwise it will be included. If unset, the result of the operation will be included in the task information.
|
156
|
+
# @option opts [Array<String>] :filter_spec_services Identifiers of services. Tasks created by operations in these services match the filter (see CommonInfo.service). This field may be unset if Tasks.FilterSpec.tasks is specified. Currently all services must be from the same provider. If this field is unset or empty, tasks for all services will match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: vapi.service. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: vapi.service.
|
157
|
+
# @option opts [Array<String>] :filter_spec_status Status that a task must have to match the filter (see CommonInfo.status). If unset or empty, tasks with any status match the filter.
|
158
|
+
# @option opts [Array<Object>] :filter_spec_targets Identifiers of the targets the operation for the associated task created or was performed on (see CommonInfo.target). If unset or empty, tasks associated with operations on any target match the filter.
|
159
|
+
# @option opts [Array<String>] :filter_spec_users Users who must have initiated the operation for the associated task to match the filter (see CommonInfo.user). If unset or empty, tasks associated with operations initiated by any user match the filter.
|
160
|
+
# @return [Array<(CisTasksListResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>] data, response status code and response headers
|
161
|
+
def list_with_http_info(opts = {})
|
162
|
+
if @api_client.config.debugging
|
163
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.list ...'
|
164
|
+
end
|
165
|
+
if @api_client.config.client_side_validation && opts[:'filter_spec_status'] && !opts[:'filter_spec_status'].all? { |item| ['PENDING', 'RUNNING', 'BLOCKED', 'SUCCEEDED', 'FAILED'].include?(item) }
|
166
|
+
fail ArgumentError, 'invalid value for "filter_spec_status", must include one of PENDING, RUNNING, BLOCKED, SUCCEEDED, FAILED'
|
167
|
+
end
|
168
|
+
# resource path
|
169
|
+
local_var_path = '/cis/tasks'
|
170
|
+
|
171
|
+
# query parameters
|
172
|
+
query_params = {}
|
173
|
+
query_params[:'filter_spec.tasks'] = @api_client.build_collection_param(opts[:'filter_spec_tasks'], :multi) if !opts[:'filter_spec_tasks'].nil?
|
174
|
+
query_params[:'result_spec.return_all'] = opts[:'result_spec_return_all'] if !opts[:'result_spec_return_all'].nil?
|
175
|
+
query_params[:'result_spec.exclude_result'] = opts[:'result_spec_exclude_result'] if !opts[:'result_spec_exclude_result'].nil?
|
176
|
+
query_params[:'filter_spec.services'] = @api_client.build_collection_param(opts[:'filter_spec_services'], :multi) if !opts[:'filter_spec_services'].nil?
|
177
|
+
query_params[:'filter_spec.status'] = @api_client.build_collection_param(opts[:'filter_spec_status'], :multi) if !opts[:'filter_spec_status'].nil?
|
178
|
+
query_params[:'filter_spec.targets'] = @api_client.build_collection_param(opts[:'filter_spec_targets'], :multi) if !opts[:'filter_spec_targets'].nil?
|
179
|
+
query_params[:'filter_spec.users'] = @api_client.build_collection_param(opts[:'filter_spec_users'], :multi) if !opts[:'filter_spec_users'].nil?
|
180
|
+
|
181
|
+
# header parameters
|
182
|
+
header_params = {}
|
183
|
+
# HTTP header 'Accept' (if needed)
|
184
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
185
|
+
|
186
|
+
# form parameters
|
187
|
+
form_params = {}
|
188
|
+
|
189
|
+
# http body (model)
|
190
|
+
post_body = nil
|
191
|
+
auth_names = []
|
192
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
193
|
+
:header_params => header_params,
|
194
|
+
:query_params => query_params,
|
195
|
+
:form_params => form_params,
|
196
|
+
:body => post_body,
|
197
|
+
:auth_names => auth_names,
|
198
|
+
:return_type => {
|
199
|
+
'200' => 'CIS::CisTasksListResult',
|
200
|
+
'400' => 'CIS::VapiStdErrorsResourceInaccessibleError',
|
201
|
+
'401' => 'CIS::VapiStdErrorsUnauthenticatedError',
|
202
|
+
'403' => 'CIS::VapiStdErrorsUnauthorizedError',
|
203
|
+
'503' => 'CIS::VapiStdErrorsServiceUnavailableError',
|
204
|
+
})
|
205
|
+
if @api_client.config.debugging
|
206
|
+
@api_client.config.logger.debug "API called: TasksApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
207
|
+
end
|
208
|
+
return data, status_code, headers
|
209
|
+
end
|
210
|
+
end
|
211
|
+
end
|
212
|
+
end
|
@@ -0,0 +1,386 @@
|
|
1
|
+
=begin
|
2
|
+
# DO NOT MODIFY. THIS CODE IS GENERATED. CHANGES WILL BE OVERWRITTEN.
|
3
|
+
|
4
|
+
# cis
|
5
|
+
|
6
|
+
# No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
7
|
+
|
8
|
+
|
9
|
+
=end
|
10
|
+
|
11
|
+
require 'date'
|
12
|
+
require 'json'
|
13
|
+
require 'logger'
|
14
|
+
require 'tempfile'
|
15
|
+
require 'typhoeus'
|
16
|
+
require 'uri'
|
17
|
+
|
18
|
+
module VSphereAutomation
|
19
|
+
class ApiClient
|
20
|
+
# The Configuration object holding settings to be used in the API client.
|
21
|
+
attr_accessor :config
|
22
|
+
|
23
|
+
# Defines the headers to be used in HTTP requests of all API calls by default.
|
24
|
+
#
|
25
|
+
# @return [Hash]
|
26
|
+
attr_accessor :default_headers
|
27
|
+
|
28
|
+
# Initializes the ApiClient
|
29
|
+
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
30
|
+
def initialize(config = Configuration.default)
|
31
|
+
@config = config
|
32
|
+
@user_agent = "OpenAPI-Generator/#{CIS::VERSION}/ruby"
|
33
|
+
@default_headers = {
|
34
|
+
'Content-Type' => 'application/json',
|
35
|
+
'User-Agent' => @user_agent
|
36
|
+
}
|
37
|
+
end
|
38
|
+
|
39
|
+
def self.default
|
40
|
+
@@default ||= ApiClient.new
|
41
|
+
end
|
42
|
+
|
43
|
+
# Call an API with given options.
|
44
|
+
#
|
45
|
+
# @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
|
46
|
+
# the data deserialized from response body (could be nil), response status code and response headers.
|
47
|
+
def call_api(http_method, path, opts = {})
|
48
|
+
request = build_request(http_method, path, opts)
|
49
|
+
response = request.run
|
50
|
+
|
51
|
+
if @config.debugging
|
52
|
+
@config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
|
53
|
+
end
|
54
|
+
|
55
|
+
unless opts.fetch(:return_type, {}).keys.include?(response.code.to_s) || response.success?
|
56
|
+
if response.timed_out?
|
57
|
+
fail ApiError.new('Connection timed out')
|
58
|
+
elsif response.code == 0
|
59
|
+
# Errors from libcurl will be made visible here
|
60
|
+
fail ApiError.new(:code => 0,
|
61
|
+
:message => response.return_message)
|
62
|
+
else
|
63
|
+
fail ApiError.new(:code => response.code,
|
64
|
+
:response_headers => response.headers,
|
65
|
+
:response_body => response.body),
|
66
|
+
response.status_message
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
if opts[:return_type]
|
71
|
+
data = deserialize(response, opts[:return_type][response.code.to_s])
|
72
|
+
else
|
73
|
+
data = nil
|
74
|
+
end
|
75
|
+
return data, response.code, response.headers
|
76
|
+
end
|
77
|
+
|
78
|
+
# Builds the HTTP request
|
79
|
+
#
|
80
|
+
# @param [String] http_method HTTP method/verb (e.g. POST)
|
81
|
+
# @param [String] path URL path (e.g. /account/new)
|
82
|
+
# @option opts [Hash] :header_params Header parameters
|
83
|
+
# @option opts [Hash] :query_params Query parameters
|
84
|
+
# @option opts [Hash] :form_params Query parameters
|
85
|
+
# @option opts [Object] :body HTTP body (JSON/XML)
|
86
|
+
# @return [Typhoeus::Request] A Typhoeus Request
|
87
|
+
def build_request(http_method, path, opts = {})
|
88
|
+
url = build_request_url(path)
|
89
|
+
http_method = http_method.to_sym.downcase
|
90
|
+
|
91
|
+
header_params = @default_headers.merge(opts[:header_params] || {})
|
92
|
+
query_params = opts[:query_params] || {}
|
93
|
+
form_params = opts[:form_params] || {}
|
94
|
+
|
95
|
+
|
96
|
+
# set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
|
97
|
+
_verify_ssl_host = @config.verify_ssl_host ? 2 : 0
|
98
|
+
|
99
|
+
req_opts = {
|
100
|
+
:method => http_method,
|
101
|
+
:headers => header_params,
|
102
|
+
:params => query_params,
|
103
|
+
:params_encoding => @config.params_encoding,
|
104
|
+
:timeout => @config.timeout,
|
105
|
+
:ssl_verifypeer => @config.verify_ssl,
|
106
|
+
:ssl_verifyhost => _verify_ssl_host,
|
107
|
+
:sslcert => @config.cert_file,
|
108
|
+
:sslkey => @config.key_file,
|
109
|
+
:verbose => @config.debugging
|
110
|
+
}
|
111
|
+
|
112
|
+
# set custom cert, if provided
|
113
|
+
req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
|
114
|
+
|
115
|
+
if [:post, :patch, :put, :delete].include?(http_method)
|
116
|
+
req_body = build_request_body(header_params, form_params, opts[:body])
|
117
|
+
req_opts.update :body => req_body
|
118
|
+
if @config.debugging
|
119
|
+
@config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
|
120
|
+
end
|
121
|
+
end
|
122
|
+
|
123
|
+
request = Typhoeus::Request.new(url, req_opts)
|
124
|
+
download_file(request) if opts[:return_type] == 'File'
|
125
|
+
request
|
126
|
+
end
|
127
|
+
|
128
|
+
# Check if the given MIME is a JSON MIME.
|
129
|
+
# JSON MIME examples:
|
130
|
+
# application/json
|
131
|
+
# application/json; charset=UTF8
|
132
|
+
# APPLICATION/JSON
|
133
|
+
# */*
|
134
|
+
# @param [String] mime MIME
|
135
|
+
# @return [Boolean] True if the MIME is application/json
|
136
|
+
def json_mime?(mime)
|
137
|
+
(mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
138
|
+
end
|
139
|
+
|
140
|
+
# Deserialize the response to the given return type.
|
141
|
+
#
|
142
|
+
# @param [Response] response HTTP response
|
143
|
+
# @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
|
144
|
+
def deserialize(response, return_type)
|
145
|
+
body = response.body
|
146
|
+
|
147
|
+
# handle file downloading - return the File instance processed in request callbacks
|
148
|
+
# note that response body is empty when the file is written in chunks in request on_body callback
|
149
|
+
return @tempfile if return_type == 'File'
|
150
|
+
|
151
|
+
return nil if body.nil? || body.empty?
|
152
|
+
|
153
|
+
# return response body directly for String return type
|
154
|
+
return body if return_type == 'String'
|
155
|
+
|
156
|
+
# ensuring a default content type
|
157
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
158
|
+
|
159
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
160
|
+
|
161
|
+
begin
|
162
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
163
|
+
rescue JSON::ParserError => e
|
164
|
+
if %w(String Date DateTime).include?(return_type)
|
165
|
+
data = body
|
166
|
+
else
|
167
|
+
raise e
|
168
|
+
end
|
169
|
+
end
|
170
|
+
|
171
|
+
convert_to_type data, return_type
|
172
|
+
end
|
173
|
+
|
174
|
+
# Convert data to the given return type.
|
175
|
+
# @param [Object] data Data to be converted
|
176
|
+
# @param [String] return_type Return type
|
177
|
+
# @return [Mixed] Data in a particular type
|
178
|
+
def convert_to_type(data, return_type)
|
179
|
+
return nil if data.nil?
|
180
|
+
case return_type
|
181
|
+
when 'String'
|
182
|
+
data.to_s
|
183
|
+
when 'Integer'
|
184
|
+
data.to_i
|
185
|
+
when 'Float'
|
186
|
+
data.to_f
|
187
|
+
when 'BOOLEAN'
|
188
|
+
data == true
|
189
|
+
when 'DateTime'
|
190
|
+
# parse date time (expecting ISO 8601 format)
|
191
|
+
DateTime.parse data
|
192
|
+
when 'Date'
|
193
|
+
# parse date time (expecting ISO 8601 format)
|
194
|
+
Date.parse data
|
195
|
+
when 'Object'
|
196
|
+
# generic object (usually a Hash), return directly
|
197
|
+
data
|
198
|
+
when /\AArray<(.+)>\z/
|
199
|
+
# e.g. Array<Pet>
|
200
|
+
sub_type = $1
|
201
|
+
data.map { |item| convert_to_type(item, sub_type) }
|
202
|
+
when /\AHash\<String, (.+)\>\z/
|
203
|
+
# e.g. Hash<String, Integer>
|
204
|
+
sub_type = $1
|
205
|
+
{}.tap do |hash|
|
206
|
+
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
207
|
+
end
|
208
|
+
else
|
209
|
+
# models, e.g. Pet
|
210
|
+
VSphereAutomation.const_get(return_type).new.tap do |model|
|
211
|
+
model.build_from_hash data
|
212
|
+
end
|
213
|
+
end
|
214
|
+
end
|
215
|
+
|
216
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
217
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
218
|
+
# The response body is written to the file in chunks in order to handle files which
|
219
|
+
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
220
|
+
# process can use.
|
221
|
+
#
|
222
|
+
# @see Configuration#temp_folder_path
|
223
|
+
def download_file(request)
|
224
|
+
tempfile = nil
|
225
|
+
encoding = nil
|
226
|
+
request.on_headers do |response|
|
227
|
+
content_disposition = response.headers['Content-Disposition']
|
228
|
+
if content_disposition && content_disposition =~ /filename=/i
|
229
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
230
|
+
prefix = sanitize_filename(filename)
|
231
|
+
else
|
232
|
+
prefix = 'download-'
|
233
|
+
end
|
234
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
235
|
+
encoding = response.body.encoding
|
236
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
237
|
+
@tempfile = tempfile
|
238
|
+
end
|
239
|
+
request.on_body do |chunk|
|
240
|
+
chunk.force_encoding(encoding)
|
241
|
+
tempfile.write(chunk)
|
242
|
+
end
|
243
|
+
request.on_complete do |response|
|
244
|
+
tempfile.close
|
245
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
246
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
247
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
248
|
+
"explicitly with `tempfile.delete`"
|
249
|
+
end
|
250
|
+
end
|
251
|
+
|
252
|
+
# Sanitize filename by removing path.
|
253
|
+
# e.g. ../../sun.gif becomes sun.gif
|
254
|
+
#
|
255
|
+
# @param [String] filename the filename to be sanitized
|
256
|
+
# @return [String] the sanitized filename
|
257
|
+
def sanitize_filename(filename)
|
258
|
+
filename.gsub(/.*[\/\\]/, '')
|
259
|
+
end
|
260
|
+
|
261
|
+
def build_request_url(path)
|
262
|
+
# Add leading and trailing slashes to path
|
263
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
264
|
+
URI.encode(@config.base_url + path)
|
265
|
+
end
|
266
|
+
|
267
|
+
# Builds the HTTP request body
|
268
|
+
#
|
269
|
+
# @param [Hash] header_params Header parameters
|
270
|
+
# @param [Hash] form_params Query parameters
|
271
|
+
# @param [Object] body HTTP body (JSON/XML)
|
272
|
+
# @return [String] HTTP body data in the form of string
|
273
|
+
def build_request_body(header_params, form_params, body)
|
274
|
+
# http form
|
275
|
+
if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
|
276
|
+
header_params['Content-Type'] == 'multipart/form-data'
|
277
|
+
data = {}
|
278
|
+
form_params.each do |key, value|
|
279
|
+
case value
|
280
|
+
when ::File, ::Array, nil
|
281
|
+
# let typhoeus handle File, Array and nil parameters
|
282
|
+
data[key] = value
|
283
|
+
else
|
284
|
+
data[key] = value.to_s
|
285
|
+
end
|
286
|
+
end
|
287
|
+
elsif body
|
288
|
+
data = body.is_a?(String) ? body : body.to_json
|
289
|
+
else
|
290
|
+
data = nil
|
291
|
+
end
|
292
|
+
data
|
293
|
+
end
|
294
|
+
|
295
|
+
# Update hearder and query params based on authentication settings.
|
296
|
+
#
|
297
|
+
# @param [Hash] header_params Header parameters
|
298
|
+
# @param [Hash] query_params Query parameters
|
299
|
+
# @param [String] auth_names Authentication scheme name
|
300
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
301
|
+
Array(auth_names).each do |auth_name|
|
302
|
+
auth_setting = @config.auth_settings[auth_name]
|
303
|
+
next unless auth_setting
|
304
|
+
case auth_setting[:in]
|
305
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
306
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
307
|
+
else fail ArgumentError, 'Authentication token must be in `query` of `header`'
|
308
|
+
end
|
309
|
+
end
|
310
|
+
end
|
311
|
+
|
312
|
+
# Sets user agent in HTTP header
|
313
|
+
#
|
314
|
+
# @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
|
315
|
+
def user_agent=(user_agent)
|
316
|
+
@user_agent = user_agent
|
317
|
+
@default_headers['User-Agent'] = @user_agent
|
318
|
+
end
|
319
|
+
|
320
|
+
# Return Accept header based on an array of accepts provided.
|
321
|
+
# @param [Array] accepts array for Accept
|
322
|
+
# @return [String] the Accept header (e.g. application/json)
|
323
|
+
def select_header_accept(accepts)
|
324
|
+
return nil if accepts.nil? || accepts.empty?
|
325
|
+
# use JSON when present, otherwise use all of the provided
|
326
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
327
|
+
json_accept || accepts.join(',')
|
328
|
+
end
|
329
|
+
|
330
|
+
# Return Content-Type header based on an array of content types provided.
|
331
|
+
# @param [Array] content_types array for Content-Type
|
332
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
333
|
+
def select_header_content_type(content_types)
|
334
|
+
# use application/json by default
|
335
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
336
|
+
# use JSON when present, otherwise use the first one
|
337
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
338
|
+
json_content_type || content_types.first
|
339
|
+
end
|
340
|
+
|
341
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
342
|
+
# @param [Object] model object to be converted into JSON string
|
343
|
+
# @return [String] JSON string representation of the object
|
344
|
+
def object_to_http_body(model)
|
345
|
+
return model if model.nil? || model.is_a?(String)
|
346
|
+
local_body = nil
|
347
|
+
if model.is_a?(Array)
|
348
|
+
local_body = model.map { |m| object_to_hash(m) }
|
349
|
+
else
|
350
|
+
local_body = object_to_hash(model)
|
351
|
+
end
|
352
|
+
local_body.to_json
|
353
|
+
end
|
354
|
+
|
355
|
+
# Convert object(non-array) to hash.
|
356
|
+
# @param [Object] obj object to be converted into JSON string
|
357
|
+
# @return [String] JSON string representation of the object
|
358
|
+
def object_to_hash(obj)
|
359
|
+
if obj.respond_to?(:to_hash)
|
360
|
+
obj.to_hash
|
361
|
+
else
|
362
|
+
obj
|
363
|
+
end
|
364
|
+
end
|
365
|
+
|
366
|
+
# Build parameter value according to the given collection format.
|
367
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
368
|
+
def build_collection_param(param, collection_format)
|
369
|
+
case collection_format
|
370
|
+
when :csv
|
371
|
+
param.join(',')
|
372
|
+
when :ssv
|
373
|
+
param.join(' ')
|
374
|
+
when :tsv
|
375
|
+
param.join("\t")
|
376
|
+
when :pipes
|
377
|
+
param.join('|')
|
378
|
+
when :multi
|
379
|
+
# return the array directly as typhoeus will handle it as expected
|
380
|
+
param
|
381
|
+
else
|
382
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
383
|
+
end
|
384
|
+
end
|
385
|
+
end
|
386
|
+
end
|