flywheel-sdk 21.2.0rc0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- flywheel/__init__.py +784 -0
- flywheel/api/__init__.py +46 -0
- flywheel/api/acquisitions_api.py +5014 -0
- flywheel/api/analyses_api.py +3848 -0
- flywheel/api/audit_trail_api.py +568 -0
- flywheel/api/auth_api.py +121 -0
- flywheel/api/batch_api.py +630 -0
- flywheel/api/bulk_api.py +140 -0
- flywheel/api/change_log_api.py +254 -0
- flywheel/api/collections_api.py +3913 -0
- flywheel/api/config_api.py +299 -0
- flywheel/api/container_tasks_api.py +137 -0
- flywheel/api/container_type_api.py +137 -0
- flywheel/api/containers_api.py +4784 -0
- flywheel/api/custom_filters_api.py +466 -0
- flywheel/api/data_view_executions_api.py +549 -0
- flywheel/api/dataexplorer_api.py +1192 -0
- flywheel/api/devices_api.py +1071 -0
- flywheel/api/dimse_api.py +814 -0
- flywheel/api/download_api.py +261 -0
- flywheel/api/files_api.py +1868 -0
- flywheel/api/form_responses_api.py +703 -0
- flywheel/api/gears_api.py +1875 -0
- flywheel/api/groups_api.py +2829 -0
- flywheel/api/jobs_api.py +2320 -0
- flywheel/api/jupyterlab_servers_api.py +245 -0
- flywheel/api/modalities_api.py +562 -0
- flywheel/api/packfiles_api.py +121 -0
- flywheel/api/projects_api.py +7820 -0
- flywheel/api/protocols_api.py +757 -0
- flywheel/api/reports_api.py +1057 -0
- flywheel/api/resolve_api.py +276 -0
- flywheel/api/roles_api.py +563 -0
- flywheel/api/sessions_api.py +5296 -0
- flywheel/api/site_api.py +1552 -0
- flywheel/api/staffing_pools_api.py +677 -0
- flywheel/api/subjects_api.py +5349 -0
- flywheel/api/tasks_api.py +897 -0
- flywheel/api/tree_api.py +266 -0
- flywheel/api/uids_api.py +140 -0
- flywheel/api/upload_api.py +842 -0
- flywheel/api/users_api.py +2142 -0
- flywheel/api/views_api.py +1089 -0
- flywheel/api_client.py +748 -0
- flywheel/client.py +291 -0
- flywheel/configuration.py +308 -0
- flywheel/drone_login.py +65 -0
- flywheel/file_spec.py +67 -0
- flywheel/finder.py +168 -0
- flywheel/flywheel.py +9867 -0
- flywheel/gear_context.py +374 -0
- flywheel/models/__init__.py +726 -0
- flywheel/models/access_level.py +30 -0
- flywheel/models/access_permission.py +197 -0
- flywheel/models/access_permission_output.py +192 -0
- flywheel/models/access_permission_update.py +166 -0
- flywheel/models/access_type.py +54 -0
- flywheel/models/accumulator.py +33 -0
- flywheel/models/acquisition.py +25 -0
- flywheel/models/acquisition_container_output.py +34 -0
- flywheel/models/acquisition_copy_input.py +223 -0
- flywheel/models/acquisition_input.py +297 -0
- flywheel/models/acquisition_list_output.py +767 -0
- flywheel/models/acquisition_modify_input.py +299 -0
- flywheel/models/acquisition_node.py +35 -0
- flywheel/models/acquisition_output.py +767 -0
- flywheel/models/acquisition_parents.py +241 -0
- flywheel/models/acquisition_template_options.py +275 -0
- flywheel/models/acquisition_upsert_input.py +383 -0
- flywheel/models/acquisition_upsert_output.py +243 -0
- flywheel/models/action.py +91 -0
- flywheel/models/adhoc_analysis_input.py +247 -0
- flywheel/models/analysis.py +25 -0
- flywheel/models/analysis_container_output.py +34 -0
- flywheel/models/analysis_files_create_ticket_output.py +241 -0
- flywheel/models/analysis_input.py +310 -0
- flywheel/models/analysis_input_legacy.py +25 -0
- flywheel/models/analysis_list_output.py +680 -0
- flywheel/models/analysis_list_output_inflated_job.py +650 -0
- flywheel/models/analysis_modify_input.py +191 -0
- flywheel/models/analysis_node.py +35 -0
- flywheel/models/analysis_output.py +683 -0
- flywheel/models/analysis_output_inflated_job.py +674 -0
- flywheel/models/analysis_parents.py +270 -0
- flywheel/models/analysis_update.py +25 -0
- flywheel/models/api_key_input_with_optional_label.py +191 -0
- flywheel/models/api_key_output.py +297 -0
- flywheel/models/as_storage.py +298 -0
- flywheel/models/assignee.py +192 -0
- flywheel/models/assignee_type.py +29 -0
- flywheel/models/audit_trail_report.py +486 -0
- flywheel/models/audit_trail_report_status.py +32 -0
- flywheel/models/auth0_auth_out.py +323 -0
- flywheel/models/auth0_options_out.py +319 -0
- flywheel/models/auth_out.py +357 -0
- flywheel/models/auth_session_output.py +272 -0
- flywheel/models/avatars.py +218 -0
- flywheel/models/aws_creds.py +191 -0
- flywheel/models/aws_storage.py +354 -0
- flywheel/models/azure_creds.py +190 -0
- flywheel/models/base_aet.py +245 -0
- flywheel/models/base_compute.py +426 -0
- flywheel/models/batch.py +360 -0
- flywheel/models/batch_cancel_output.py +36 -0
- flywheel/models/batch_create_filters.py +220 -0
- flywheel/models/batch_job_analysis_input.py +281 -0
- flywheel/models/batch_jobs_proposal_input.py +36 -0
- flywheel/models/batch_proposal.py +25 -0
- flywheel/models/batch_proposal_detail.py +36 -0
- flywheel/models/batch_proposal_input.py +25 -0
- flywheel/models/body.py +36 -0
- flywheel/models/body_regenerate_key_api_devices_device_id_key_post.py +25 -0
- flywheel/models/body_region.py +46 -0
- flywheel/models/bookmark.py +189 -0
- flywheel/models/bulk_move_input.py +272 -0
- flywheel/models/bulk_move_sessions.py +25 -0
- flywheel/models/callbacks_virus_scan_input.py +36 -0
- flywheel/models/cancelled_batch_output.py +163 -0
- flywheel/models/catalog_list_output.py +407 -0
- flywheel/models/central_out.py +299 -0
- flywheel/models/change.py +379 -0
- flywheel/models/change_log_container_type.py +38 -0
- flywheel/models/change_log_document.py +245 -0
- flywheel/models/change_method.py +33 -0
- flywheel/models/classic_batch_job_output.py +352 -0
- flywheel/models/classic_batch_job_output_inflated_jobs.py +379 -0
- flywheel/models/classic_batch_proposal_input.py +388 -0
- flywheel/models/classic_batch_proposal_output.py +471 -0
- flywheel/models/classification_add_delete.py +36 -0
- flywheel/models/classification_replace.py +36 -0
- flywheel/models/classification_update_input.py +36 -0
- flywheel/models/cohort.py +29 -0
- flywheel/models/collection.py +25 -0
- flywheel/models/collection_container_output.py +32 -0
- flywheel/models/collection_input.py +217 -0
- flywheel/models/collection_input_with_contents.py +248 -0
- flywheel/models/collection_node.py +192 -0
- flywheel/models/collection_node_level.py +31 -0
- flywheel/models/collection_operation.py +193 -0
- flywheel/models/collection_operation_type.py +29 -0
- flywheel/models/collection_output.py +639 -0
- flywheel/models/collection_with_stats.py +637 -0
- flywheel/models/column.py +286 -0
- flywheel/models/column_type.py +32 -0
- flywheel/models/common_classification.py +135 -0
- flywheel/models/common_deleted_count.py +25 -0
- flywheel/models/common_editions.py +25 -0
- flywheel/models/common_info.py +135 -0
- flywheel/models/common_join_origins.py +25 -0
- flywheel/models/common_key.py +36 -0
- flywheel/models/common_modified_count.py +25 -0
- flywheel/models/common_object_created.py +36 -0
- flywheel/models/common_project_settings.py +25 -0
- flywheel/models/common_settings.py +36 -0
- flywheel/models/complete_multipart_upload_output.py +189 -0
- flywheel/models/complete_s3_multipart_upload_input.py +241 -0
- flywheel/models/config_feature_map.py +36 -0
- flywheel/models/config_out.py +381 -0
- flywheel/models/config_output.py +36 -0
- flywheel/models/config_site_config_output.py +36 -0
- flywheel/models/config_site_settings.py +36 -0
- flywheel/models/config_site_settings_input.py +36 -0
- flywheel/models/conflict_types.py +30 -0
- flywheel/models/container_delete_reason.py +39 -0
- flywheel/models/container_filter.py +193 -0
- flywheel/models/container_id_view_input.py +521 -0
- flywheel/models/container_id_view_input_execute_and_save.py +308 -0
- flywheel/models/container_modify.py +536 -0
- flywheel/models/container_new_output.py +25 -0
- flywheel/models/container_node_min.py +350 -0
- flywheel/models/container_output.py +36 -0
- flywheel/models/container_output_with_files.py +283 -0
- flywheel/models/container_parents.py +311 -0
- flywheel/models/container_pipeline_input.py +536 -0
- flywheel/models/container_project_parents.py +25 -0
- flywheel/models/container_reference.py +193 -0
- flywheel/models/container_reference_with_label.py +219 -0
- flywheel/models/container_session_parents.py +25 -0
- flywheel/models/container_subject_parents.py +25 -0
- flywheel/models/container_type.py +39 -0
- flywheel/models/container_uidcheck.py +253 -0
- flywheel/models/container_update.py +135 -0
- flywheel/models/context_input.py +217 -0
- flywheel/models/copy_filter.py +299 -0
- flywheel/models/copy_status.py +32 -0
- flywheel/models/core_models_api_key_api_key_input.py +190 -0
- flywheel/models/core_models_audit_trail_create_report_input.py +273 -0
- flywheel/models/core_models_audit_trail_modify_report_input.py +167 -0
- flywheel/models/core_models_common_source.py +189 -0
- flywheel/models/core_models_jobs_api_key_input.py +191 -0
- flywheel/models/core_models_search_parent_type.py +33 -0
- flywheel/models/core_workflows_form_responses_models_form_parents.py +163 -0
- flywheel/models/core_workflows_form_responses_models_form_response_output.py +440 -0
- flywheel/models/core_workflows_reader_models_reader_task_parents.py +295 -0
- flywheel/models/creds.py +135 -0
- flywheel/models/curator.py +221 -0
- flywheel/models/current_user_output.py +707 -0
- flywheel/models/custom_field.py +437 -0
- flywheel/models/custom_form.py +244 -0
- flywheel/models/cvat_info.py +275 -0
- flywheel/models/cvat_settings.py +272 -0
- flywheel/models/cvat_settings_input.py +272 -0
- flywheel/models/cvat_sync_state.py +30 -0
- flywheel/models/daily_report_usage.py +565 -0
- flywheel/models/data_strategy.py +29 -0
- flywheel/models/data_view.py +25 -0
- flywheel/models/data_view_analysis_file_spec.py +221 -0
- flywheel/models/data_view_analysis_filter_spec.py +221 -0
- flywheel/models/data_view_column_alias.py +337 -0
- flywheel/models/data_view_column_spec.py +286 -0
- flywheel/models/data_view_execution.py +505 -0
- flywheel/models/data_view_execution_state.py +31 -0
- flywheel/models/data_view_file_spec.py +392 -0
- flywheel/models/data_view_group_by.py +166 -0
- flywheel/models/data_view_group_by_column.py +194 -0
- flywheel/models/data_view_name_filter_spec.py +194 -0
- flywheel/models/data_view_output.py +25 -0
- flywheel/models/data_view_save_data_view_input.py +25 -0
- flywheel/models/data_view_zip_filter_spec.py +223 -0
- flywheel/models/default_flywheel_role.py +30 -0
- flywheel/models/deid_log_skip_reason.py +29 -0
- flywheel/models/delete_by_search_query.py +253 -0
- flywheel/models/deleted_file.py +514 -0
- flywheel/models/deleted_result.py +194 -0
- flywheel/models/deprecated_action.py +29 -0
- flywheel/models/destination_container_type.py +30 -0
- flywheel/models/device.py +437 -0
- flywheel/models/device_admin_update.py +194 -0
- flywheel/models/device_create.py +219 -0
- flywheel/models/device_self_update.py +272 -0
- flywheel/models/device_status.py +36 -0
- flywheel/models/device_status_entry.py +221 -0
- flywheel/models/device_storage_strategy_update.py +193 -0
- flywheel/models/dimse_project_input.py +36 -0
- flywheel/models/dimse_project_output.py +36 -0
- flywheel/models/dimse_service_input.py +36 -0
- flywheel/models/dimse_service_output.py +36 -0
- flywheel/models/download.py +249 -0
- flywheel/models/download_container_filter.py +167 -0
- flywheel/models/download_container_filter_definition.py +222 -0
- flywheel/models/download_filter.py +221 -0
- flywheel/models/download_filter_definition.py +195 -0
- flywheel/models/download_format.py +29 -0
- flywheel/models/download_input.py +25 -0
- flywheel/models/download_node.py +189 -0
- flywheel/models/download_strategy.py +31 -0
- flywheel/models/download_ticket.py +36 -0
- flywheel/models/download_ticket_stub.py +249 -0
- flywheel/models/download_ticket_with_summary.py +36 -0
- flywheel/models/e_signature.py +242 -0
- flywheel/models/edition.py +169 -0
- flywheel/models/egress_device.py +597 -0
- flywheel/models/egress_device_page.py +219 -0
- flywheel/models/egress_provider.py +408 -0
- flywheel/models/egress_provider_id.py +164 -0
- flywheel/models/exchange_storage.py +243 -0
- flywheel/models/executor_info.py +353 -0
- flywheel/models/export_templates.py +195 -0
- flywheel/models/features.py +1838 -0
- flywheel/models/field_change.py +271 -0
- flywheel/models/field_change_log_document.py +245 -0
- flywheel/models/field_type.py +37 -0
- flywheel/models/file.py +1139 -0
- flywheel/models/file_classification_delta.py +245 -0
- flywheel/models/file_container_type.py +34 -0
- flywheel/models/file_entry.py +740 -0
- flywheel/models/file_export_templates.py +272 -0
- flywheel/models/file_format.py +33 -0
- flywheel/models/file_gear_info.py +215 -0
- flywheel/models/file_group.py +29 -0
- flywheel/models/file_list_output.py +1115 -0
- flywheel/models/file_modify_input.py +191 -0
- flywheel/models/file_move_input.py +221 -0
- flywheel/models/file_node.py +1138 -0
- flywheel/models/file_node_min.py +321 -0
- flywheel/models/file_origin.py +283 -0
- flywheel/models/file_output.py +1135 -0
- flywheel/models/file_parents.py +297 -0
- flywheel/models/file_reference.py +221 -0
- flywheel/models/file_suggestion.py +241 -0
- flywheel/models/file_template_options.py +299 -0
- flywheel/models/file_upsert_input.py +612 -0
- flywheel/models/file_upsert_origin.py +36 -0
- flywheel/models/file_upsert_output.py +1154 -0
- flywheel/models/file_version.py +190 -0
- flywheel/models/file_version_copy_of.py +273 -0
- flywheel/models/file_version_output.py +325 -0
- flywheel/models/file_via.py +245 -0
- flywheel/models/file_zip_entry.py +25 -0
- flywheel/models/file_zip_info.py +25 -0
- flywheel/models/filter.py +350 -0
- flywheel/models/filter_input.py +218 -0
- flywheel/models/filter_values.py +195 -0
- flywheel/models/filter_view.py +28 -0
- flywheel/models/fixed_file_version_input.py +216 -0
- flywheel/models/fixed_input.py +299 -0
- flywheel/models/form_definition.py +163 -0
- flywheel/models/form_response_base.py +311 -0
- flywheel/models/form_response_create.py +193 -0
- flywheel/models/gcp_creds.py +397 -0
- flywheel/models/gcp_storage.py +298 -0
- flywheel/models/gear.py +619 -0
- flywheel/models/gear_category.py +32 -0
- flywheel/models/gear_config.py +138 -0
- flywheel/models/gear_context_input.py +164 -0
- flywheel/models/gear_context_lookup.py +25 -0
- flywheel/models/gear_context_lookup_item.py +36 -0
- flywheel/models/gear_context_value_output.py +272 -0
- flywheel/models/gear_context_value_output_unfound.py +164 -0
- flywheel/models/gear_custom.py +135 -0
- flywheel/models/gear_directive.py +135 -0
- flywheel/models/gear_doc.py +25 -0
- flywheel/models/gear_document.py +332 -0
- flywheel/models/gear_document_input.py +303 -0
- flywheel/models/gear_document_legacy_input.py +302 -0
- flywheel/models/gear_environment.py +135 -0
- flywheel/models/gear_exchange.py +221 -0
- flywheel/models/gear_file_input.py +192 -0
- flywheel/models/gear_id_output.py +170 -0
- flywheel/models/gear_info.py +251 -0
- flywheel/models/gear_input_item.py +231 -0
- flywheel/models/gear_inputs.py +140 -0
- flywheel/models/gear_invocation.py +138 -0
- flywheel/models/gear_key_input.py +191 -0
- flywheel/models/gear_manifest.py +624 -0
- flywheel/models/gear_mixin.py +218 -0
- flywheel/models/gear_node.py +355 -0
- flywheel/models/gear_output_configuration.py +164 -0
- flywheel/models/gear_permissions.py +191 -0
- flywheel/models/gear_permissions_input.py +163 -0
- flywheel/models/gear_permissions_type.py +29 -0
- flywheel/models/gear_return_ticket.py +25 -0
- flywheel/models/gear_rule.py +653 -0
- flywheel/models/gear_rule_condition.py +219 -0
- flywheel/models/gear_rule_condition_type.py +37 -0
- flywheel/models/gear_rule_input.py +517 -0
- flywheel/models/gear_rule_modify_input.py +492 -0
- flywheel/models/gear_rule_output.py +652 -0
- flywheel/models/gear_save_submission.py +221 -0
- flywheel/models/gear_series.py +298 -0
- flywheel/models/gear_series_update.py +163 -0
- flywheel/models/gear_suggestion_output.py +301 -0
- flywheel/models/gear_ticket.py +245 -0
- flywheel/models/gear_ticket_output.py +163 -0
- flywheel/models/google_auth_out.py +299 -0
- flywheel/models/graph_filter.py +329 -0
- flywheel/models/group.py +25 -0
- flywheel/models/group_by.py +163 -0
- flywheel/models/group_by_column.py +36 -0
- flywheel/models/group_container_output.py +33 -0
- flywheel/models/group_input.py +248 -0
- flywheel/models/group_metadata_input.py +36 -0
- flywheel/models/group_node.py +34 -0
- flywheel/models/group_output.py +471 -0
- flywheel/models/group_report.py +218 -0
- flywheel/models/group_role.py +163 -0
- flywheel/models/group_settings_output.py +249 -0
- flywheel/models/group_update.py +249 -0
- flywheel/models/header_feature.py +37 -0
- flywheel/models/hierarchy_export_templates.py +272 -0
- flywheel/models/http_validation_error.py +167 -0
- flywheel/models/info.py +218 -0
- flywheel/models/info_add_remove.py +36 -0
- flywheel/models/info_container_type.py +35 -0
- flywheel/models/info_replace.py +36 -0
- flywheel/models/info_update_input.py +36 -0
- flywheel/models/ingress_provider.py +299 -0
- flywheel/models/ingress_providers.py +272 -0
- flywheel/models/ingress_site_settings.py +305 -0
- flywheel/models/ingress_update_provider.py +218 -0
- flywheel/models/inline_response200.py +163 -0
- flywheel/models/inline_response2001.py +171 -0
- flywheel/models/inline_response2002.py +163 -0
- flywheel/models/inline_response2003.py +36 -0
- flywheel/models/inline_response2005.py +25 -0
- flywheel/models/input_filter.py +221 -0
- flywheel/models/input_job.py +521 -0
- flywheel/models/input_job_profile.py +275 -0
- flywheel/models/inserted_id.py +163 -0
- flywheel/models/job.py +841 -0
- flywheel/models/job_analysis_input.py +273 -0
- flywheel/models/job_ask.py +301 -0
- flywheel/models/job_ask_response.py +195 -0
- flywheel/models/job_ask_response_job.py +978 -0
- flywheel/models/job_ask_return.py +25 -0
- flywheel/models/job_ask_return_criteria.py +245 -0
- flywheel/models/job_ask_state.py +25 -0
- flywheel/models/job_ask_state_response.py +163 -0
- flywheel/models/job_complete.py +220 -0
- flywheel/models/job_completion_input.py +25 -0
- flywheel/models/job_completion_ticket.py +25 -0
- flywheel/models/job_config.py +135 -0
- flywheel/models/job_config_input.py +272 -0
- flywheel/models/job_config_inputs.py +25 -0
- flywheel/models/job_config_output.py +25 -0
- flywheel/models/job_container_detail.py +25 -0
- flywheel/models/job_destination.py +189 -0
- flywheel/models/job_detail.py +925 -0
- flywheel/models/job_detail_container.py +190 -0
- flywheel/models/job_detail_file_entry.py +194 -0
- flywheel/models/job_detail_group.py +190 -0
- flywheel/models/job_detail_parent_info.py +303 -0
- flywheel/models/job_executor_info.py +369 -0
- flywheel/models/job_file_input.py +247 -0
- flywheel/models/job_file_input_list_output.py +247 -0
- flywheel/models/job_file_object.py +435 -0
- flywheel/models/job_file_object_list_output.py +407 -0
- flywheel/models/job_gear_match.py +25 -0
- flywheel/models/job_inputs_array_item.py +305 -0
- flywheel/models/job_inputs_item.py +242 -0
- flywheel/models/job_inputs_object.py +138 -0
- flywheel/models/job_list_entry.py +25 -0
- flywheel/models/job_list_output.py +979 -0
- flywheel/models/job_list_output_config.py +220 -0
- flywheel/models/job_log.py +189 -0
- flywheel/models/job_log_column.py +40 -0
- flywheel/models/job_log_record.py +192 -0
- flywheel/models/job_modify.py +193 -0
- flywheel/models/job_origin.py +190 -0
- flywheel/models/job_output.py +1005 -0
- flywheel/models/job_output_config.py +247 -0
- flywheel/models/job_parents.py +297 -0
- flywheel/models/job_priority.py +31 -0
- flywheel/models/job_priority_update.py +192 -0
- flywheel/models/job_profile.py +427 -0
- flywheel/models/job_profile_input.py +25 -0
- flywheel/models/job_request.py +221 -0
- flywheel/models/job_request_item.py +246 -0
- flywheel/models/job_request_item_type.py +31 -0
- flywheel/models/job_request_target.py +270 -0
- flywheel/models/job_state.py +32 -0
- flywheel/models/job_state_counts.py +25 -0
- flywheel/models/job_stats_by_state.py +25 -0
- flywheel/models/job_ticket_output.py +165 -0
- flywheel/models/job_transition_times.py +253 -0
- flywheel/models/job_version_info.py +135 -0
- flywheel/models/jobs_by_state.py +272 -0
- flywheel/models/jobs_list.py +166 -0
- flywheel/models/join_origin_device.py +164 -0
- flywheel/models/join_origin_job.py +219 -0
- flywheel/models/join_origin_user.py +189 -0
- flywheel/models/join_origins.py +223 -0
- flywheel/models/join_type.py +28 -0
- flywheel/models/jupyterhub_workspace.py +163 -0
- flywheel/models/jupyterlab_server_modify.py +275 -0
- flywheel/models/jupyterlab_server_origin.py +25 -0
- flywheel/models/jupyterlab_server_output.py +25 -0
- flywheel/models/jupyterlab_server_response.py +415 -0
- flywheel/models/jupyterlab_server_update.py +25 -0
- flywheel/models/ldap_sync.py +36 -0
- flywheel/models/ldap_sync_config.py +163 -0
- flywheel/models/ldap_sync_input.py +36 -0
- flywheel/models/ldap_sync_status.py +250 -0
- flywheel/models/legacy_api_key_output.py +271 -0
- flywheel/models/legacy_input.py +244 -0
- flywheel/models/legacy_usage_report.py +309 -0
- flywheel/models/legacys_usage_project_entry.py +194 -0
- flywheel/models/libs_workflows_models_parent_type.py +33 -0
- flywheel/models/libs_workflows_models_task_status.py +32 -0
- flywheel/models/local_storage.py +217 -0
- flywheel/models/location.py +189 -0
- flywheel/models/locked.py +219 -0
- flywheel/models/master_subject_code_dob_input.py +279 -0
- flywheel/models/master_subject_code_input.py +281 -0
- flywheel/models/master_subject_code_output.py +166 -0
- flywheel/models/matched_acquisition_output.py +518 -0
- flywheel/models/mfa_channel.py +30 -0
- flywheel/models/mfa_settings.py +167 -0
- flywheel/models/mixins.py +794 -0
- flywheel/models/ml_set_filter.py +194 -0
- flywheel/models/ml_type.py +30 -0
- flywheel/models/modality.py +250 -0
- flywheel/models/modality_input.py +244 -0
- flywheel/models/modality_modify.py +218 -0
- flywheel/models/modality_output.py +271 -0
- flywheel/models/modified_result.py +190 -0
- flywheel/models/modify_user_input.py +466 -0
- flywheel/models/move_conflict.py +300 -0
- flywheel/models/note.py +391 -0
- flywheel/models/note_input.py +165 -0
- flywheel/models/optional_input_policy.py +30 -0
- flywheel/models/order.py +29 -0
- flywheel/models/organ_system.py +64 -0
- flywheel/models/origin.py +193 -0
- flywheel/models/origin_type.py +35 -0
- flywheel/models/orphaned_count.py +163 -0
- flywheel/models/output_user_page.py +219 -0
- flywheel/models/packfile_cleanup_output.py +166 -0
- flywheel/models/packfile_removed_output.py +189 -0
- flywheel/models/page.py +216 -0
- flywheel/models/page_generic_file_output.py +219 -0
- flywheel/models/page_generic_filter.py +219 -0
- flywheel/models/page_generic_form_response_output.py +219 -0
- flywheel/models/page_generic_protocol.py +244 -0
- flywheel/models/page_generic_reader_task_output.py +244 -0
- flywheel/models/page_generic_staffing_pool.py +244 -0
- flywheel/models/parsed_query_response.py +194 -0
- flywheel/models/permission_access_permission.py +25 -0
- flywheel/models/premade_jobs_batch_job_output.py +298 -0
- flywheel/models/premade_jobs_batch_job_output_inflated_jobs.py +299 -0
- flywheel/models/premade_jobs_batch_proposal.py +334 -0
- flywheel/models/premade_jobs_batch_proposal_detail.py +166 -0
- flywheel/models/premade_jobs_batch_proposal_input.py +166 -0
- flywheel/models/project.py +25 -0
- flywheel/models/project_acquisition_upsert_input.py +25 -0
- flywheel/models/project_acquisition_upsert_output.py +25 -0
- flywheel/models/project_aet.py +331 -0
- flywheel/models/project_aet_input.py +248 -0
- flywheel/models/project_catalog_list_output.py +25 -0
- flywheel/models/project_contact.py +194 -0
- flywheel/models/project_container_output.py +41 -0
- flywheel/models/project_copy_input.py +245 -0
- flywheel/models/project_copy_output.py +215 -0
- flywheel/models/project_counters.py +346 -0
- flywheel/models/project_hierarchy_input.py +278 -0
- flywheel/models/project_hierarchy_output.py +222 -0
- flywheel/models/project_hierarchy_upsert_input.py +25 -0
- flywheel/models/project_hierarchy_upsert_output.py +25 -0
- flywheel/models/project_input.py +384 -0
- flywheel/models/project_institution.py +194 -0
- flywheel/models/project_list_output.py +897 -0
- flywheel/models/project_locking_reason.py +32 -0
- flywheel/models/project_modify.py +413 -0
- flywheel/models/project_node.py +42 -0
- flywheel/models/project_output.py +899 -0
- flywheel/models/project_parents.py +168 -0
- flywheel/models/project_report.py +463 -0
- flywheel/models/project_report_list.py +167 -0
- flywheel/models/project_session_upsert_input.py +25 -0
- flywheel/models/project_session_upsert_output.py +25 -0
- flywheel/models/project_settings_input.py +333 -0
- flywheel/models/project_settings_output.py +333 -0
- flywheel/models/project_settings_sharing.py +327 -0
- flywheel/models/project_settings_sharing_input.py +334 -0
- flywheel/models/project_settings_workspaces.py +167 -0
- flywheel/models/project_settings_workspaces_input.py +167 -0
- flywheel/models/project_share_level.py +29 -0
- flywheel/models/project_sharing_settings_project_contact.py +25 -0
- flywheel/models/project_sharing_settings_project_counters.py +36 -0
- flywheel/models/project_sharing_settings_project_institution.py +25 -0
- flywheel/models/project_sharing_settings_project_settings_input.py +25 -0
- flywheel/models/project_sharing_settings_project_settings_output.py +25 -0
- flywheel/models/project_sharing_settings_project_settings_sharing.py +25 -0
- flywheel/models/project_sharing_settings_project_settings_sharing_input.py +25 -0
- flywheel/models/project_sharing_settings_project_stats.py +36 -0
- flywheel/models/project_stats.py +270 -0
- flywheel/models/project_subject_upsert_input.py +25 -0
- flywheel/models/project_subject_upsert_output.py +25 -0
- flywheel/models/project_template.py +195 -0
- flywheel/models/project_template_input.py +195 -0
- flywheel/models/project_template_list_input.py +166 -0
- flywheel/models/project_template_requirement.py +36 -0
- flywheel/models/project_template_session_template.py +36 -0
- flywheel/models/project_upsert_origin.py +36 -0
- flywheel/models/protocol.py +515 -0
- flywheel/models/protocol_e_signature_config.py +191 -0
- flywheel/models/protocol_input.py +354 -0
- flywheel/models/protocol_modify.py +277 -0
- flywheel/models/protocol_status.py +30 -0
- flywheel/models/provider.py +461 -0
- flywheel/models/provider_access_type.py +29 -0
- flywheel/models/provider_class.py +29 -0
- flywheel/models/provider_deletion_status.py +189 -0
- flywheel/models/provider_input.py +25 -0
- flywheel/models/provider_links.py +282 -0
- flywheel/models/provider_type.py +34 -0
- flywheel/models/providers.py +277 -0
- flywheel/models/reader_batch_create.py +463 -0
- flywheel/models/reader_task.py +725 -0
- flywheel/models/reader_task_config.py +189 -0
- flywheel/models/reader_task_create.py +543 -0
- flywheel/models/reader_task_modify.py +303 -0
- flywheel/models/reader_task_output.py +752 -0
- flywheel/models/reader_task_parent_details.py +322 -0
- flywheel/models/report_access_log_context.py +301 -0
- flywheel/models/report_access_log_context_entry.py +194 -0
- flywheel/models/report_access_log_context_file_entry.py +165 -0
- flywheel/models/report_access_log_entry.py +624 -0
- flywheel/models/report_access_log_origin.py +194 -0
- flywheel/models/report_availability_list.py +167 -0
- flywheel/models/report_daily_usage_entry.py +501 -0
- flywheel/models/report_demographics_grid.py +36 -0
- flywheel/models/report_ethnicity_grid.py +252 -0
- flywheel/models/report_gender_count.py +222 -0
- flywheel/models/report_group_report.py +217 -0
- flywheel/models/report_legacy_usage_entry.py +36 -0
- flywheel/models/report_legacy_usage_project_entry.py +36 -0
- flywheel/models/report_project.py +25 -0
- flywheel/models/report_site.py +192 -0
- flywheel/models/report_time_period.py +193 -0
- flywheel/models/report_usage.py +630 -0
- flywheel/models/report_usage_entry.py +25 -0
- flywheel/models/resolve_input.py +163 -0
- flywheel/models/resolve_output.py +194 -0
- flywheel/models/resolver_acquisition_node.py +36 -0
- flywheel/models/resolver_analysis_node.py +36 -0
- flywheel/models/resolver_file_node.py +36 -0
- flywheel/models/resolver_gear_node.py +36 -0
- flywheel/models/resolver_group_node.py +36 -0
- flywheel/models/resolver_input.py +25 -0
- flywheel/models/resolver_node.py +182 -0
- flywheel/models/resolver_output.py +25 -0
- flywheel/models/resolver_project_node.py +36 -0
- flywheel/models/resolver_session_node.py +36 -0
- flywheel/models/resolver_subject_node.py +36 -0
- flywheel/models/role_input.py +192 -0
- flywheel/models/role_output.py +273 -0
- flywheel/models/role_permission.py +194 -0
- flywheel/models/role_permission_output.py +189 -0
- flywheel/models/role_permission_update.py +163 -0
- flywheel/models/role_type.py +32 -0
- flywheel/models/role_update.py +194 -0
- flywheel/models/roles_backwards_compatible_role_assignment.py +36 -0
- flywheel/models/roles_group_role_pool_input.py +36 -0
- flywheel/models/roles_role.py +36 -0
- flywheel/models/roles_role_assignment.py +195 -0
- flywheel/models/roles_role_input.py +36 -0
- flywheel/models/rule.py +467 -0
- flywheel/models/rule_any.py +216 -0
- flywheel/models/s3_addressing_style.py +29 -0
- flywheel/models/s3_compat_storage.py +381 -0
- flywheel/models/save_search.py +298 -0
- flywheel/models/save_search_input.py +219 -0
- flywheel/models/save_search_output.py +301 -0
- flywheel/models/save_search_page.py +219 -0
- flywheel/models/save_search_parent.py +192 -0
- flywheel/models/save_search_update.py +194 -0
- flywheel/models/search_acquisition_response.py +252 -0
- flywheel/models/search_analysis_response.py +254 -0
- flywheel/models/search_collection_response.py +254 -0
- flywheel/models/search_file_response.py +312 -0
- flywheel/models/search_group_response.py +196 -0
- flywheel/models/search_parent_acquisition.py +47 -0
- flywheel/models/search_parent_analysis.py +47 -0
- flywheel/models/search_parent_collection.py +46 -0
- flywheel/models/search_parent_project.py +54 -0
- flywheel/models/search_parent_response.py +213 -0
- flywheel/models/search_parent_session.py +48 -0
- flywheel/models/search_parent_subject.py +48 -0
- flywheel/models/search_parse_error.py +252 -0
- flywheel/models/search_parse_search_query_result.py +36 -0
- flywheel/models/search_project_response.py +196 -0
- flywheel/models/search_query.py +337 -0
- flywheel/models/search_query_suggestions.py +36 -0
- flywheel/models/search_response.py +448 -0
- flywheel/models/search_return_type.py +33 -0
- flywheel/models/search_save_search.py +36 -0
- flywheel/models/search_save_search_input.py +36 -0
- flywheel/models/search_save_search_parent.py +36 -0
- flywheel/models/search_save_search_update.py +36 -0
- flywheel/models/search_session_response.py +252 -0
- flywheel/models/search_status.py +166 -0
- flywheel/models/search_structured_search_query.py +25 -0
- flywheel/models/search_subject_response.py +225 -0
- flywheel/models/search_suggestion.py +36 -0
- flywheel/models/select_item.py +190 -0
- flywheel/models/server_state.py +303 -0
- flywheel/models/service_aet.py +301 -0
- flywheel/models/service_aet_input.py +276 -0
- flywheel/models/session.py +25 -0
- flywheel/models/session_container_output.py +35 -0
- flywheel/models/session_copy_input.py +253 -0
- flywheel/models/session_embedded_subject.py +299 -0
- flywheel/models/session_input.py +431 -0
- flywheel/models/session_list_output.py +897 -0
- flywheel/models/session_metadata_input.py +36 -0
- flywheel/models/session_modify.py +464 -0
- flywheel/models/session_node.py +36 -0
- flywheel/models/session_output.py +897 -0
- flywheel/models/session_parents.py +220 -0
- flywheel/models/session_template_options.py +221 -0
- flywheel/models/session_template_recalc_output.py +165 -0
- flywheel/models/session_upsert_input.py +464 -0
- flywheel/models/session_upsert_output.py +243 -0
- flywheel/models/sharing_filter_options.py +345 -0
- flywheel/models/signed_fs_upload_output.py +189 -0
- flywheel/models/signed_url_cleanup_input.py +189 -0
- flywheel/models/signed_url_upload_input.py +190 -0
- flywheel/models/signed_url_upload_output.py +349 -0
- flywheel/models/site.py +623 -0
- flywheel/models/site_report.py +194 -0
- flywheel/models/site_settings.py +385 -0
- flywheel/models/sort.py +192 -0
- flywheel/models/stable_api_key_input.py +25 -0
- flywheel/models/staffing_pool.py +324 -0
- flywheel/models/staffing_pool_create.py +216 -0
- flywheel/models/staffing_pool_list.py +164 -0
- flywheel/models/staffing_pool_modify.py +218 -0
- flywheel/models/state.py +32 -0
- flywheel/models/static_compute.py +218 -0
- flywheel/models/status_transitions.py +245 -0
- flywheel/models/status_type.py +31 -0
- flywheel/models/status_value.py +31 -0
- flywheel/models/storage_strategy.py +30 -0
- flywheel/models/storage_strategy_config.py +194 -0
- flywheel/models/structured_query.py +165 -0
- flywheel/models/structured_query_suggestions.py +196 -0
- flywheel/models/structured_query_value_suggestion.py +247 -0
- flywheel/models/subject.py +34 -0
- flywheel/models/subject_container_output.py +36 -0
- flywheel/models/subject_copy_input.py +223 -0
- flywheel/models/subject_input.py +627 -0
- flywheel/models/subject_modify.py +684 -0
- flywheel/models/subject_node.py +37 -0
- flywheel/models/subject_output.py +1008 -0
- flywheel/models/subject_output_for_list.py +1005 -0
- flywheel/models/subject_parents.py +194 -0
- flywheel/models/subject_role_permission.py +194 -0
- flywheel/models/subject_state.py +30 -0
- flywheel/models/subject_template_options.py +191 -0
- flywheel/models/subject_upsert_input.py +573 -0
- flywheel/models/subject_upsert_output.py +216 -0
- flywheel/models/sync_user_input.py +322 -0
- flywheel/models/tag.py +165 -0
- flywheel/models/task_assign.py +194 -0
- flywheel/models/task_facet.py +29 -0
- flywheel/models/task_parent_ref.py +245 -0
- flywheel/models/task_parent_ref_input.py +219 -0
- flywheel/models/task_priority.py +31 -0
- flywheel/models/task_submission.py +189 -0
- flywheel/models/therapeutic_area.py +60 -0
- flywheel/models/transitions.py +272 -0
- flywheel/models/tree_container_request_spec.py +281 -0
- flywheel/models/tree_graph.py +142 -0
- flywheel/models/tree_graph_connection.py +244 -0
- flywheel/models/tree_graph_connections.py +142 -0
- flywheel/models/tree_graph_node.py +166 -0
- flywheel/models/tree_request.py +25 -0
- flywheel/models/tree_response_item.py +142 -0
- flywheel/models/type_str.py +31 -0
- flywheel/models/uid_check_input_acquisitions.py +244 -0
- flywheel/models/uid_check_input_sessions.py +244 -0
- flywheel/models/uid_check_output.py +191 -0
- flywheel/models/upload_complete_s3_multipart_input.py +25 -0
- flywheel/models/upload_complete_s3_multipart_output.py +25 -0
- flywheel/models/upload_signed_fs_file_upload_output.py +36 -0
- flywheel/models/upload_signed_upload_url_input.py +36 -0
- flywheel/models/upload_signed_upload_url_output.py +36 -0
- flywheel/models/upload_ticket_output.py +215 -0
- flywheel/models/upload_token_output.py +163 -0
- flywheel/models/upsert_result.py +31 -0
- flywheel/models/user.py +760 -0
- flywheel/models/user_api_key.py +220 -0
- flywheel/models/user_input.py +461 -0
- flywheel/models/user_jobs.py +219 -0
- flywheel/models/user_jobs_output.py +25 -0
- flywheel/models/user_output.py +36 -0
- flywheel/models/user_output_id.py +163 -0
- flywheel/models/user_preferences.py +135 -0
- flywheel/models/user_wechat.py +135 -0
- flywheel/models/validation_error.py +215 -0
- flywheel/models/validation_rule.py +190 -0
- flywheel/models/version.py +363 -0
- flywheel/models/version_output.py +25 -0
- flywheel/models/view_id_output.py +164 -0
- flywheel/models/view_output.py +440 -0
- flywheel/models/viewer_app.py +381 -0
- flywheel/models/viewer_app_input.py +382 -0
- flywheel/models/viewer_app_type.py +29 -0
- flywheel/models/virus_scan.py +166 -0
- flywheel/models/virus_scan_state.py +30 -0
- flywheel/models/work_in_progress_features.py +135 -0
- flywheel/models/zipfile_info.py +192 -0
- flywheel/models/zipfile_member_info.py +241 -0
- flywheel/partial_reader.py +50 -0
- flywheel/rest.py +352 -0
- flywheel/util.py +95 -0
- flywheel/view_builder.py +449 -0
- flywheel_sdk-21.2.0rc0.dist-info/METADATA +41 -0
- flywheel_sdk-21.2.0rc0.dist-info/RECORD +772 -0
- flywheel_sdk-21.2.0rc0.dist-info/WHEEL +4 -0
- flywheel_sdk-21.2.0rc0.dist-info/licenses/LICENSE.txt +18 -0
|
@@ -0,0 +1,4784 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Flywheel
|
|
5
|
+
|
|
6
|
+
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
|
|
7
|
+
|
|
8
|
+
OpenAPI spec version: 0.0.1
|
|
9
|
+
|
|
10
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
from __future__ import absolute_import
|
|
15
|
+
|
|
16
|
+
import re # noqa: F401
|
|
17
|
+
|
|
18
|
+
# python 2 and python 3 compatibility library
|
|
19
|
+
import six
|
|
20
|
+
|
|
21
|
+
from flywheel.api_client import ApiClient
|
|
22
|
+
import flywheel.models
|
|
23
|
+
from flywheel.util import check_filename_params
|
|
24
|
+
|
|
25
|
+
# NOTE: This file is auto generated by the swagger code generator program.
|
|
26
|
+
# Do not edit the class manually.
|
|
27
|
+
|
|
28
|
+
class ContainersApi(object):
|
|
29
|
+
def __init__(self, api_client=None):
|
|
30
|
+
if api_client is None:
|
|
31
|
+
api_client = ApiClient()
|
|
32
|
+
self.api_client = api_client
|
|
33
|
+
|
|
34
|
+
def add_container_analysis(self, cid, body, **kwargs): # noqa: E501
|
|
35
|
+
"""Create an analysis and upload files.
|
|
36
|
+
|
|
37
|
+
When query param \"job\" is \"true\", send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.
|
|
38
|
+
This method makes a synchronous HTTP request by default.
|
|
39
|
+
|
|
40
|
+
:param str cid: (required)
|
|
41
|
+
:param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
|
|
42
|
+
:param bool job: returns job_id instead of analysis.id
|
|
43
|
+
:param bool job: returns job_id instead of analysis.id
|
|
44
|
+
:param bool async_: Perform the request asynchronously
|
|
45
|
+
:return: InsertedId
|
|
46
|
+
"""
|
|
47
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
48
|
+
kwargs['_return_http_data_only'] = True
|
|
49
|
+
|
|
50
|
+
if kwargs.get('async_'):
|
|
51
|
+
return self.add_container_analysis_with_http_info(cid, body, **kwargs) # noqa: E501
|
|
52
|
+
else:
|
|
53
|
+
(data) = self.add_container_analysis_with_http_info(cid, body, **kwargs) # noqa: E501
|
|
54
|
+
if (
|
|
55
|
+
data
|
|
56
|
+
and hasattr(data, 'return_value')
|
|
57
|
+
and not ignore_simplified_return_value
|
|
58
|
+
):
|
|
59
|
+
return data.return_value()
|
|
60
|
+
return data
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
def add_container_analysis_with_http_info(self, cid, body, **kwargs): # noqa: E501
|
|
64
|
+
"""Create an analysis and upload files.
|
|
65
|
+
|
|
66
|
+
When query param \"job\" is \"true\", send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.
|
|
67
|
+
This method makes a synchronous HTTP request by default.
|
|
68
|
+
|
|
69
|
+
:param str cid: (required)
|
|
70
|
+
:param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
|
|
71
|
+
:param bool job: returns job_id instead of analysis.id
|
|
72
|
+
:param bool job: returns job_id instead of analysis.id
|
|
73
|
+
:param bool async_: Perform the request asynchronously
|
|
74
|
+
:return: InsertedId
|
|
75
|
+
"""
|
|
76
|
+
|
|
77
|
+
all_params = ['cid','body','job','job',] # noqa: E501
|
|
78
|
+
all_params.append('async_')
|
|
79
|
+
all_params.append('_return_http_data_only')
|
|
80
|
+
all_params.append('_preload_content')
|
|
81
|
+
all_params.append('_request_timeout')
|
|
82
|
+
all_params.append('_request_out')
|
|
83
|
+
|
|
84
|
+
params = locals()
|
|
85
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
86
|
+
if key not in all_params:
|
|
87
|
+
raise TypeError(
|
|
88
|
+
"Got an unexpected keyword argument '%s'"
|
|
89
|
+
" to method add_container_analysis" % key
|
|
90
|
+
)
|
|
91
|
+
params[key] = val
|
|
92
|
+
del params['kwargs']
|
|
93
|
+
# verify the required parameter 'cid' is set
|
|
94
|
+
if ('cid' not in params or
|
|
95
|
+
params['cid'] is None):
|
|
96
|
+
raise ValueError("Missing the required parameter `cid` when calling `add_container_analysis`") # noqa: E501
|
|
97
|
+
# verify the required parameter 'body' is set
|
|
98
|
+
if ('body' not in params or
|
|
99
|
+
params['body'] is None):
|
|
100
|
+
raise ValueError("Missing the required parameter `body` when calling `add_container_analysis`") # noqa: E501
|
|
101
|
+
check_filename_params(params)
|
|
102
|
+
|
|
103
|
+
collection_formats = {}
|
|
104
|
+
|
|
105
|
+
path_params = {}
|
|
106
|
+
if 'cid' in params:
|
|
107
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
108
|
+
|
|
109
|
+
query_params = []
|
|
110
|
+
if 'job' in params:
|
|
111
|
+
query_params.append(('job', params['job'])) # noqa: E501
|
|
112
|
+
if 'job' in params:
|
|
113
|
+
query_params.append(('job', params['job'])) # noqa: E501
|
|
114
|
+
else:
|
|
115
|
+
query_params.append(('job', 'true'))
|
|
116
|
+
|
|
117
|
+
header_params = {}
|
|
118
|
+
|
|
119
|
+
form_params = []
|
|
120
|
+
local_var_files = {}
|
|
121
|
+
|
|
122
|
+
body_params = None
|
|
123
|
+
if 'body' in params:
|
|
124
|
+
if 'union[AdhocAnalysisInput,JobAnalysisInput]'.startswith('union'):
|
|
125
|
+
body_type = type(params['body'])
|
|
126
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
127
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
128
|
+
else:
|
|
129
|
+
body_params = params['body']
|
|
130
|
+
else:
|
|
131
|
+
body_params = flywheel.models.union[AdhocAnalysisInput,JobAnalysisInput].positional_to_model(params['body'])
|
|
132
|
+
# HTTP header `Accept`
|
|
133
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
134
|
+
['application/json']) # noqa: E501
|
|
135
|
+
|
|
136
|
+
# HTTP header `Content-Type`
|
|
137
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
138
|
+
['application/json']) # noqa: E501
|
|
139
|
+
|
|
140
|
+
# Authentication setting
|
|
141
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
142
|
+
|
|
143
|
+
return self.api_client.call_api(
|
|
144
|
+
'/containers/{cid}/analyses', 'POST',
|
|
145
|
+
path_params,
|
|
146
|
+
query_params,
|
|
147
|
+
header_params,
|
|
148
|
+
body=body_params,
|
|
149
|
+
post_params=form_params,
|
|
150
|
+
files=local_var_files,
|
|
151
|
+
response_type='InsertedId', # noqa: E501
|
|
152
|
+
auth_settings=auth_settings,
|
|
153
|
+
async_=params.get('async_'),
|
|
154
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
155
|
+
_preload_content=params.get('_preload_content', True),
|
|
156
|
+
_request_timeout=params.get('_request_timeout'),
|
|
157
|
+
_request_out=params.get('_request_out'),
|
|
158
|
+
collection_formats=collection_formats)
|
|
159
|
+
|
|
160
|
+
def add_container_analysis_note(self, container_id, analysis_id, body, **kwargs): # noqa: E501
|
|
161
|
+
"""Add a note to a(n) container analysis.
|
|
162
|
+
|
|
163
|
+
Add a note to a(n) container analysis.
|
|
164
|
+
This method makes a synchronous HTTP request by default.
|
|
165
|
+
|
|
166
|
+
:param str container_id: 24-char hex id (required)
|
|
167
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
168
|
+
:param NoteInput body: (required)
|
|
169
|
+
:param bool async_: Perform the request asynchronously
|
|
170
|
+
:return: Note
|
|
171
|
+
"""
|
|
172
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
173
|
+
kwargs['_return_http_data_only'] = True
|
|
174
|
+
|
|
175
|
+
if kwargs.get('async_'):
|
|
176
|
+
return self.add_container_analysis_note_with_http_info(container_id, analysis_id, body, **kwargs) # noqa: E501
|
|
177
|
+
else:
|
|
178
|
+
(data) = self.add_container_analysis_note_with_http_info(container_id, analysis_id, body, **kwargs) # noqa: E501
|
|
179
|
+
if (
|
|
180
|
+
data
|
|
181
|
+
and hasattr(data, 'return_value')
|
|
182
|
+
and not ignore_simplified_return_value
|
|
183
|
+
):
|
|
184
|
+
return data.return_value()
|
|
185
|
+
return data
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
def add_container_analysis_note_with_http_info(self, container_id, analysis_id, body, **kwargs): # noqa: E501
|
|
189
|
+
"""Add a note to a(n) container analysis.
|
|
190
|
+
|
|
191
|
+
Add a note to a(n) container analysis.
|
|
192
|
+
This method makes a synchronous HTTP request by default.
|
|
193
|
+
|
|
194
|
+
:param str container_id: 24-char hex id (required)
|
|
195
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
196
|
+
:param NoteInput body: (required)
|
|
197
|
+
:param bool async_: Perform the request asynchronously
|
|
198
|
+
:return: Note
|
|
199
|
+
"""
|
|
200
|
+
|
|
201
|
+
all_params = ['container_id','analysis_id','body',] # noqa: E501
|
|
202
|
+
all_params.append('async_')
|
|
203
|
+
all_params.append('_return_http_data_only')
|
|
204
|
+
all_params.append('_preload_content')
|
|
205
|
+
all_params.append('_request_timeout')
|
|
206
|
+
all_params.append('_request_out')
|
|
207
|
+
|
|
208
|
+
params = locals()
|
|
209
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
210
|
+
if key not in all_params:
|
|
211
|
+
raise TypeError(
|
|
212
|
+
"Got an unexpected keyword argument '%s'"
|
|
213
|
+
" to method add_container_analysis_note" % key
|
|
214
|
+
)
|
|
215
|
+
params[key] = val
|
|
216
|
+
del params['kwargs']
|
|
217
|
+
# verify the required parameter 'container_id' is set
|
|
218
|
+
if ('container_id' not in params or
|
|
219
|
+
params['container_id'] is None):
|
|
220
|
+
raise ValueError("Missing the required parameter `container_id` when calling `add_container_analysis_note`") # noqa: E501
|
|
221
|
+
# verify the required parameter 'analysis_id' is set
|
|
222
|
+
if ('analysis_id' not in params or
|
|
223
|
+
params['analysis_id'] is None):
|
|
224
|
+
raise ValueError("Missing the required parameter `analysis_id` when calling `add_container_analysis_note`") # noqa: E501
|
|
225
|
+
# verify the required parameter 'body' is set
|
|
226
|
+
if ('body' not in params or
|
|
227
|
+
params['body'] is None):
|
|
228
|
+
raise ValueError("Missing the required parameter `body` when calling `add_container_analysis_note`") # noqa: E501
|
|
229
|
+
check_filename_params(params)
|
|
230
|
+
|
|
231
|
+
collection_formats = {}
|
|
232
|
+
|
|
233
|
+
path_params = {}
|
|
234
|
+
if 'container_id' in params:
|
|
235
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
236
|
+
if 'analysis_id' in params:
|
|
237
|
+
path_params['analysis_id'] = params['analysis_id'] # noqa: E501
|
|
238
|
+
|
|
239
|
+
query_params = []
|
|
240
|
+
|
|
241
|
+
header_params = {}
|
|
242
|
+
|
|
243
|
+
form_params = []
|
|
244
|
+
local_var_files = {}
|
|
245
|
+
|
|
246
|
+
body_params = None
|
|
247
|
+
if 'body' in params:
|
|
248
|
+
if 'NoteInput'.startswith('union'):
|
|
249
|
+
body_type = type(params['body'])
|
|
250
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
251
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
252
|
+
else:
|
|
253
|
+
body_params = params['body']
|
|
254
|
+
else:
|
|
255
|
+
body_params = flywheel.models.NoteInput.positional_to_model(params['body'])
|
|
256
|
+
# HTTP header `Accept`
|
|
257
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
258
|
+
['application/json']) # noqa: E501
|
|
259
|
+
|
|
260
|
+
# HTTP header `Content-Type`
|
|
261
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
262
|
+
['application/json']) # noqa: E501
|
|
263
|
+
|
|
264
|
+
# Authentication setting
|
|
265
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
266
|
+
|
|
267
|
+
return self.api_client.call_api(
|
|
268
|
+
'/containers/{container_id}/analyses/{analysis_id}/notes', 'POST',
|
|
269
|
+
path_params,
|
|
270
|
+
query_params,
|
|
271
|
+
header_params,
|
|
272
|
+
body=body_params,
|
|
273
|
+
post_params=form_params,
|
|
274
|
+
files=local_var_files,
|
|
275
|
+
response_type='Note', # noqa: E501
|
|
276
|
+
auth_settings=auth_settings,
|
|
277
|
+
async_=params.get('async_'),
|
|
278
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
279
|
+
_preload_content=params.get('_preload_content', True),
|
|
280
|
+
_request_timeout=params.get('_request_timeout'),
|
|
281
|
+
_request_out=params.get('_request_out'),
|
|
282
|
+
collection_formats=collection_formats)
|
|
283
|
+
|
|
284
|
+
def add_container_note(self, container_id, body, **kwargs): # noqa: E501
|
|
285
|
+
"""Add a note to a(n) container.
|
|
286
|
+
|
|
287
|
+
Add a note to a(n) container.
|
|
288
|
+
This method makes a synchronous HTTP request by default.
|
|
289
|
+
|
|
290
|
+
:param str container_id: (required)
|
|
291
|
+
:param NoteInput body: (required)
|
|
292
|
+
:param bool async_: Perform the request asynchronously
|
|
293
|
+
:return: Note
|
|
294
|
+
"""
|
|
295
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
296
|
+
kwargs['_return_http_data_only'] = True
|
|
297
|
+
|
|
298
|
+
if kwargs.get('async_'):
|
|
299
|
+
return self.add_container_note_with_http_info(container_id, body, **kwargs) # noqa: E501
|
|
300
|
+
else:
|
|
301
|
+
(data) = self.add_container_note_with_http_info(container_id, body, **kwargs) # noqa: E501
|
|
302
|
+
if (
|
|
303
|
+
data
|
|
304
|
+
and hasattr(data, 'return_value')
|
|
305
|
+
and not ignore_simplified_return_value
|
|
306
|
+
):
|
|
307
|
+
return data.return_value()
|
|
308
|
+
return data
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
def add_container_note_with_http_info(self, container_id, body, **kwargs): # noqa: E501
|
|
312
|
+
"""Add a note to a(n) container.
|
|
313
|
+
|
|
314
|
+
Add a note to a(n) container.
|
|
315
|
+
This method makes a synchronous HTTP request by default.
|
|
316
|
+
|
|
317
|
+
:param str container_id: (required)
|
|
318
|
+
:param NoteInput body: (required)
|
|
319
|
+
:param bool async_: Perform the request asynchronously
|
|
320
|
+
:return: Note
|
|
321
|
+
"""
|
|
322
|
+
|
|
323
|
+
all_params = ['container_id','body',] # noqa: E501
|
|
324
|
+
all_params.append('async_')
|
|
325
|
+
all_params.append('_return_http_data_only')
|
|
326
|
+
all_params.append('_preload_content')
|
|
327
|
+
all_params.append('_request_timeout')
|
|
328
|
+
all_params.append('_request_out')
|
|
329
|
+
|
|
330
|
+
params = locals()
|
|
331
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
332
|
+
if key not in all_params:
|
|
333
|
+
raise TypeError(
|
|
334
|
+
"Got an unexpected keyword argument '%s'"
|
|
335
|
+
" to method add_container_note" % key
|
|
336
|
+
)
|
|
337
|
+
params[key] = val
|
|
338
|
+
del params['kwargs']
|
|
339
|
+
# verify the required parameter 'container_id' is set
|
|
340
|
+
if ('container_id' not in params or
|
|
341
|
+
params['container_id'] is None):
|
|
342
|
+
raise ValueError("Missing the required parameter `container_id` when calling `add_container_note`") # noqa: E501
|
|
343
|
+
# verify the required parameter 'body' is set
|
|
344
|
+
if ('body' not in params or
|
|
345
|
+
params['body'] is None):
|
|
346
|
+
raise ValueError("Missing the required parameter `body` when calling `add_container_note`") # noqa: E501
|
|
347
|
+
check_filename_params(params)
|
|
348
|
+
|
|
349
|
+
collection_formats = {}
|
|
350
|
+
|
|
351
|
+
path_params = {}
|
|
352
|
+
if 'container_id' in params:
|
|
353
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
354
|
+
|
|
355
|
+
query_params = []
|
|
356
|
+
|
|
357
|
+
header_params = {}
|
|
358
|
+
|
|
359
|
+
form_params = []
|
|
360
|
+
local_var_files = {}
|
|
361
|
+
|
|
362
|
+
body_params = None
|
|
363
|
+
if 'body' in params:
|
|
364
|
+
if 'NoteInput'.startswith('union'):
|
|
365
|
+
body_type = type(params['body'])
|
|
366
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
367
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
368
|
+
else:
|
|
369
|
+
body_params = params['body']
|
|
370
|
+
else:
|
|
371
|
+
body_params = flywheel.models.NoteInput.positional_to_model(params['body'])
|
|
372
|
+
# HTTP header `Accept`
|
|
373
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
374
|
+
['application/json']) # noqa: E501
|
|
375
|
+
|
|
376
|
+
# HTTP header `Content-Type`
|
|
377
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
378
|
+
['application/json']) # noqa: E501
|
|
379
|
+
|
|
380
|
+
# Authentication setting
|
|
381
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
382
|
+
|
|
383
|
+
return self.api_client.call_api(
|
|
384
|
+
'/containers/{container_id}/notes', 'POST',
|
|
385
|
+
path_params,
|
|
386
|
+
query_params,
|
|
387
|
+
header_params,
|
|
388
|
+
body=body_params,
|
|
389
|
+
post_params=form_params,
|
|
390
|
+
files=local_var_files,
|
|
391
|
+
response_type='Note', # noqa: E501
|
|
392
|
+
auth_settings=auth_settings,
|
|
393
|
+
async_=params.get('async_'),
|
|
394
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
395
|
+
_preload_content=params.get('_preload_content', True),
|
|
396
|
+
_request_timeout=params.get('_request_timeout'),
|
|
397
|
+
_request_out=params.get('_request_out'),
|
|
398
|
+
collection_formats=collection_formats)
|
|
399
|
+
|
|
400
|
+
def add_container_tag(self, cid, body, **kwargs): # noqa: E501
|
|
401
|
+
"""Add a tag to a(n) container.
|
|
402
|
+
|
|
403
|
+
Propagates changes to projects, sessions and acquisitions
|
|
404
|
+
This method makes a synchronous HTTP request by default.
|
|
405
|
+
|
|
406
|
+
:param str cid: (required)
|
|
407
|
+
:param Tag body: (required)
|
|
408
|
+
:param bool async_: Perform the request asynchronously
|
|
409
|
+
:return: ModifiedResult
|
|
410
|
+
"""
|
|
411
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
412
|
+
kwargs['_return_http_data_only'] = True
|
|
413
|
+
|
|
414
|
+
if kwargs.get('async_'):
|
|
415
|
+
return self.add_container_tag_with_http_info(cid, body, **kwargs) # noqa: E501
|
|
416
|
+
else:
|
|
417
|
+
(data) = self.add_container_tag_with_http_info(cid, body, **kwargs) # noqa: E501
|
|
418
|
+
if (
|
|
419
|
+
data
|
|
420
|
+
and hasattr(data, 'return_value')
|
|
421
|
+
and not ignore_simplified_return_value
|
|
422
|
+
):
|
|
423
|
+
return data.return_value()
|
|
424
|
+
return data
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
def add_container_tag_with_http_info(self, cid, body, **kwargs): # noqa: E501
|
|
428
|
+
"""Add a tag to a(n) container.
|
|
429
|
+
|
|
430
|
+
Propagates changes to projects, sessions and acquisitions
|
|
431
|
+
This method makes a synchronous HTTP request by default.
|
|
432
|
+
|
|
433
|
+
:param str cid: (required)
|
|
434
|
+
:param Tag body: (required)
|
|
435
|
+
:param bool async_: Perform the request asynchronously
|
|
436
|
+
:return: ModifiedResult
|
|
437
|
+
"""
|
|
438
|
+
|
|
439
|
+
all_params = ['cid','body',] # noqa: E501
|
|
440
|
+
all_params.append('async_')
|
|
441
|
+
all_params.append('_return_http_data_only')
|
|
442
|
+
all_params.append('_preload_content')
|
|
443
|
+
all_params.append('_request_timeout')
|
|
444
|
+
all_params.append('_request_out')
|
|
445
|
+
|
|
446
|
+
params = locals()
|
|
447
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
448
|
+
if key not in all_params:
|
|
449
|
+
raise TypeError(
|
|
450
|
+
"Got an unexpected keyword argument '%s'"
|
|
451
|
+
" to method add_container_tag" % key
|
|
452
|
+
)
|
|
453
|
+
params[key] = val
|
|
454
|
+
del params['kwargs']
|
|
455
|
+
# verify the required parameter 'cid' is set
|
|
456
|
+
if ('cid' not in params or
|
|
457
|
+
params['cid'] is None):
|
|
458
|
+
raise ValueError("Missing the required parameter `cid` when calling `add_container_tag`") # noqa: E501
|
|
459
|
+
# verify the required parameter 'body' is set
|
|
460
|
+
if ('body' not in params or
|
|
461
|
+
params['body'] is None):
|
|
462
|
+
raise ValueError("Missing the required parameter `body` when calling `add_container_tag`") # noqa: E501
|
|
463
|
+
check_filename_params(params)
|
|
464
|
+
|
|
465
|
+
collection_formats = {}
|
|
466
|
+
|
|
467
|
+
path_params = {}
|
|
468
|
+
if 'cid' in params:
|
|
469
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
470
|
+
|
|
471
|
+
query_params = []
|
|
472
|
+
|
|
473
|
+
header_params = {}
|
|
474
|
+
|
|
475
|
+
form_params = []
|
|
476
|
+
local_var_files = {}
|
|
477
|
+
|
|
478
|
+
body_params = None
|
|
479
|
+
if 'body' in params:
|
|
480
|
+
if 'Tag'.startswith('union'):
|
|
481
|
+
body_type = type(params['body'])
|
|
482
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
483
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
484
|
+
else:
|
|
485
|
+
body_params = params['body']
|
|
486
|
+
else:
|
|
487
|
+
body_params = flywheel.models.Tag.positional_to_model(params['body'])
|
|
488
|
+
# HTTP header `Accept`
|
|
489
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
490
|
+
['application/json']) # noqa: E501
|
|
491
|
+
|
|
492
|
+
# HTTP header `Content-Type`
|
|
493
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
494
|
+
['application/json']) # noqa: E501
|
|
495
|
+
|
|
496
|
+
# Authentication setting
|
|
497
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
498
|
+
|
|
499
|
+
return self.api_client.call_api(
|
|
500
|
+
'/containers/{cid}/tags', 'POST',
|
|
501
|
+
path_params,
|
|
502
|
+
query_params,
|
|
503
|
+
header_params,
|
|
504
|
+
body=body_params,
|
|
505
|
+
post_params=form_params,
|
|
506
|
+
files=local_var_files,
|
|
507
|
+
response_type='ModifiedResult', # noqa: E501
|
|
508
|
+
auth_settings=auth_settings,
|
|
509
|
+
async_=params.get('async_'),
|
|
510
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
511
|
+
_preload_content=params.get('_preload_content', True),
|
|
512
|
+
_request_timeout=params.get('_request_timeout'),
|
|
513
|
+
_request_out=params.get('_request_out'),
|
|
514
|
+
collection_formats=collection_formats)
|
|
515
|
+
|
|
516
|
+
def add_container_tags(self, cid, body, **kwargs): # noqa: E501
|
|
517
|
+
"""Add multiple tags to a(n) container
|
|
518
|
+
|
|
519
|
+
Add multiple tags to a(n) container
|
|
520
|
+
This method makes a synchronous HTTP request by default.
|
|
521
|
+
|
|
522
|
+
:param str cid: (required)
|
|
523
|
+
:param list[str] body: (required)
|
|
524
|
+
:param bool async_: Perform the request asynchronously
|
|
525
|
+
:return: None
|
|
526
|
+
"""
|
|
527
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
528
|
+
kwargs['_return_http_data_only'] = True
|
|
529
|
+
|
|
530
|
+
if kwargs.get('async_'):
|
|
531
|
+
return self.add_container_tags_with_http_info(cid, body, **kwargs) # noqa: E501
|
|
532
|
+
else:
|
|
533
|
+
(data) = self.add_container_tags_with_http_info(cid, body, **kwargs) # noqa: E501
|
|
534
|
+
if (
|
|
535
|
+
data
|
|
536
|
+
and hasattr(data, 'return_value')
|
|
537
|
+
and not ignore_simplified_return_value
|
|
538
|
+
):
|
|
539
|
+
return data.return_value()
|
|
540
|
+
return data
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
def add_container_tags_with_http_info(self, cid, body, **kwargs): # noqa: E501
|
|
544
|
+
"""Add multiple tags to a(n) container
|
|
545
|
+
|
|
546
|
+
Add multiple tags to a(n) container
|
|
547
|
+
This method makes a synchronous HTTP request by default.
|
|
548
|
+
|
|
549
|
+
:param str cid: (required)
|
|
550
|
+
:param list[str] body: (required)
|
|
551
|
+
:param bool async_: Perform the request asynchronously
|
|
552
|
+
:return: None
|
|
553
|
+
"""
|
|
554
|
+
|
|
555
|
+
all_params = ['cid','body',] # noqa: E501
|
|
556
|
+
all_params.append('async_')
|
|
557
|
+
all_params.append('_return_http_data_only')
|
|
558
|
+
all_params.append('_preload_content')
|
|
559
|
+
all_params.append('_request_timeout')
|
|
560
|
+
all_params.append('_request_out')
|
|
561
|
+
|
|
562
|
+
params = locals()
|
|
563
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
564
|
+
if key not in all_params:
|
|
565
|
+
raise TypeError(
|
|
566
|
+
"Got an unexpected keyword argument '%s'"
|
|
567
|
+
" to method add_container_tags" % key
|
|
568
|
+
)
|
|
569
|
+
params[key] = val
|
|
570
|
+
del params['kwargs']
|
|
571
|
+
# verify the required parameter 'cid' is set
|
|
572
|
+
if ('cid' not in params or
|
|
573
|
+
params['cid'] is None):
|
|
574
|
+
raise ValueError("Missing the required parameter `cid` when calling `add_container_tags`") # noqa: E501
|
|
575
|
+
# verify the required parameter 'body' is set
|
|
576
|
+
if ('body' not in params or
|
|
577
|
+
params['body'] is None):
|
|
578
|
+
raise ValueError("Missing the required parameter `body` when calling `add_container_tags`") # noqa: E501
|
|
579
|
+
check_filename_params(params)
|
|
580
|
+
|
|
581
|
+
collection_formats = {}
|
|
582
|
+
|
|
583
|
+
path_params = {}
|
|
584
|
+
if 'cid' in params:
|
|
585
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
586
|
+
|
|
587
|
+
query_params = []
|
|
588
|
+
|
|
589
|
+
header_params = {}
|
|
590
|
+
|
|
591
|
+
form_params = []
|
|
592
|
+
local_var_files = {}
|
|
593
|
+
|
|
594
|
+
body_params = None
|
|
595
|
+
if 'body' in params:
|
|
596
|
+
body_params = params['body']
|
|
597
|
+
# HTTP header `Accept`
|
|
598
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
599
|
+
['application/json']) # noqa: E501
|
|
600
|
+
|
|
601
|
+
# HTTP header `Content-Type`
|
|
602
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
603
|
+
['application/json']) # noqa: E501
|
|
604
|
+
|
|
605
|
+
# Authentication setting
|
|
606
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
607
|
+
|
|
608
|
+
return self.api_client.call_api(
|
|
609
|
+
'/containers/{cid}/tags', 'PATCH',
|
|
610
|
+
path_params,
|
|
611
|
+
query_params,
|
|
612
|
+
header_params,
|
|
613
|
+
body=body_params,
|
|
614
|
+
post_params=form_params,
|
|
615
|
+
files=local_var_files,
|
|
616
|
+
response_type=None, # noqa: E501
|
|
617
|
+
auth_settings=auth_settings,
|
|
618
|
+
async_=params.get('async_'),
|
|
619
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
620
|
+
_preload_content=params.get('_preload_content', True),
|
|
621
|
+
_request_timeout=params.get('_request_timeout'),
|
|
622
|
+
_request_out=params.get('_request_out'),
|
|
623
|
+
collection_formats=collection_formats)
|
|
624
|
+
|
|
625
|
+
def add_view(self, container_id, body, **kwargs): # noqa: E501
|
|
626
|
+
"""Add a new data view
|
|
627
|
+
|
|
628
|
+
Create container view
|
|
629
|
+
This method makes a synchronous HTTP request by default.
|
|
630
|
+
|
|
631
|
+
:param str container_id: (required)
|
|
632
|
+
:param ContainerIdViewInput body: (required)
|
|
633
|
+
:param bool async_: Perform the request asynchronously
|
|
634
|
+
:return: ViewIdOutput
|
|
635
|
+
"""
|
|
636
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
637
|
+
kwargs['_return_http_data_only'] = True
|
|
638
|
+
|
|
639
|
+
if kwargs.get('async_'):
|
|
640
|
+
return self.add_view_with_http_info(container_id, body, **kwargs) # noqa: E501
|
|
641
|
+
else:
|
|
642
|
+
(data) = self.add_view_with_http_info(container_id, body, **kwargs) # noqa: E501
|
|
643
|
+
if (
|
|
644
|
+
data
|
|
645
|
+
and hasattr(data, 'return_value')
|
|
646
|
+
and not ignore_simplified_return_value
|
|
647
|
+
):
|
|
648
|
+
return data.return_value()
|
|
649
|
+
return data
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
def add_view_with_http_info(self, container_id, body, **kwargs): # noqa: E501
|
|
653
|
+
"""Add a new data view
|
|
654
|
+
|
|
655
|
+
Create container view
|
|
656
|
+
This method makes a synchronous HTTP request by default.
|
|
657
|
+
|
|
658
|
+
:param str container_id: (required)
|
|
659
|
+
:param ContainerIdViewInput body: (required)
|
|
660
|
+
:param bool async_: Perform the request asynchronously
|
|
661
|
+
:return: ViewIdOutput
|
|
662
|
+
"""
|
|
663
|
+
|
|
664
|
+
all_params = ['container_id','body',] # noqa: E501
|
|
665
|
+
all_params.append('async_')
|
|
666
|
+
all_params.append('_return_http_data_only')
|
|
667
|
+
all_params.append('_preload_content')
|
|
668
|
+
all_params.append('_request_timeout')
|
|
669
|
+
all_params.append('_request_out')
|
|
670
|
+
|
|
671
|
+
params = locals()
|
|
672
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
673
|
+
if key not in all_params:
|
|
674
|
+
raise TypeError(
|
|
675
|
+
"Got an unexpected keyword argument '%s'"
|
|
676
|
+
" to method add_view" % key
|
|
677
|
+
)
|
|
678
|
+
params[key] = val
|
|
679
|
+
del params['kwargs']
|
|
680
|
+
# verify the required parameter 'container_id' is set
|
|
681
|
+
if ('container_id' not in params or
|
|
682
|
+
params['container_id'] is None):
|
|
683
|
+
raise ValueError("Missing the required parameter `container_id` when calling `add_view`") # noqa: E501
|
|
684
|
+
# verify the required parameter 'body' is set
|
|
685
|
+
if ('body' not in params or
|
|
686
|
+
params['body'] is None):
|
|
687
|
+
raise ValueError("Missing the required parameter `body` when calling `add_view`") # noqa: E501
|
|
688
|
+
check_filename_params(params)
|
|
689
|
+
|
|
690
|
+
collection_formats = {}
|
|
691
|
+
|
|
692
|
+
path_params = {}
|
|
693
|
+
if 'container_id' in params:
|
|
694
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
695
|
+
|
|
696
|
+
query_params = []
|
|
697
|
+
|
|
698
|
+
header_params = {}
|
|
699
|
+
|
|
700
|
+
form_params = []
|
|
701
|
+
local_var_files = {}
|
|
702
|
+
|
|
703
|
+
body_params = None
|
|
704
|
+
if 'body' in params:
|
|
705
|
+
if 'ContainerIdViewInput'.startswith('union'):
|
|
706
|
+
body_type = type(params['body'])
|
|
707
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
708
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
709
|
+
else:
|
|
710
|
+
body_params = params['body']
|
|
711
|
+
else:
|
|
712
|
+
body_params = flywheel.models.ContainerIdViewInput.positional_to_model(params['body'])
|
|
713
|
+
# HTTP header `Accept`
|
|
714
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
715
|
+
['application/json']) # noqa: E501
|
|
716
|
+
|
|
717
|
+
# HTTP header `Content-Type`
|
|
718
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
719
|
+
['application/json']) # noqa: E501
|
|
720
|
+
|
|
721
|
+
# Authentication setting
|
|
722
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
723
|
+
|
|
724
|
+
return self.api_client.call_api(
|
|
725
|
+
'/containers/{container_id}/views', 'POST',
|
|
726
|
+
path_params,
|
|
727
|
+
query_params,
|
|
728
|
+
header_params,
|
|
729
|
+
body=body_params,
|
|
730
|
+
post_params=form_params,
|
|
731
|
+
files=local_var_files,
|
|
732
|
+
response_type='ViewIdOutput', # noqa: E501
|
|
733
|
+
auth_settings=auth_settings,
|
|
734
|
+
async_=params.get('async_'),
|
|
735
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
736
|
+
_preload_content=params.get('_preload_content', True),
|
|
737
|
+
_request_timeout=params.get('_request_timeout'),
|
|
738
|
+
_request_out=params.get('_request_out'),
|
|
739
|
+
collection_formats=collection_formats)
|
|
740
|
+
|
|
741
|
+
def delete_container(self, container_id, **kwargs): # noqa: E501
|
|
742
|
+
"""Delete a container
|
|
743
|
+
|
|
744
|
+
Delete Container
|
|
745
|
+
This method makes a synchronous HTTP request by default.
|
|
746
|
+
|
|
747
|
+
:param str container_id: (required)
|
|
748
|
+
:param ContainerDeleteReason delete_reason:
|
|
749
|
+
:param bool async_: Perform the request asynchronously
|
|
750
|
+
:return: DeletedResult
|
|
751
|
+
"""
|
|
752
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
753
|
+
kwargs['_return_http_data_only'] = True
|
|
754
|
+
|
|
755
|
+
if kwargs.get('async_'):
|
|
756
|
+
return self.delete_container_with_http_info(container_id, **kwargs) # noqa: E501
|
|
757
|
+
else:
|
|
758
|
+
(data) = self.delete_container_with_http_info(container_id, **kwargs) # noqa: E501
|
|
759
|
+
if (
|
|
760
|
+
data
|
|
761
|
+
and hasattr(data, 'return_value')
|
|
762
|
+
and not ignore_simplified_return_value
|
|
763
|
+
):
|
|
764
|
+
return data.return_value()
|
|
765
|
+
return data
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
def delete_container_with_http_info(self, container_id, **kwargs): # noqa: E501
|
|
769
|
+
"""Delete a container
|
|
770
|
+
|
|
771
|
+
Delete Container
|
|
772
|
+
This method makes a synchronous HTTP request by default.
|
|
773
|
+
|
|
774
|
+
:param str container_id: (required)
|
|
775
|
+
:param ContainerDeleteReason delete_reason:
|
|
776
|
+
:param bool async_: Perform the request asynchronously
|
|
777
|
+
:return: DeletedResult
|
|
778
|
+
"""
|
|
779
|
+
|
|
780
|
+
all_params = ['container_id','delete_reason',] # noqa: E501
|
|
781
|
+
all_params.append('async_')
|
|
782
|
+
all_params.append('_return_http_data_only')
|
|
783
|
+
all_params.append('_preload_content')
|
|
784
|
+
all_params.append('_request_timeout')
|
|
785
|
+
all_params.append('_request_out')
|
|
786
|
+
|
|
787
|
+
params = locals()
|
|
788
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
789
|
+
if key not in all_params:
|
|
790
|
+
raise TypeError(
|
|
791
|
+
"Got an unexpected keyword argument '%s'"
|
|
792
|
+
" to method delete_container" % key
|
|
793
|
+
)
|
|
794
|
+
params[key] = val
|
|
795
|
+
del params['kwargs']
|
|
796
|
+
# verify the required parameter 'container_id' is set
|
|
797
|
+
if ('container_id' not in params or
|
|
798
|
+
params['container_id'] is None):
|
|
799
|
+
raise ValueError("Missing the required parameter `container_id` when calling `delete_container`") # noqa: E501
|
|
800
|
+
check_filename_params(params)
|
|
801
|
+
|
|
802
|
+
collection_formats = {}
|
|
803
|
+
|
|
804
|
+
path_params = {}
|
|
805
|
+
if 'container_id' in params:
|
|
806
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
807
|
+
|
|
808
|
+
query_params = []
|
|
809
|
+
if 'delete_reason' in params:
|
|
810
|
+
query_params.append(('delete_reason', params['delete_reason'])) # noqa: E501
|
|
811
|
+
|
|
812
|
+
header_params = {}
|
|
813
|
+
|
|
814
|
+
form_params = []
|
|
815
|
+
local_var_files = {}
|
|
816
|
+
|
|
817
|
+
body_params = None
|
|
818
|
+
# HTTP header `Accept`
|
|
819
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
820
|
+
['application/json']) # noqa: E501
|
|
821
|
+
|
|
822
|
+
# Authentication setting
|
|
823
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
824
|
+
|
|
825
|
+
return self.api_client.call_api(
|
|
826
|
+
'/containers/{container_id}', 'DELETE',
|
|
827
|
+
path_params,
|
|
828
|
+
query_params,
|
|
829
|
+
header_params,
|
|
830
|
+
body=body_params,
|
|
831
|
+
post_params=form_params,
|
|
832
|
+
files=local_var_files,
|
|
833
|
+
response_type='DeletedResult', # noqa: E501
|
|
834
|
+
auth_settings=auth_settings,
|
|
835
|
+
async_=params.get('async_'),
|
|
836
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
837
|
+
_preload_content=params.get('_preload_content', True),
|
|
838
|
+
_request_timeout=params.get('_request_timeout'),
|
|
839
|
+
_request_out=params.get('_request_out'),
|
|
840
|
+
collection_formats=collection_formats)
|
|
841
|
+
|
|
842
|
+
def delete_container_analysis(self, cid, analysis_id, **kwargs): # noqa: E501
|
|
843
|
+
"""Delete an analysis
|
|
844
|
+
|
|
845
|
+
Delete an analysis for a container.
|
|
846
|
+
This method makes a synchronous HTTP request by default.
|
|
847
|
+
|
|
848
|
+
:param str cid: (required)
|
|
849
|
+
:param str analysis_id: (required)
|
|
850
|
+
:param ContainerDeleteReason delete_reason: Provide a reason for the deletion
|
|
851
|
+
:param bool async_: Perform the request asynchronously
|
|
852
|
+
:return: DeletedResult
|
|
853
|
+
"""
|
|
854
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
855
|
+
kwargs['_return_http_data_only'] = True
|
|
856
|
+
|
|
857
|
+
if kwargs.get('async_'):
|
|
858
|
+
return self.delete_container_analysis_with_http_info(cid, analysis_id, **kwargs) # noqa: E501
|
|
859
|
+
else:
|
|
860
|
+
(data) = self.delete_container_analysis_with_http_info(cid, analysis_id, **kwargs) # noqa: E501
|
|
861
|
+
if (
|
|
862
|
+
data
|
|
863
|
+
and hasattr(data, 'return_value')
|
|
864
|
+
and not ignore_simplified_return_value
|
|
865
|
+
):
|
|
866
|
+
return data.return_value()
|
|
867
|
+
return data
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
def delete_container_analysis_with_http_info(self, cid, analysis_id, **kwargs): # noqa: E501
|
|
871
|
+
"""Delete an analysis
|
|
872
|
+
|
|
873
|
+
Delete an analysis for a container.
|
|
874
|
+
This method makes a synchronous HTTP request by default.
|
|
875
|
+
|
|
876
|
+
:param str cid: (required)
|
|
877
|
+
:param str analysis_id: (required)
|
|
878
|
+
:param ContainerDeleteReason delete_reason: Provide a reason for the deletion
|
|
879
|
+
:param bool async_: Perform the request asynchronously
|
|
880
|
+
:return: DeletedResult
|
|
881
|
+
"""
|
|
882
|
+
|
|
883
|
+
all_params = ['cid','analysis_id','delete_reason',] # noqa: E501
|
|
884
|
+
all_params.append('async_')
|
|
885
|
+
all_params.append('_return_http_data_only')
|
|
886
|
+
all_params.append('_preload_content')
|
|
887
|
+
all_params.append('_request_timeout')
|
|
888
|
+
all_params.append('_request_out')
|
|
889
|
+
|
|
890
|
+
params = locals()
|
|
891
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
892
|
+
if key not in all_params:
|
|
893
|
+
raise TypeError(
|
|
894
|
+
"Got an unexpected keyword argument '%s'"
|
|
895
|
+
" to method delete_container_analysis" % key
|
|
896
|
+
)
|
|
897
|
+
params[key] = val
|
|
898
|
+
del params['kwargs']
|
|
899
|
+
# verify the required parameter 'cid' is set
|
|
900
|
+
if ('cid' not in params or
|
|
901
|
+
params['cid'] is None):
|
|
902
|
+
raise ValueError("Missing the required parameter `cid` when calling `delete_container_analysis`") # noqa: E501
|
|
903
|
+
# verify the required parameter 'analysis_id' is set
|
|
904
|
+
if ('analysis_id' not in params or
|
|
905
|
+
params['analysis_id'] is None):
|
|
906
|
+
raise ValueError("Missing the required parameter `analysis_id` when calling `delete_container_analysis`") # noqa: E501
|
|
907
|
+
check_filename_params(params)
|
|
908
|
+
|
|
909
|
+
collection_formats = {}
|
|
910
|
+
|
|
911
|
+
path_params = {}
|
|
912
|
+
if 'cid' in params:
|
|
913
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
914
|
+
if 'analysis_id' in params:
|
|
915
|
+
path_params['analysis_id'] = params['analysis_id'] # noqa: E501
|
|
916
|
+
|
|
917
|
+
query_params = []
|
|
918
|
+
if 'delete_reason' in params:
|
|
919
|
+
query_params.append(('delete_reason', params['delete_reason'])) # noqa: E501
|
|
920
|
+
|
|
921
|
+
header_params = {}
|
|
922
|
+
|
|
923
|
+
form_params = []
|
|
924
|
+
local_var_files = {}
|
|
925
|
+
|
|
926
|
+
body_params = None
|
|
927
|
+
# HTTP header `Accept`
|
|
928
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
929
|
+
['application/json']) # noqa: E501
|
|
930
|
+
|
|
931
|
+
# Authentication setting
|
|
932
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
933
|
+
|
|
934
|
+
return self.api_client.call_api(
|
|
935
|
+
'/containers/{cid}/analyses/{analysis_id}', 'DELETE',
|
|
936
|
+
path_params,
|
|
937
|
+
query_params,
|
|
938
|
+
header_params,
|
|
939
|
+
body=body_params,
|
|
940
|
+
post_params=form_params,
|
|
941
|
+
files=local_var_files,
|
|
942
|
+
response_type='DeletedResult', # noqa: E501
|
|
943
|
+
auth_settings=auth_settings,
|
|
944
|
+
async_=params.get('async_'),
|
|
945
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
946
|
+
_preload_content=params.get('_preload_content', True),
|
|
947
|
+
_request_timeout=params.get('_request_timeout'),
|
|
948
|
+
_request_out=params.get('_request_out'),
|
|
949
|
+
collection_formats=collection_formats)
|
|
950
|
+
|
|
951
|
+
def delete_container_analysis_note(self, cid, analysis_id, note_id, **kwargs): # noqa: E501
|
|
952
|
+
"""Remove a note from a(n) container analysis.
|
|
953
|
+
|
|
954
|
+
Remove a note from a(n) container analysis.
|
|
955
|
+
This method makes a synchronous HTTP request by default.
|
|
956
|
+
|
|
957
|
+
:param str cid: 24-char hex id (required)
|
|
958
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
959
|
+
:param str note_id: 24-char hex note id (required)
|
|
960
|
+
:param bool async_: Perform the request asynchronously
|
|
961
|
+
:return: DeletedResult
|
|
962
|
+
"""
|
|
963
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
964
|
+
kwargs['_return_http_data_only'] = True
|
|
965
|
+
|
|
966
|
+
if kwargs.get('async_'):
|
|
967
|
+
return self.delete_container_analysis_note_with_http_info(cid, analysis_id, note_id, **kwargs) # noqa: E501
|
|
968
|
+
else:
|
|
969
|
+
(data) = self.delete_container_analysis_note_with_http_info(cid, analysis_id, note_id, **kwargs) # noqa: E501
|
|
970
|
+
if (
|
|
971
|
+
data
|
|
972
|
+
and hasattr(data, 'return_value')
|
|
973
|
+
and not ignore_simplified_return_value
|
|
974
|
+
):
|
|
975
|
+
return data.return_value()
|
|
976
|
+
return data
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
def delete_container_analysis_note_with_http_info(self, cid, analysis_id, note_id, **kwargs): # noqa: E501
|
|
980
|
+
"""Remove a note from a(n) container analysis.
|
|
981
|
+
|
|
982
|
+
Remove a note from a(n) container analysis.
|
|
983
|
+
This method makes a synchronous HTTP request by default.
|
|
984
|
+
|
|
985
|
+
:param str cid: 24-char hex id (required)
|
|
986
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
987
|
+
:param str note_id: 24-char hex note id (required)
|
|
988
|
+
:param bool async_: Perform the request asynchronously
|
|
989
|
+
:return: DeletedResult
|
|
990
|
+
"""
|
|
991
|
+
|
|
992
|
+
all_params = ['cid','analysis_id','note_id',] # noqa: E501
|
|
993
|
+
all_params.append('async_')
|
|
994
|
+
all_params.append('_return_http_data_only')
|
|
995
|
+
all_params.append('_preload_content')
|
|
996
|
+
all_params.append('_request_timeout')
|
|
997
|
+
all_params.append('_request_out')
|
|
998
|
+
|
|
999
|
+
params = locals()
|
|
1000
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1001
|
+
if key not in all_params:
|
|
1002
|
+
raise TypeError(
|
|
1003
|
+
"Got an unexpected keyword argument '%s'"
|
|
1004
|
+
" to method delete_container_analysis_note" % key
|
|
1005
|
+
)
|
|
1006
|
+
params[key] = val
|
|
1007
|
+
del params['kwargs']
|
|
1008
|
+
# verify the required parameter 'cid' is set
|
|
1009
|
+
if ('cid' not in params or
|
|
1010
|
+
params['cid'] is None):
|
|
1011
|
+
raise ValueError("Missing the required parameter `cid` when calling `delete_container_analysis_note`") # noqa: E501
|
|
1012
|
+
# verify the required parameter 'analysis_id' is set
|
|
1013
|
+
if ('analysis_id' not in params or
|
|
1014
|
+
params['analysis_id'] is None):
|
|
1015
|
+
raise ValueError("Missing the required parameter `analysis_id` when calling `delete_container_analysis_note`") # noqa: E501
|
|
1016
|
+
# verify the required parameter 'note_id' is set
|
|
1017
|
+
if ('note_id' not in params or
|
|
1018
|
+
params['note_id'] is None):
|
|
1019
|
+
raise ValueError("Missing the required parameter `note_id` when calling `delete_container_analysis_note`") # noqa: E501
|
|
1020
|
+
check_filename_params(params)
|
|
1021
|
+
|
|
1022
|
+
collection_formats = {}
|
|
1023
|
+
|
|
1024
|
+
path_params = {}
|
|
1025
|
+
if 'cid' in params:
|
|
1026
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
1027
|
+
if 'analysis_id' in params:
|
|
1028
|
+
path_params['analysis_id'] = params['analysis_id'] # noqa: E501
|
|
1029
|
+
if 'note_id' in params:
|
|
1030
|
+
path_params['note_id'] = params['note_id'] # noqa: E501
|
|
1031
|
+
|
|
1032
|
+
query_params = []
|
|
1033
|
+
|
|
1034
|
+
header_params = {}
|
|
1035
|
+
|
|
1036
|
+
form_params = []
|
|
1037
|
+
local_var_files = {}
|
|
1038
|
+
|
|
1039
|
+
body_params = None
|
|
1040
|
+
# HTTP header `Accept`
|
|
1041
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1042
|
+
['application/json']) # noqa: E501
|
|
1043
|
+
|
|
1044
|
+
# Authentication setting
|
|
1045
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1046
|
+
|
|
1047
|
+
return self.api_client.call_api(
|
|
1048
|
+
'/containers/{cid}/analyses/{analysis_id}/notes/{note_id}', 'DELETE',
|
|
1049
|
+
path_params,
|
|
1050
|
+
query_params,
|
|
1051
|
+
header_params,
|
|
1052
|
+
body=body_params,
|
|
1053
|
+
post_params=form_params,
|
|
1054
|
+
files=local_var_files,
|
|
1055
|
+
response_type='DeletedResult', # noqa: E501
|
|
1056
|
+
auth_settings=auth_settings,
|
|
1057
|
+
async_=params.get('async_'),
|
|
1058
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1059
|
+
_preload_content=params.get('_preload_content', True),
|
|
1060
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1061
|
+
_request_out=params.get('_request_out'),
|
|
1062
|
+
collection_formats=collection_formats)
|
|
1063
|
+
|
|
1064
|
+
def delete_container_file(self, cid, filename, **kwargs): # noqa: E501
|
|
1065
|
+
"""Delete a file
|
|
1066
|
+
|
|
1067
|
+
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
1068
|
+
This method makes a synchronous HTTP request by default.
|
|
1069
|
+
|
|
1070
|
+
:param str cid: (required)
|
|
1071
|
+
:param str filename: (required)
|
|
1072
|
+
:param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
|
|
1073
|
+
:param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
|
|
1074
|
+
:param bool async_: Perform the request asynchronously
|
|
1075
|
+
:return: DeletedResult
|
|
1076
|
+
"""
|
|
1077
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1078
|
+
kwargs['_return_http_data_only'] = True
|
|
1079
|
+
|
|
1080
|
+
if kwargs.get('async_'):
|
|
1081
|
+
return self.delete_container_file_with_http_info(cid, filename, **kwargs) # noqa: E501
|
|
1082
|
+
else:
|
|
1083
|
+
(data) = self.delete_container_file_with_http_info(cid, filename, **kwargs) # noqa: E501
|
|
1084
|
+
if (
|
|
1085
|
+
data
|
|
1086
|
+
and hasattr(data, 'return_value')
|
|
1087
|
+
and not ignore_simplified_return_value
|
|
1088
|
+
):
|
|
1089
|
+
return data.return_value()
|
|
1090
|
+
return data
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
def delete_container_file_with_http_info(self, cid, filename, **kwargs): # noqa: E501
|
|
1094
|
+
"""Delete a file
|
|
1095
|
+
|
|
1096
|
+
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
1097
|
+
This method makes a synchronous HTTP request by default.
|
|
1098
|
+
|
|
1099
|
+
:param str cid: (required)
|
|
1100
|
+
:param str filename: (required)
|
|
1101
|
+
:param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
|
|
1102
|
+
:param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
|
|
1103
|
+
:param bool async_: Perform the request asynchronously
|
|
1104
|
+
:return: DeletedResult
|
|
1105
|
+
"""
|
|
1106
|
+
|
|
1107
|
+
all_params = ['cid','filename','delete_reason','force',] # noqa: E501
|
|
1108
|
+
all_params.append('async_')
|
|
1109
|
+
all_params.append('_return_http_data_only')
|
|
1110
|
+
all_params.append('_preload_content')
|
|
1111
|
+
all_params.append('_request_timeout')
|
|
1112
|
+
all_params.append('_request_out')
|
|
1113
|
+
|
|
1114
|
+
params = locals()
|
|
1115
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1116
|
+
if key not in all_params:
|
|
1117
|
+
raise TypeError(
|
|
1118
|
+
"Got an unexpected keyword argument '%s'"
|
|
1119
|
+
" to method delete_container_file" % key
|
|
1120
|
+
)
|
|
1121
|
+
params[key] = val
|
|
1122
|
+
del params['kwargs']
|
|
1123
|
+
# verify the required parameter 'cid' is set
|
|
1124
|
+
if ('cid' not in params or
|
|
1125
|
+
params['cid'] is None):
|
|
1126
|
+
raise ValueError("Missing the required parameter `cid` when calling `delete_container_file`") # noqa: E501
|
|
1127
|
+
# verify the required parameter 'filename' is set
|
|
1128
|
+
if ('filename' not in params or
|
|
1129
|
+
params['filename'] is None):
|
|
1130
|
+
raise ValueError("Missing the required parameter `filename` when calling `delete_container_file`") # noqa: E501
|
|
1131
|
+
check_filename_params(params)
|
|
1132
|
+
|
|
1133
|
+
collection_formats = {}
|
|
1134
|
+
|
|
1135
|
+
path_params = {}
|
|
1136
|
+
if 'cid' in params:
|
|
1137
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
1138
|
+
if 'filename' in params:
|
|
1139
|
+
path_params['filename'] = params['filename'] # noqa: E501
|
|
1140
|
+
|
|
1141
|
+
query_params = []
|
|
1142
|
+
if 'delete_reason' in params:
|
|
1143
|
+
query_params.append(('delete_reason', params['delete_reason'])) # noqa: E501
|
|
1144
|
+
if 'force' in params:
|
|
1145
|
+
query_params.append(('force', params['force'])) # noqa: E501
|
|
1146
|
+
|
|
1147
|
+
header_params = {}
|
|
1148
|
+
|
|
1149
|
+
form_params = []
|
|
1150
|
+
local_var_files = {}
|
|
1151
|
+
|
|
1152
|
+
body_params = None
|
|
1153
|
+
# HTTP header `Accept`
|
|
1154
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1155
|
+
['application/json']) # noqa: E501
|
|
1156
|
+
|
|
1157
|
+
# Authentication setting
|
|
1158
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1159
|
+
|
|
1160
|
+
return self.api_client.call_api(
|
|
1161
|
+
'/containers/{cid}/files/{filename}', 'DELETE',
|
|
1162
|
+
path_params,
|
|
1163
|
+
query_params,
|
|
1164
|
+
header_params,
|
|
1165
|
+
body=body_params,
|
|
1166
|
+
post_params=form_params,
|
|
1167
|
+
files=local_var_files,
|
|
1168
|
+
response_type='DeletedResult', # noqa: E501
|
|
1169
|
+
auth_settings=auth_settings,
|
|
1170
|
+
async_=params.get('async_'),
|
|
1171
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1172
|
+
_preload_content=params.get('_preload_content', True),
|
|
1173
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1174
|
+
_request_out=params.get('_request_out'),
|
|
1175
|
+
collection_formats=collection_formats)
|
|
1176
|
+
|
|
1177
|
+
def delete_container_note(self, cid, note_id, **kwargs): # noqa: E501
|
|
1178
|
+
"""Remove a note from a(n) container
|
|
1179
|
+
|
|
1180
|
+
Remove a note from a(n) container
|
|
1181
|
+
This method makes a synchronous HTTP request by default.
|
|
1182
|
+
|
|
1183
|
+
:param str cid: (required)
|
|
1184
|
+
:param str note_id: (required)
|
|
1185
|
+
:param bool async_: Perform the request asynchronously
|
|
1186
|
+
:return: DeletedResult
|
|
1187
|
+
"""
|
|
1188
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1189
|
+
kwargs['_return_http_data_only'] = True
|
|
1190
|
+
|
|
1191
|
+
if kwargs.get('async_'):
|
|
1192
|
+
return self.delete_container_note_with_http_info(cid, note_id, **kwargs) # noqa: E501
|
|
1193
|
+
else:
|
|
1194
|
+
(data) = self.delete_container_note_with_http_info(cid, note_id, **kwargs) # noqa: E501
|
|
1195
|
+
if (
|
|
1196
|
+
data
|
|
1197
|
+
and hasattr(data, 'return_value')
|
|
1198
|
+
and not ignore_simplified_return_value
|
|
1199
|
+
):
|
|
1200
|
+
return data.return_value()
|
|
1201
|
+
return data
|
|
1202
|
+
|
|
1203
|
+
|
|
1204
|
+
def delete_container_note_with_http_info(self, cid, note_id, **kwargs): # noqa: E501
|
|
1205
|
+
"""Remove a note from a(n) container
|
|
1206
|
+
|
|
1207
|
+
Remove a note from a(n) container
|
|
1208
|
+
This method makes a synchronous HTTP request by default.
|
|
1209
|
+
|
|
1210
|
+
:param str cid: (required)
|
|
1211
|
+
:param str note_id: (required)
|
|
1212
|
+
:param bool async_: Perform the request asynchronously
|
|
1213
|
+
:return: DeletedResult
|
|
1214
|
+
"""
|
|
1215
|
+
|
|
1216
|
+
all_params = ['cid','note_id',] # noqa: E501
|
|
1217
|
+
all_params.append('async_')
|
|
1218
|
+
all_params.append('_return_http_data_only')
|
|
1219
|
+
all_params.append('_preload_content')
|
|
1220
|
+
all_params.append('_request_timeout')
|
|
1221
|
+
all_params.append('_request_out')
|
|
1222
|
+
|
|
1223
|
+
params = locals()
|
|
1224
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1225
|
+
if key not in all_params:
|
|
1226
|
+
raise TypeError(
|
|
1227
|
+
"Got an unexpected keyword argument '%s'"
|
|
1228
|
+
" to method delete_container_note" % key
|
|
1229
|
+
)
|
|
1230
|
+
params[key] = val
|
|
1231
|
+
del params['kwargs']
|
|
1232
|
+
# verify the required parameter 'cid' is set
|
|
1233
|
+
if ('cid' not in params or
|
|
1234
|
+
params['cid'] is None):
|
|
1235
|
+
raise ValueError("Missing the required parameter `cid` when calling `delete_container_note`") # noqa: E501
|
|
1236
|
+
# verify the required parameter 'note_id' is set
|
|
1237
|
+
if ('note_id' not in params or
|
|
1238
|
+
params['note_id'] is None):
|
|
1239
|
+
raise ValueError("Missing the required parameter `note_id` when calling `delete_container_note`") # noqa: E501
|
|
1240
|
+
check_filename_params(params)
|
|
1241
|
+
|
|
1242
|
+
collection_formats = {}
|
|
1243
|
+
|
|
1244
|
+
path_params = {}
|
|
1245
|
+
if 'cid' in params:
|
|
1246
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
1247
|
+
if 'note_id' in params:
|
|
1248
|
+
path_params['note_id'] = params['note_id'] # noqa: E501
|
|
1249
|
+
|
|
1250
|
+
query_params = []
|
|
1251
|
+
|
|
1252
|
+
header_params = {}
|
|
1253
|
+
|
|
1254
|
+
form_params = []
|
|
1255
|
+
local_var_files = {}
|
|
1256
|
+
|
|
1257
|
+
body_params = None
|
|
1258
|
+
# HTTP header `Accept`
|
|
1259
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1260
|
+
['application/json']) # noqa: E501
|
|
1261
|
+
|
|
1262
|
+
# Authentication setting
|
|
1263
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1264
|
+
|
|
1265
|
+
return self.api_client.call_api(
|
|
1266
|
+
'/containers/{cid}/notes/{note_id}', 'DELETE',
|
|
1267
|
+
path_params,
|
|
1268
|
+
query_params,
|
|
1269
|
+
header_params,
|
|
1270
|
+
body=body_params,
|
|
1271
|
+
post_params=form_params,
|
|
1272
|
+
files=local_var_files,
|
|
1273
|
+
response_type='DeletedResult', # noqa: E501
|
|
1274
|
+
auth_settings=auth_settings,
|
|
1275
|
+
async_=params.get('async_'),
|
|
1276
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1277
|
+
_preload_content=params.get('_preload_content', True),
|
|
1278
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1279
|
+
_request_out=params.get('_request_out'),
|
|
1280
|
+
collection_formats=collection_formats)
|
|
1281
|
+
|
|
1282
|
+
def delete_container_tag(self, cid, value, **kwargs): # noqa: E501
|
|
1283
|
+
"""Delete a tag
|
|
1284
|
+
|
|
1285
|
+
Delete a tag
|
|
1286
|
+
This method makes a synchronous HTTP request by default.
|
|
1287
|
+
|
|
1288
|
+
:param str cid: (required)
|
|
1289
|
+
:param str value: The tag to interact with (required)
|
|
1290
|
+
:param bool async_: Perform the request asynchronously
|
|
1291
|
+
:return: DeletedResult
|
|
1292
|
+
"""
|
|
1293
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1294
|
+
kwargs['_return_http_data_only'] = True
|
|
1295
|
+
|
|
1296
|
+
if kwargs.get('async_'):
|
|
1297
|
+
return self.delete_container_tag_with_http_info(cid, value, **kwargs) # noqa: E501
|
|
1298
|
+
else:
|
|
1299
|
+
(data) = self.delete_container_tag_with_http_info(cid, value, **kwargs) # noqa: E501
|
|
1300
|
+
if (
|
|
1301
|
+
data
|
|
1302
|
+
and hasattr(data, 'return_value')
|
|
1303
|
+
and not ignore_simplified_return_value
|
|
1304
|
+
):
|
|
1305
|
+
return data.return_value()
|
|
1306
|
+
return data
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
def delete_container_tag_with_http_info(self, cid, value, **kwargs): # noqa: E501
|
|
1310
|
+
"""Delete a tag
|
|
1311
|
+
|
|
1312
|
+
Delete a tag
|
|
1313
|
+
This method makes a synchronous HTTP request by default.
|
|
1314
|
+
|
|
1315
|
+
:param str cid: (required)
|
|
1316
|
+
:param str value: The tag to interact with (required)
|
|
1317
|
+
:param bool async_: Perform the request asynchronously
|
|
1318
|
+
:return: DeletedResult
|
|
1319
|
+
"""
|
|
1320
|
+
|
|
1321
|
+
all_params = ['cid','value',] # noqa: E501
|
|
1322
|
+
all_params.append('async_')
|
|
1323
|
+
all_params.append('_return_http_data_only')
|
|
1324
|
+
all_params.append('_preload_content')
|
|
1325
|
+
all_params.append('_request_timeout')
|
|
1326
|
+
all_params.append('_request_out')
|
|
1327
|
+
|
|
1328
|
+
params = locals()
|
|
1329
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1330
|
+
if key not in all_params:
|
|
1331
|
+
raise TypeError(
|
|
1332
|
+
"Got an unexpected keyword argument '%s'"
|
|
1333
|
+
" to method delete_container_tag" % key
|
|
1334
|
+
)
|
|
1335
|
+
params[key] = val
|
|
1336
|
+
del params['kwargs']
|
|
1337
|
+
# verify the required parameter 'cid' is set
|
|
1338
|
+
if ('cid' not in params or
|
|
1339
|
+
params['cid'] is None):
|
|
1340
|
+
raise ValueError("Missing the required parameter `cid` when calling `delete_container_tag`") # noqa: E501
|
|
1341
|
+
# verify the required parameter 'value' is set
|
|
1342
|
+
if ('value' not in params or
|
|
1343
|
+
params['value'] is None):
|
|
1344
|
+
raise ValueError("Missing the required parameter `value` when calling `delete_container_tag`") # noqa: E501
|
|
1345
|
+
check_filename_params(params)
|
|
1346
|
+
|
|
1347
|
+
collection_formats = {}
|
|
1348
|
+
|
|
1349
|
+
path_params = {}
|
|
1350
|
+
if 'cid' in params:
|
|
1351
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
1352
|
+
if 'value' in params:
|
|
1353
|
+
path_params['value'] = params['value'] # noqa: E501
|
|
1354
|
+
|
|
1355
|
+
query_params = []
|
|
1356
|
+
|
|
1357
|
+
header_params = {}
|
|
1358
|
+
|
|
1359
|
+
form_params = []
|
|
1360
|
+
local_var_files = {}
|
|
1361
|
+
|
|
1362
|
+
body_params = None
|
|
1363
|
+
# HTTP header `Accept`
|
|
1364
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1365
|
+
['application/json']) # noqa: E501
|
|
1366
|
+
|
|
1367
|
+
# Authentication setting
|
|
1368
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1369
|
+
|
|
1370
|
+
return self.api_client.call_api(
|
|
1371
|
+
'/containers/{cid}/tags/{value}', 'DELETE',
|
|
1372
|
+
path_params,
|
|
1373
|
+
query_params,
|
|
1374
|
+
header_params,
|
|
1375
|
+
body=body_params,
|
|
1376
|
+
post_params=form_params,
|
|
1377
|
+
files=local_var_files,
|
|
1378
|
+
response_type='DeletedResult', # noqa: E501
|
|
1379
|
+
auth_settings=auth_settings,
|
|
1380
|
+
async_=params.get('async_'),
|
|
1381
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1382
|
+
_preload_content=params.get('_preload_content', True),
|
|
1383
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1384
|
+
_request_out=params.get('_request_out'),
|
|
1385
|
+
collection_formats=collection_formats)
|
|
1386
|
+
|
|
1387
|
+
def delete_container_tags(self, cid, body, **kwargs): # noqa: E501
|
|
1388
|
+
"""Delete multiple tags from a(n) container
|
|
1389
|
+
|
|
1390
|
+
Delete multiple tags from a(n) container
|
|
1391
|
+
This method makes a synchronous HTTP request by default.
|
|
1392
|
+
|
|
1393
|
+
:param str cid: (required)
|
|
1394
|
+
:param list[str] body: (required)
|
|
1395
|
+
:param bool async_: Perform the request asynchronously
|
|
1396
|
+
:return: None
|
|
1397
|
+
"""
|
|
1398
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1399
|
+
kwargs['_return_http_data_only'] = True
|
|
1400
|
+
|
|
1401
|
+
if kwargs.get('async_'):
|
|
1402
|
+
return self.delete_container_tags_with_http_info(cid, body, **kwargs) # noqa: E501
|
|
1403
|
+
else:
|
|
1404
|
+
(data) = self.delete_container_tags_with_http_info(cid, body, **kwargs) # noqa: E501
|
|
1405
|
+
if (
|
|
1406
|
+
data
|
|
1407
|
+
and hasattr(data, 'return_value')
|
|
1408
|
+
and not ignore_simplified_return_value
|
|
1409
|
+
):
|
|
1410
|
+
return data.return_value()
|
|
1411
|
+
return data
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
def delete_container_tags_with_http_info(self, cid, body, **kwargs): # noqa: E501
|
|
1415
|
+
"""Delete multiple tags from a(n) container
|
|
1416
|
+
|
|
1417
|
+
Delete multiple tags from a(n) container
|
|
1418
|
+
This method makes a synchronous HTTP request by default.
|
|
1419
|
+
|
|
1420
|
+
:param str cid: (required)
|
|
1421
|
+
:param list[str] body: (required)
|
|
1422
|
+
:param bool async_: Perform the request asynchronously
|
|
1423
|
+
:return: None
|
|
1424
|
+
"""
|
|
1425
|
+
|
|
1426
|
+
all_params = ['cid','body',] # noqa: E501
|
|
1427
|
+
all_params.append('async_')
|
|
1428
|
+
all_params.append('_return_http_data_only')
|
|
1429
|
+
all_params.append('_preload_content')
|
|
1430
|
+
all_params.append('_request_timeout')
|
|
1431
|
+
all_params.append('_request_out')
|
|
1432
|
+
|
|
1433
|
+
params = locals()
|
|
1434
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1435
|
+
if key not in all_params:
|
|
1436
|
+
raise TypeError(
|
|
1437
|
+
"Got an unexpected keyword argument '%s'"
|
|
1438
|
+
" to method delete_container_tags" % key
|
|
1439
|
+
)
|
|
1440
|
+
params[key] = val
|
|
1441
|
+
del params['kwargs']
|
|
1442
|
+
# verify the required parameter 'cid' is set
|
|
1443
|
+
if ('cid' not in params or
|
|
1444
|
+
params['cid'] is None):
|
|
1445
|
+
raise ValueError("Missing the required parameter `cid` when calling `delete_container_tags`") # noqa: E501
|
|
1446
|
+
# verify the required parameter 'body' is set
|
|
1447
|
+
if ('body' not in params or
|
|
1448
|
+
params['body'] is None):
|
|
1449
|
+
raise ValueError("Missing the required parameter `body` when calling `delete_container_tags`") # noqa: E501
|
|
1450
|
+
check_filename_params(params)
|
|
1451
|
+
|
|
1452
|
+
collection_formats = {}
|
|
1453
|
+
|
|
1454
|
+
path_params = {}
|
|
1455
|
+
if 'cid' in params:
|
|
1456
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
1457
|
+
|
|
1458
|
+
query_params = []
|
|
1459
|
+
|
|
1460
|
+
header_params = {}
|
|
1461
|
+
|
|
1462
|
+
form_params = []
|
|
1463
|
+
local_var_files = {}
|
|
1464
|
+
|
|
1465
|
+
body_params = None
|
|
1466
|
+
if 'body' in params:
|
|
1467
|
+
body_params = params['body']
|
|
1468
|
+
# HTTP header `Accept`
|
|
1469
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1470
|
+
['application/json']) # noqa: E501
|
|
1471
|
+
|
|
1472
|
+
# HTTP header `Content-Type`
|
|
1473
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
1474
|
+
['application/json']) # noqa: E501
|
|
1475
|
+
|
|
1476
|
+
# Authentication setting
|
|
1477
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1478
|
+
|
|
1479
|
+
return self.api_client.call_api(
|
|
1480
|
+
'/containers/{cid}/tags', 'DELETE',
|
|
1481
|
+
path_params,
|
|
1482
|
+
query_params,
|
|
1483
|
+
header_params,
|
|
1484
|
+
body=body_params,
|
|
1485
|
+
post_params=form_params,
|
|
1486
|
+
files=local_var_files,
|
|
1487
|
+
response_type=None, # noqa: E501
|
|
1488
|
+
auth_settings=auth_settings,
|
|
1489
|
+
async_=params.get('async_'),
|
|
1490
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1491
|
+
_preload_content=params.get('_preload_content', True),
|
|
1492
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1493
|
+
_request_out=params.get('_request_out'),
|
|
1494
|
+
collection_formats=collection_formats)
|
|
1495
|
+
|
|
1496
|
+
def download_file_from_container(self, container_id, file_name, dest_file, **kwargs): # noqa: E501
|
|
1497
|
+
"""Download a file.
|
|
1498
|
+
|
|
1499
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1500
|
+
This method makes a synchronous HTTP request by default.
|
|
1501
|
+
|
|
1502
|
+
:param str container_id: 24-character hex ID (required)
|
|
1503
|
+
:param str file_name: output file name (required)
|
|
1504
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1505
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1506
|
+
:param bool view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\"
|
|
1507
|
+
:param int version: version of the file to download
|
|
1508
|
+
:param str hash: file hash for comparison
|
|
1509
|
+
:param str range: byte ranges to return
|
|
1510
|
+
:param list[str] x_accept_feature: redirect header
|
|
1511
|
+
:param str dest_file: Destination file path
|
|
1512
|
+
:param bool async_: Perform the request asynchronously
|
|
1513
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
1514
|
+
"""
|
|
1515
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1516
|
+
kwargs['_return_http_data_only'] = True
|
|
1517
|
+
|
|
1518
|
+
kwargs['_preload_content'] = False
|
|
1519
|
+
# Stream response to file
|
|
1520
|
+
with open(dest_file, 'wb') as out_file:
|
|
1521
|
+
(resp) = self.download_file_from_container_with_http_info(container_id, file_name, **kwargs) # noqa: E501
|
|
1522
|
+
if resp:
|
|
1523
|
+
try:
|
|
1524
|
+
for chunk in resp.iter_content(chunk_size=65536):
|
|
1525
|
+
out_file.write(chunk)
|
|
1526
|
+
finally:
|
|
1527
|
+
resp.close()
|
|
1528
|
+
|
|
1529
|
+
|
|
1530
|
+
def download_file_from_container_with_http_info(self, container_id, file_name, **kwargs): # noqa: E501
|
|
1531
|
+
"""Download a file.
|
|
1532
|
+
|
|
1533
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1534
|
+
This method makes a synchronous HTTP request by default.
|
|
1535
|
+
|
|
1536
|
+
:param str container_id: 24-character hex ID (required)
|
|
1537
|
+
:param str file_name: output file name (required)
|
|
1538
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1539
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1540
|
+
:param bool view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\"
|
|
1541
|
+
:param int version: version of the file to download
|
|
1542
|
+
:param str hash: file hash for comparison
|
|
1543
|
+
:param str range: byte ranges to return
|
|
1544
|
+
:param list[str] x_accept_feature: redirect header
|
|
1545
|
+
:param bool async_: Perform the request asynchronously
|
|
1546
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
1547
|
+
"""
|
|
1548
|
+
|
|
1549
|
+
all_params = ['container_id','file_name','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
1550
|
+
all_params.append('async_')
|
|
1551
|
+
all_params.append('_return_http_data_only')
|
|
1552
|
+
all_params.append('_preload_content')
|
|
1553
|
+
all_params.append('_request_timeout')
|
|
1554
|
+
all_params.append('_request_out')
|
|
1555
|
+
|
|
1556
|
+
params = locals()
|
|
1557
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1558
|
+
if key not in all_params:
|
|
1559
|
+
raise TypeError(
|
|
1560
|
+
"Got an unexpected keyword argument '%s'"
|
|
1561
|
+
" to method download_file_from_container" % key
|
|
1562
|
+
)
|
|
1563
|
+
params[key] = val
|
|
1564
|
+
del params['kwargs']
|
|
1565
|
+
# verify the required parameter 'container_id' is set
|
|
1566
|
+
if ('container_id' not in params or
|
|
1567
|
+
params['container_id'] is None):
|
|
1568
|
+
raise ValueError("Missing the required parameter `container_id` when calling `download_file_from_container`") # noqa: E501
|
|
1569
|
+
# verify the required parameter 'file_name' is set
|
|
1570
|
+
if ('file_name' not in params or
|
|
1571
|
+
params['file_name'] is None):
|
|
1572
|
+
raise ValueError("Missing the required parameter `file_name` when calling `download_file_from_container`") # noqa: E501
|
|
1573
|
+
check_filename_params(params)
|
|
1574
|
+
|
|
1575
|
+
collection_formats = {}
|
|
1576
|
+
|
|
1577
|
+
path_params = {}
|
|
1578
|
+
if 'container_id' in params:
|
|
1579
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
1580
|
+
if 'file_name' in params:
|
|
1581
|
+
path_params['file_name'] = params['file_name'] # noqa: E501
|
|
1582
|
+
|
|
1583
|
+
query_params = []
|
|
1584
|
+
if 'info' in params:
|
|
1585
|
+
query_params.append(('info', params['info'])) # noqa: E501
|
|
1586
|
+
if 'member' in params:
|
|
1587
|
+
query_params.append(('member', params['member'])) # noqa: E501
|
|
1588
|
+
if 'view' in params:
|
|
1589
|
+
query_params.append(('view', params['view'])) # noqa: E501
|
|
1590
|
+
if 'version' in params:
|
|
1591
|
+
query_params.append(('version', params['version'])) # noqa: E501
|
|
1592
|
+
if 'hash' in params:
|
|
1593
|
+
query_params.append(('hash', params['hash'])) # noqa: E501
|
|
1594
|
+
|
|
1595
|
+
header_params = {}
|
|
1596
|
+
if 'range' in params:
|
|
1597
|
+
header_params['range'] = params['range'] # noqa: E501
|
|
1598
|
+
if 'x_accept_feature' in params:
|
|
1599
|
+
header_params['x-accept-feature'] = params['x_accept_feature'] # noqa: E501
|
|
1600
|
+
collection_formats['x-accept-feature'] = '' # noqa: E501
|
|
1601
|
+
|
|
1602
|
+
form_params = []
|
|
1603
|
+
local_var_files = {}
|
|
1604
|
+
|
|
1605
|
+
body_params = None
|
|
1606
|
+
# HTTP header `Accept`
|
|
1607
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1608
|
+
['application/octet-stream']) # noqa: E501
|
|
1609
|
+
|
|
1610
|
+
# Authentication setting
|
|
1611
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1612
|
+
|
|
1613
|
+
return self.api_client.call_api(
|
|
1614
|
+
'/containers/{container_id}/files/{file_name}', 'GET',
|
|
1615
|
+
path_params,
|
|
1616
|
+
query_params,
|
|
1617
|
+
header_params,
|
|
1618
|
+
body=body_params,
|
|
1619
|
+
post_params=form_params,
|
|
1620
|
+
files=local_var_files,
|
|
1621
|
+
response_type='union[DownloadTicketStub,ZipfileInfo]', # noqa: E501
|
|
1622
|
+
auth_settings=auth_settings,
|
|
1623
|
+
async_=params.get('async_'),
|
|
1624
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1625
|
+
_preload_content=params.get('_preload_content', True),
|
|
1626
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1627
|
+
_request_out=params.get('_request_out'),
|
|
1628
|
+
collection_formats=collection_formats)
|
|
1629
|
+
|
|
1630
|
+
def get_container_file_zip_info(self, container_id, file_name, **kwargs): # noqa: E501
|
|
1631
|
+
"""Retrieve the zip info of a child file by name.
|
|
1632
|
+
|
|
1633
|
+
Does not work on files whose names contain a forward slash.
|
|
1634
|
+
This method makes a synchronous HTTP request by default.
|
|
1635
|
+
|
|
1636
|
+
:param str container_id: 24-character hex ID (required)
|
|
1637
|
+
:param str file_name: output file name (required)
|
|
1638
|
+
:param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1639
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1640
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1641
|
+
:param bool view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\"
|
|
1642
|
+
:param int version: version of the file to download
|
|
1643
|
+
:param str hash: file hash for comparison
|
|
1644
|
+
:param str range: byte ranges to return
|
|
1645
|
+
:param list[str] x_accept_feature: redirect header
|
|
1646
|
+
:param bool async_: Perform the request asynchronously
|
|
1647
|
+
:return: FileZipInfo
|
|
1648
|
+
"""
|
|
1649
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1650
|
+
kwargs['_return_http_data_only'] = True
|
|
1651
|
+
|
|
1652
|
+
if kwargs.get('async_'):
|
|
1653
|
+
return self.get_container_file_zip_info_with_http_info(container_id, file_name, **kwargs) # noqa: E501
|
|
1654
|
+
else:
|
|
1655
|
+
(data) = self.get_container_file_zip_info_with_http_info(container_id, file_name, **kwargs) # noqa: E501
|
|
1656
|
+
if (
|
|
1657
|
+
data
|
|
1658
|
+
and hasattr(data, 'return_value')
|
|
1659
|
+
and not ignore_simplified_return_value
|
|
1660
|
+
):
|
|
1661
|
+
return data.return_value()
|
|
1662
|
+
return data
|
|
1663
|
+
|
|
1664
|
+
|
|
1665
|
+
def get_container_file_zip_info_with_http_info(self, container_id, file_name, **kwargs): # noqa: E501
|
|
1666
|
+
"""Retrieve the zip info of a child file by name.
|
|
1667
|
+
|
|
1668
|
+
Does not work on files whose names contain a forward slash.
|
|
1669
|
+
This method makes a synchronous HTTP request by default.
|
|
1670
|
+
|
|
1671
|
+
:param str container_id: 24-character hex ID (required)
|
|
1672
|
+
:param str file_name: output file name (required)
|
|
1673
|
+
:param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1674
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1675
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1676
|
+
:param bool view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\"
|
|
1677
|
+
:param int version: version of the file to download
|
|
1678
|
+
:param str hash: file hash for comparison
|
|
1679
|
+
:param str range: byte ranges to return
|
|
1680
|
+
:param list[str] x_accept_feature: redirect header
|
|
1681
|
+
:param bool async_: Perform the request asynchronously
|
|
1682
|
+
:return: FileZipInfo
|
|
1683
|
+
"""
|
|
1684
|
+
|
|
1685
|
+
all_params = ['container_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
1686
|
+
all_params.append('async_')
|
|
1687
|
+
all_params.append('_return_http_data_only')
|
|
1688
|
+
all_params.append('_preload_content')
|
|
1689
|
+
all_params.append('_request_timeout')
|
|
1690
|
+
all_params.append('_request_out')
|
|
1691
|
+
|
|
1692
|
+
params = locals()
|
|
1693
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1694
|
+
if key not in all_params:
|
|
1695
|
+
raise TypeError(
|
|
1696
|
+
"Got an unexpected keyword argument '%s'"
|
|
1697
|
+
" to method get_container_file_zip_info" % key
|
|
1698
|
+
)
|
|
1699
|
+
params[key] = val
|
|
1700
|
+
del params['kwargs']
|
|
1701
|
+
# verify the required parameter 'container_id' is set
|
|
1702
|
+
if ('container_id' not in params or
|
|
1703
|
+
params['container_id'] is None):
|
|
1704
|
+
raise ValueError("Missing the required parameter `container_id` when calling `get_container_file_zip_info`") # noqa: E501
|
|
1705
|
+
# verify the required parameter 'file_name' is set
|
|
1706
|
+
if ('file_name' not in params or
|
|
1707
|
+
params['file_name'] is None):
|
|
1708
|
+
raise ValueError("Missing the required parameter `file_name` when calling `get_container_file_zip_info`") # noqa: E501
|
|
1709
|
+
check_filename_params(params)
|
|
1710
|
+
|
|
1711
|
+
collection_formats = {}
|
|
1712
|
+
|
|
1713
|
+
path_params = {}
|
|
1714
|
+
if 'container_id' in params:
|
|
1715
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
1716
|
+
if 'file_name' in params:
|
|
1717
|
+
path_params['file_name'] = params['file_name'] # noqa: E501
|
|
1718
|
+
|
|
1719
|
+
query_params = []
|
|
1720
|
+
if 'ticket' in params:
|
|
1721
|
+
query_params.append(('ticket', params['ticket'])) # noqa: E501
|
|
1722
|
+
if 'info' in params:
|
|
1723
|
+
query_params.append(('info', params['info'])) # noqa: E501
|
|
1724
|
+
else:
|
|
1725
|
+
query_params.append(('info', 'true'))
|
|
1726
|
+
if 'member' in params:
|
|
1727
|
+
query_params.append(('member', params['member'])) # noqa: E501
|
|
1728
|
+
if 'view' in params:
|
|
1729
|
+
query_params.append(('view', params['view'])) # noqa: E501
|
|
1730
|
+
if 'version' in params:
|
|
1731
|
+
query_params.append(('version', params['version'])) # noqa: E501
|
|
1732
|
+
if 'hash' in params:
|
|
1733
|
+
query_params.append(('hash', params['hash'])) # noqa: E501
|
|
1734
|
+
|
|
1735
|
+
header_params = {}
|
|
1736
|
+
if 'range' in params:
|
|
1737
|
+
header_params['range'] = params['range'] # noqa: E501
|
|
1738
|
+
if 'x_accept_feature' in params:
|
|
1739
|
+
header_params['x-accept-feature'] = params['x_accept_feature'] # noqa: E501
|
|
1740
|
+
collection_formats['x-accept-feature'] = '' # noqa: E501
|
|
1741
|
+
|
|
1742
|
+
form_params = []
|
|
1743
|
+
local_var_files = {}
|
|
1744
|
+
|
|
1745
|
+
body_params = None
|
|
1746
|
+
# HTTP header `Accept`
|
|
1747
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1748
|
+
['application/json']) # noqa: E501
|
|
1749
|
+
|
|
1750
|
+
# Authentication setting
|
|
1751
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1752
|
+
|
|
1753
|
+
return self.api_client.call_api(
|
|
1754
|
+
'/containers/{container_id}/files/{file_name}', 'GET',
|
|
1755
|
+
path_params,
|
|
1756
|
+
query_params,
|
|
1757
|
+
header_params,
|
|
1758
|
+
body=body_params,
|
|
1759
|
+
post_params=form_params,
|
|
1760
|
+
files=local_var_files,
|
|
1761
|
+
response_type='FileZipInfo', # noqa: E501
|
|
1762
|
+
auth_settings=auth_settings,
|
|
1763
|
+
async_=params.get('async_'),
|
|
1764
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1765
|
+
_preload_content=params.get('_preload_content', True),
|
|
1766
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1767
|
+
_request_out=params.get('_request_out'),
|
|
1768
|
+
collection_formats=collection_formats)
|
|
1769
|
+
|
|
1770
|
+
def get_container_download_ticket(self, container_id, file_name, **kwargs): # noqa: E501
|
|
1771
|
+
"""Get a signed URL to download a named child file.
|
|
1772
|
+
|
|
1773
|
+
This method makes a synchronous HTTP request by default.
|
|
1774
|
+
|
|
1775
|
+
:param str container_id: 24-character hex ID (required)
|
|
1776
|
+
:param str file_name: output file name (required)
|
|
1777
|
+
:param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1778
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1779
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1780
|
+
:param bool view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\"
|
|
1781
|
+
:param int version: version of the file to download
|
|
1782
|
+
:param str hash: file hash for comparison
|
|
1783
|
+
:param str range: byte ranges to return
|
|
1784
|
+
:param list[str] x_accept_feature: redirect header
|
|
1785
|
+
:param bool async_: Perform the request asynchronously
|
|
1786
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
1787
|
+
"""
|
|
1788
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1789
|
+
kwargs['_return_http_data_only'] = True
|
|
1790
|
+
|
|
1791
|
+
if kwargs.get('async_'):
|
|
1792
|
+
return self.get_container_download_ticket_with_http_info(container_id, file_name, **kwargs) # noqa: E501
|
|
1793
|
+
else:
|
|
1794
|
+
(data) = self.get_container_download_ticket_with_http_info(container_id, file_name, **kwargs) # noqa: E501
|
|
1795
|
+
if (
|
|
1796
|
+
data
|
|
1797
|
+
and hasattr(data, 'return_value')
|
|
1798
|
+
and not ignore_simplified_return_value
|
|
1799
|
+
):
|
|
1800
|
+
return data.return_value()
|
|
1801
|
+
return data
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
def get_container_download_ticket_with_http_info(self, container_id, file_name, **kwargs): # noqa: E501
|
|
1805
|
+
"""Get a signed URL to download a named child file.
|
|
1806
|
+
|
|
1807
|
+
This method makes a synchronous HTTP request by default.
|
|
1808
|
+
|
|
1809
|
+
:param str container_id: 24-character hex ID (required)
|
|
1810
|
+
:param str file_name: output file name (required)
|
|
1811
|
+
:param str ticket: The generated ticket id for the download, or present but empty to generate a ticket id
|
|
1812
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
1813
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
1814
|
+
:param bool view: If true, the proper \"Content-Type\" header based on the file's mimetype is set on response If false, the \"Content-Type\" header is set to \"application/octet-stream\"
|
|
1815
|
+
:param int version: version of the file to download
|
|
1816
|
+
:param str hash: file hash for comparison
|
|
1817
|
+
:param str range: byte ranges to return
|
|
1818
|
+
:param list[str] x_accept_feature: redirect header
|
|
1819
|
+
:param bool async_: Perform the request asynchronously
|
|
1820
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
1821
|
+
"""
|
|
1822
|
+
|
|
1823
|
+
all_params = ['container_id','file_name','ticket','info','member','view','version','hash','range','x_accept_feature',] # noqa: E501
|
|
1824
|
+
all_params.append('async_')
|
|
1825
|
+
all_params.append('_return_http_data_only')
|
|
1826
|
+
all_params.append('_preload_content')
|
|
1827
|
+
all_params.append('_request_timeout')
|
|
1828
|
+
all_params.append('_request_out')
|
|
1829
|
+
|
|
1830
|
+
params = locals()
|
|
1831
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1832
|
+
if key not in all_params:
|
|
1833
|
+
raise TypeError(
|
|
1834
|
+
"Got an unexpected keyword argument '%s'"
|
|
1835
|
+
" to method get_container_download_ticket" % key
|
|
1836
|
+
)
|
|
1837
|
+
params[key] = val
|
|
1838
|
+
del params['kwargs']
|
|
1839
|
+
# verify the required parameter 'container_id' is set
|
|
1840
|
+
if ('container_id' not in params or
|
|
1841
|
+
params['container_id'] is None):
|
|
1842
|
+
raise ValueError("Missing the required parameter `container_id` when calling `get_container_download_ticket`") # noqa: E501
|
|
1843
|
+
# verify the required parameter 'file_name' is set
|
|
1844
|
+
if ('file_name' not in params or
|
|
1845
|
+
params['file_name'] is None):
|
|
1846
|
+
raise ValueError("Missing the required parameter `file_name` when calling `get_container_download_ticket`") # noqa: E501
|
|
1847
|
+
check_filename_params(params)
|
|
1848
|
+
|
|
1849
|
+
collection_formats = {}
|
|
1850
|
+
|
|
1851
|
+
path_params = {}
|
|
1852
|
+
if 'container_id' in params:
|
|
1853
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
1854
|
+
if 'file_name' in params:
|
|
1855
|
+
path_params['file_name'] = params['file_name'] # noqa: E501
|
|
1856
|
+
|
|
1857
|
+
query_params = []
|
|
1858
|
+
if 'ticket' in params:
|
|
1859
|
+
query_params.append(('ticket', params['ticket'])) # noqa: E501
|
|
1860
|
+
if 'info' in params:
|
|
1861
|
+
query_params.append(('info', params['info'])) # noqa: E501
|
|
1862
|
+
if 'member' in params:
|
|
1863
|
+
query_params.append(('member', params['member'])) # noqa: E501
|
|
1864
|
+
if 'view' in params:
|
|
1865
|
+
query_params.append(('view', params['view'])) # noqa: E501
|
|
1866
|
+
if 'version' in params:
|
|
1867
|
+
query_params.append(('version', params['version'])) # noqa: E501
|
|
1868
|
+
if 'hash' in params:
|
|
1869
|
+
query_params.append(('hash', params['hash'])) # noqa: E501
|
|
1870
|
+
|
|
1871
|
+
header_params = {}
|
|
1872
|
+
if 'range' in params:
|
|
1873
|
+
header_params['range'] = params['range'] # noqa: E501
|
|
1874
|
+
if 'x_accept_feature' in params:
|
|
1875
|
+
header_params['x-accept-feature'] = params['x_accept_feature'] # noqa: E501
|
|
1876
|
+
collection_formats['x-accept-feature'] = '' # noqa: E501
|
|
1877
|
+
|
|
1878
|
+
form_params = []
|
|
1879
|
+
local_var_files = {}
|
|
1880
|
+
|
|
1881
|
+
body_params = None
|
|
1882
|
+
# HTTP header `Accept`
|
|
1883
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1884
|
+
['application/json']) # noqa: E501
|
|
1885
|
+
|
|
1886
|
+
# Authentication setting
|
|
1887
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1888
|
+
|
|
1889
|
+
return self.api_client.call_api(
|
|
1890
|
+
'/containers/{container_id}/files/{file_name}', 'GET',
|
|
1891
|
+
path_params,
|
|
1892
|
+
query_params,
|
|
1893
|
+
header_params,
|
|
1894
|
+
body=body_params,
|
|
1895
|
+
post_params=form_params,
|
|
1896
|
+
files=local_var_files,
|
|
1897
|
+
response_type='union[DownloadTicketStub,ZipfileInfo]', # noqa: E501
|
|
1898
|
+
auth_settings=auth_settings,
|
|
1899
|
+
async_=params.get('async_'),
|
|
1900
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1901
|
+
_preload_content=params.get('_preload_content', True),
|
|
1902
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1903
|
+
_request_out=params.get('_request_out'),
|
|
1904
|
+
collection_formats=collection_formats)
|
|
1905
|
+
|
|
1906
|
+
def download_input_from_container_analysis(self, container_id, analysis_id, filename, dest_file, **kwargs): # noqa: E501
|
|
1907
|
+
"""Download analysis inputs with filter.
|
|
1908
|
+
|
|
1909
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
1910
|
+
This method makes a synchronous HTTP request by default.
|
|
1911
|
+
|
|
1912
|
+
:param str container_id: 24-character hex ID (required)
|
|
1913
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
1914
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
1915
|
+
:param bool info: get file info only
|
|
1916
|
+
:param str member: get zipfile member
|
|
1917
|
+
:param bool view: feature flag for view/download
|
|
1918
|
+
:param str range: byte ranges to return
|
|
1919
|
+
:param list[str] x_accept_feature: redirect header
|
|
1920
|
+
:param str dest_file: Destination file path
|
|
1921
|
+
:param bool async_: Perform the request asynchronously
|
|
1922
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
1923
|
+
"""
|
|
1924
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1925
|
+
kwargs['_return_http_data_only'] = True
|
|
1926
|
+
|
|
1927
|
+
kwargs['_preload_content'] = False
|
|
1928
|
+
# Stream response to file
|
|
1929
|
+
with open(dest_file, 'wb') as out_file:
|
|
1930
|
+
(resp) = self.download_input_from_container_analysis_with_http_info(container_id, analysis_id, filename, **kwargs) # noqa: E501
|
|
1931
|
+
if resp:
|
|
1932
|
+
try:
|
|
1933
|
+
for chunk in resp.iter_content(chunk_size=65536):
|
|
1934
|
+
out_file.write(chunk)
|
|
1935
|
+
finally:
|
|
1936
|
+
resp.close()
|
|
1937
|
+
|
|
1938
|
+
|
|
1939
|
+
def download_input_from_container_analysis_with_http_info(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
1940
|
+
"""Download analysis inputs with filter.
|
|
1941
|
+
|
|
1942
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
1943
|
+
This method makes a synchronous HTTP request by default.
|
|
1944
|
+
|
|
1945
|
+
:param str container_id: 24-character hex ID (required)
|
|
1946
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
1947
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
1948
|
+
:param bool info: get file info only
|
|
1949
|
+
:param str member: get zipfile member
|
|
1950
|
+
:param bool view: feature flag for view/download
|
|
1951
|
+
:param str range: byte ranges to return
|
|
1952
|
+
:param list[str] x_accept_feature: redirect header
|
|
1953
|
+
:param bool async_: Perform the request asynchronously
|
|
1954
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
1955
|
+
"""
|
|
1956
|
+
|
|
1957
|
+
all_params = ['container_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
1958
|
+
all_params.append('async_')
|
|
1959
|
+
all_params.append('_return_http_data_only')
|
|
1960
|
+
all_params.append('_preload_content')
|
|
1961
|
+
all_params.append('_request_timeout')
|
|
1962
|
+
all_params.append('_request_out')
|
|
1963
|
+
|
|
1964
|
+
params = locals()
|
|
1965
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1966
|
+
if key not in all_params:
|
|
1967
|
+
raise TypeError(
|
|
1968
|
+
"Got an unexpected keyword argument '%s'"
|
|
1969
|
+
" to method download_input_from_container_analysis" % key
|
|
1970
|
+
)
|
|
1971
|
+
params[key] = val
|
|
1972
|
+
del params['kwargs']
|
|
1973
|
+
# verify the required parameter 'container_id' is set
|
|
1974
|
+
if ('container_id' not in params or
|
|
1975
|
+
params['container_id'] is None):
|
|
1976
|
+
raise ValueError("Missing the required parameter `container_id` when calling `download_input_from_container_analysis`") # noqa: E501
|
|
1977
|
+
# verify the required parameter 'analysis_id' is set
|
|
1978
|
+
if ('analysis_id' not in params or
|
|
1979
|
+
params['analysis_id'] is None):
|
|
1980
|
+
raise ValueError("Missing the required parameter `analysis_id` when calling `download_input_from_container_analysis`") # noqa: E501
|
|
1981
|
+
# verify the required parameter 'filename' is set
|
|
1982
|
+
if ('filename' not in params or
|
|
1983
|
+
params['filename'] is None):
|
|
1984
|
+
raise ValueError("Missing the required parameter `filename` when calling `download_input_from_container_analysis`") # noqa: E501
|
|
1985
|
+
check_filename_params(params)
|
|
1986
|
+
|
|
1987
|
+
collection_formats = {}
|
|
1988
|
+
|
|
1989
|
+
path_params = {}
|
|
1990
|
+
if 'container_id' in params:
|
|
1991
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
1992
|
+
if 'analysis_id' in params:
|
|
1993
|
+
path_params['analysis_id'] = params['analysis_id'] # noqa: E501
|
|
1994
|
+
if 'filename' in params:
|
|
1995
|
+
path_params['filename'] = params['filename'] # noqa: E501
|
|
1996
|
+
|
|
1997
|
+
query_params = []
|
|
1998
|
+
if 'info' in params:
|
|
1999
|
+
query_params.append(('info', params['info'])) # noqa: E501
|
|
2000
|
+
if 'member' in params:
|
|
2001
|
+
query_params.append(('member', params['member'])) # noqa: E501
|
|
2002
|
+
if 'view' in params:
|
|
2003
|
+
query_params.append(('view', params['view'])) # noqa: E501
|
|
2004
|
+
|
|
2005
|
+
header_params = {}
|
|
2006
|
+
if 'range' in params:
|
|
2007
|
+
header_params['range'] = params['range'] # noqa: E501
|
|
2008
|
+
if 'x_accept_feature' in params:
|
|
2009
|
+
header_params['x-accept-feature'] = params['x_accept_feature'] # noqa: E501
|
|
2010
|
+
collection_formats['x-accept-feature'] = '' # noqa: E501
|
|
2011
|
+
|
|
2012
|
+
form_params = []
|
|
2013
|
+
local_var_files = {}
|
|
2014
|
+
|
|
2015
|
+
body_params = None
|
|
2016
|
+
# HTTP header `Accept`
|
|
2017
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2018
|
+
['application/octet-stream']) # noqa: E501
|
|
2019
|
+
|
|
2020
|
+
# Authentication setting
|
|
2021
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
2022
|
+
|
|
2023
|
+
return self.api_client.call_api(
|
|
2024
|
+
'/containers/{container_id}/analyses/{analysis_id}/inputs/{filename}', 'GET',
|
|
2025
|
+
path_params,
|
|
2026
|
+
query_params,
|
|
2027
|
+
header_params,
|
|
2028
|
+
body=body_params,
|
|
2029
|
+
post_params=form_params,
|
|
2030
|
+
files=local_var_files,
|
|
2031
|
+
response_type='union[DownloadTicketStub,ZipfileInfo]', # noqa: E501
|
|
2032
|
+
auth_settings=auth_settings,
|
|
2033
|
+
async_=params.get('async_'),
|
|
2034
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2035
|
+
_preload_content=params.get('_preload_content', True),
|
|
2036
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2037
|
+
_request_out=params.get('_request_out'),
|
|
2038
|
+
collection_formats=collection_formats)
|
|
2039
|
+
|
|
2040
|
+
def get_container_analysis_input_zip_info(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2041
|
+
"""Retrieve the zip info of a child file by name.
|
|
2042
|
+
|
|
2043
|
+
Does not work on files whose names contain a forward slash.
|
|
2044
|
+
This method makes a synchronous HTTP request by default.
|
|
2045
|
+
|
|
2046
|
+
:param str container_id: 24-character hex ID (required)
|
|
2047
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2048
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2049
|
+
:param str ticket: 24-char hex ticket id
|
|
2050
|
+
:param bool info: get file info only
|
|
2051
|
+
:param str member: get zipfile member
|
|
2052
|
+
:param bool view: feature flag for view/download
|
|
2053
|
+
:param str range: byte ranges to return
|
|
2054
|
+
:param list[str] x_accept_feature: redirect header
|
|
2055
|
+
:param bool async_: Perform the request asynchronously
|
|
2056
|
+
:return: FileZipInfo
|
|
2057
|
+
"""
|
|
2058
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2059
|
+
kwargs['_return_http_data_only'] = True
|
|
2060
|
+
|
|
2061
|
+
if kwargs.get('async_'):
|
|
2062
|
+
return self.get_container_analysis_input_zip_info_with_http_info(container_id, analysis_id, filename, **kwargs) # noqa: E501
|
|
2063
|
+
else:
|
|
2064
|
+
(data) = self.get_container_analysis_input_zip_info_with_http_info(container_id, analysis_id, filename, **kwargs) # noqa: E501
|
|
2065
|
+
if (
|
|
2066
|
+
data
|
|
2067
|
+
and hasattr(data, 'return_value')
|
|
2068
|
+
and not ignore_simplified_return_value
|
|
2069
|
+
):
|
|
2070
|
+
return data.return_value()
|
|
2071
|
+
return data
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
def get_container_analysis_input_zip_info_with_http_info(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2075
|
+
"""Retrieve the zip info of a child file by name.
|
|
2076
|
+
|
|
2077
|
+
Does not work on files whose names contain a forward slash.
|
|
2078
|
+
This method makes a synchronous HTTP request by default.
|
|
2079
|
+
|
|
2080
|
+
:param str container_id: 24-character hex ID (required)
|
|
2081
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2082
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2083
|
+
:param str ticket: 24-char hex ticket id
|
|
2084
|
+
:param bool info: get file info only
|
|
2085
|
+
:param str member: get zipfile member
|
|
2086
|
+
:param bool view: feature flag for view/download
|
|
2087
|
+
:param str range: byte ranges to return
|
|
2088
|
+
:param list[str] x_accept_feature: redirect header
|
|
2089
|
+
:param bool async_: Perform the request asynchronously
|
|
2090
|
+
:return: FileZipInfo
|
|
2091
|
+
"""
|
|
2092
|
+
|
|
2093
|
+
all_params = ['container_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
2094
|
+
all_params.append('async_')
|
|
2095
|
+
all_params.append('_return_http_data_only')
|
|
2096
|
+
all_params.append('_preload_content')
|
|
2097
|
+
all_params.append('_request_timeout')
|
|
2098
|
+
all_params.append('_request_out')
|
|
2099
|
+
|
|
2100
|
+
params = locals()
|
|
2101
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2102
|
+
if key not in all_params:
|
|
2103
|
+
raise TypeError(
|
|
2104
|
+
"Got an unexpected keyword argument '%s'"
|
|
2105
|
+
" to method get_container_analysis_input_zip_info" % key
|
|
2106
|
+
)
|
|
2107
|
+
params[key] = val
|
|
2108
|
+
del params['kwargs']
|
|
2109
|
+
# verify the required parameter 'container_id' is set
|
|
2110
|
+
if ('container_id' not in params or
|
|
2111
|
+
params['container_id'] is None):
|
|
2112
|
+
raise ValueError("Missing the required parameter `container_id` when calling `get_container_analysis_input_zip_info`") # noqa: E501
|
|
2113
|
+
# verify the required parameter 'analysis_id' is set
|
|
2114
|
+
if ('analysis_id' not in params or
|
|
2115
|
+
params['analysis_id'] is None):
|
|
2116
|
+
raise ValueError("Missing the required parameter `analysis_id` when calling `get_container_analysis_input_zip_info`") # noqa: E501
|
|
2117
|
+
# verify the required parameter 'filename' is set
|
|
2118
|
+
if ('filename' not in params or
|
|
2119
|
+
params['filename'] is None):
|
|
2120
|
+
raise ValueError("Missing the required parameter `filename` when calling `get_container_analysis_input_zip_info`") # noqa: E501
|
|
2121
|
+
check_filename_params(params)
|
|
2122
|
+
|
|
2123
|
+
collection_formats = {}
|
|
2124
|
+
|
|
2125
|
+
path_params = {}
|
|
2126
|
+
if 'container_id' in params:
|
|
2127
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
2128
|
+
if 'analysis_id' in params:
|
|
2129
|
+
path_params['analysis_id'] = params['analysis_id'] # noqa: E501
|
|
2130
|
+
if 'filename' in params:
|
|
2131
|
+
path_params['filename'] = params['filename'] # noqa: E501
|
|
2132
|
+
|
|
2133
|
+
query_params = []
|
|
2134
|
+
if 'ticket' in params:
|
|
2135
|
+
query_params.append(('ticket', params['ticket'])) # noqa: E501
|
|
2136
|
+
if 'info' in params:
|
|
2137
|
+
query_params.append(('info', params['info'])) # noqa: E501
|
|
2138
|
+
else:
|
|
2139
|
+
query_params.append(('info', 'true'))
|
|
2140
|
+
if 'member' in params:
|
|
2141
|
+
query_params.append(('member', params['member'])) # noqa: E501
|
|
2142
|
+
if 'view' in params:
|
|
2143
|
+
query_params.append(('view', params['view'])) # noqa: E501
|
|
2144
|
+
|
|
2145
|
+
header_params = {}
|
|
2146
|
+
if 'range' in params:
|
|
2147
|
+
header_params['range'] = params['range'] # noqa: E501
|
|
2148
|
+
if 'x_accept_feature' in params:
|
|
2149
|
+
header_params['x-accept-feature'] = params['x_accept_feature'] # noqa: E501
|
|
2150
|
+
collection_formats['x-accept-feature'] = '' # noqa: E501
|
|
2151
|
+
|
|
2152
|
+
form_params = []
|
|
2153
|
+
local_var_files = {}
|
|
2154
|
+
|
|
2155
|
+
body_params = None
|
|
2156
|
+
# HTTP header `Accept`
|
|
2157
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2158
|
+
['application/json']) # noqa: E501
|
|
2159
|
+
|
|
2160
|
+
# Authentication setting
|
|
2161
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
2162
|
+
|
|
2163
|
+
return self.api_client.call_api(
|
|
2164
|
+
'/containers/{container_id}/analyses/{analysis_id}/inputs/{filename}', 'GET',
|
|
2165
|
+
path_params,
|
|
2166
|
+
query_params,
|
|
2167
|
+
header_params,
|
|
2168
|
+
body=body_params,
|
|
2169
|
+
post_params=form_params,
|
|
2170
|
+
files=local_var_files,
|
|
2171
|
+
response_type='FileZipInfo', # noqa: E501
|
|
2172
|
+
auth_settings=auth_settings,
|
|
2173
|
+
async_=params.get('async_'),
|
|
2174
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2175
|
+
_preload_content=params.get('_preload_content', True),
|
|
2176
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2177
|
+
_request_out=params.get('_request_out'),
|
|
2178
|
+
collection_formats=collection_formats)
|
|
2179
|
+
|
|
2180
|
+
def get_container_analysis_input_download_ticket(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2181
|
+
"""Get a signed URL to download a named child file.
|
|
2182
|
+
|
|
2183
|
+
This method makes a synchronous HTTP request by default.
|
|
2184
|
+
|
|
2185
|
+
:param str container_id: 24-character hex ID (required)
|
|
2186
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2187
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2188
|
+
:param str ticket: 24-char hex ticket id
|
|
2189
|
+
:param bool info: get file info only
|
|
2190
|
+
:param str member: get zipfile member
|
|
2191
|
+
:param bool view: feature flag for view/download
|
|
2192
|
+
:param str range: byte ranges to return
|
|
2193
|
+
:param list[str] x_accept_feature: redirect header
|
|
2194
|
+
:param bool async_: Perform the request asynchronously
|
|
2195
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2196
|
+
"""
|
|
2197
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2198
|
+
kwargs['_return_http_data_only'] = True
|
|
2199
|
+
|
|
2200
|
+
if kwargs.get('async_'):
|
|
2201
|
+
return self.get_container_analysis_input_download_ticket_with_http_info(container_id, analysis_id, filename, **kwargs) # noqa: E501
|
|
2202
|
+
else:
|
|
2203
|
+
(data) = self.get_container_analysis_input_download_ticket_with_http_info(container_id, analysis_id, filename, **kwargs) # noqa: E501
|
|
2204
|
+
if (
|
|
2205
|
+
data
|
|
2206
|
+
and hasattr(data, 'return_value')
|
|
2207
|
+
and not ignore_simplified_return_value
|
|
2208
|
+
):
|
|
2209
|
+
return data.return_value()
|
|
2210
|
+
return data
|
|
2211
|
+
|
|
2212
|
+
|
|
2213
|
+
def get_container_analysis_input_download_ticket_with_http_info(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2214
|
+
"""Get a signed URL to download a named child file.
|
|
2215
|
+
|
|
2216
|
+
This method makes a synchronous HTTP request by default.
|
|
2217
|
+
|
|
2218
|
+
:param str container_id: 24-character hex ID (required)
|
|
2219
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2220
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2221
|
+
:param str ticket: 24-char hex ticket id
|
|
2222
|
+
:param bool info: get file info only
|
|
2223
|
+
:param str member: get zipfile member
|
|
2224
|
+
:param bool view: feature flag for view/download
|
|
2225
|
+
:param str range: byte ranges to return
|
|
2226
|
+
:param list[str] x_accept_feature: redirect header
|
|
2227
|
+
:param bool async_: Perform the request asynchronously
|
|
2228
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2229
|
+
"""
|
|
2230
|
+
|
|
2231
|
+
all_params = ['container_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
2232
|
+
all_params.append('async_')
|
|
2233
|
+
all_params.append('_return_http_data_only')
|
|
2234
|
+
all_params.append('_preload_content')
|
|
2235
|
+
all_params.append('_request_timeout')
|
|
2236
|
+
all_params.append('_request_out')
|
|
2237
|
+
|
|
2238
|
+
params = locals()
|
|
2239
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2240
|
+
if key not in all_params:
|
|
2241
|
+
raise TypeError(
|
|
2242
|
+
"Got an unexpected keyword argument '%s'"
|
|
2243
|
+
" to method get_container_analysis_input_download_ticket" % key
|
|
2244
|
+
)
|
|
2245
|
+
params[key] = val
|
|
2246
|
+
del params['kwargs']
|
|
2247
|
+
# verify the required parameter 'container_id' is set
|
|
2248
|
+
if ('container_id' not in params or
|
|
2249
|
+
params['container_id'] is None):
|
|
2250
|
+
raise ValueError("Missing the required parameter `container_id` when calling `get_container_analysis_input_download_ticket`") # noqa: E501
|
|
2251
|
+
# verify the required parameter 'analysis_id' is set
|
|
2252
|
+
if ('analysis_id' not in params or
|
|
2253
|
+
params['analysis_id'] is None):
|
|
2254
|
+
raise ValueError("Missing the required parameter `analysis_id` when calling `get_container_analysis_input_download_ticket`") # noqa: E501
|
|
2255
|
+
# verify the required parameter 'filename' is set
|
|
2256
|
+
if ('filename' not in params or
|
|
2257
|
+
params['filename'] is None):
|
|
2258
|
+
raise ValueError("Missing the required parameter `filename` when calling `get_container_analysis_input_download_ticket`") # noqa: E501
|
|
2259
|
+
check_filename_params(params)
|
|
2260
|
+
|
|
2261
|
+
collection_formats = {}
|
|
2262
|
+
|
|
2263
|
+
path_params = {}
|
|
2264
|
+
if 'container_id' in params:
|
|
2265
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
2266
|
+
if 'analysis_id' in params:
|
|
2267
|
+
path_params['analysis_id'] = params['analysis_id'] # noqa: E501
|
|
2268
|
+
if 'filename' in params:
|
|
2269
|
+
path_params['filename'] = params['filename'] # noqa: E501
|
|
2270
|
+
|
|
2271
|
+
query_params = []
|
|
2272
|
+
if 'ticket' in params:
|
|
2273
|
+
query_params.append(('ticket', params['ticket'])) # noqa: E501
|
|
2274
|
+
if 'info' in params:
|
|
2275
|
+
query_params.append(('info', params['info'])) # noqa: E501
|
|
2276
|
+
if 'member' in params:
|
|
2277
|
+
query_params.append(('member', params['member'])) # noqa: E501
|
|
2278
|
+
if 'view' in params:
|
|
2279
|
+
query_params.append(('view', params['view'])) # noqa: E501
|
|
2280
|
+
|
|
2281
|
+
header_params = {}
|
|
2282
|
+
if 'range' in params:
|
|
2283
|
+
header_params['range'] = params['range'] # noqa: E501
|
|
2284
|
+
if 'x_accept_feature' in params:
|
|
2285
|
+
header_params['x-accept-feature'] = params['x_accept_feature'] # noqa: E501
|
|
2286
|
+
collection_formats['x-accept-feature'] = '' # noqa: E501
|
|
2287
|
+
|
|
2288
|
+
form_params = []
|
|
2289
|
+
local_var_files = {}
|
|
2290
|
+
|
|
2291
|
+
body_params = None
|
|
2292
|
+
# HTTP header `Accept`
|
|
2293
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2294
|
+
['application/json']) # noqa: E501
|
|
2295
|
+
|
|
2296
|
+
# Authentication setting
|
|
2297
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
2298
|
+
|
|
2299
|
+
return self.api_client.call_api(
|
|
2300
|
+
'/containers/{container_id}/analyses/{analysis_id}/inputs/{filename}', 'GET',
|
|
2301
|
+
path_params,
|
|
2302
|
+
query_params,
|
|
2303
|
+
header_params,
|
|
2304
|
+
body=body_params,
|
|
2305
|
+
post_params=form_params,
|
|
2306
|
+
files=local_var_files,
|
|
2307
|
+
response_type='union[DownloadTicketStub,ZipfileInfo]', # noqa: E501
|
|
2308
|
+
auth_settings=auth_settings,
|
|
2309
|
+
async_=params.get('async_'),
|
|
2310
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2311
|
+
_preload_content=params.get('_preload_content', True),
|
|
2312
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2313
|
+
_request_out=params.get('_request_out'),
|
|
2314
|
+
collection_formats=collection_formats)
|
|
2315
|
+
|
|
2316
|
+
def download_output_from_container_analysis(self, container_id, analysis_id, filename, dest_file, **kwargs): # noqa: E501
|
|
2317
|
+
"""Download analysis outputs with filter.
|
|
2318
|
+
|
|
2319
|
+
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2320
|
+
This method makes a synchronous HTTP request by default.
|
|
2321
|
+
|
|
2322
|
+
:param str container_id: 24-character hex ID (required)
|
|
2323
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2324
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2325
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2326
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2327
|
+
:param bool view: feature flag for view/download
|
|
2328
|
+
:param str range: byte ranges to return
|
|
2329
|
+
:param list[str] x_accept_feature: redirect header
|
|
2330
|
+
:param str dest_file: Destination file path
|
|
2331
|
+
:param bool async_: Perform the request asynchronously
|
|
2332
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2333
|
+
"""
|
|
2334
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2335
|
+
kwargs['_return_http_data_only'] = True
|
|
2336
|
+
|
|
2337
|
+
kwargs['_preload_content'] = False
|
|
2338
|
+
# Stream response to file
|
|
2339
|
+
with open(dest_file, 'wb') as out_file:
|
|
2340
|
+
(resp) = self.download_output_from_container_analysis_with_http_info(container_id, analysis_id, filename, **kwargs) # noqa: E501
|
|
2341
|
+
if resp:
|
|
2342
|
+
try:
|
|
2343
|
+
for chunk in resp.iter_content(chunk_size=65536):
|
|
2344
|
+
out_file.write(chunk)
|
|
2345
|
+
finally:
|
|
2346
|
+
resp.close()
|
|
2347
|
+
|
|
2348
|
+
|
|
2349
|
+
def download_output_from_container_analysis_with_http_info(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2350
|
+
"""Download analysis outputs with filter.
|
|
2351
|
+
|
|
2352
|
+
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2353
|
+
This method makes a synchronous HTTP request by default.
|
|
2354
|
+
|
|
2355
|
+
:param str container_id: 24-character hex ID (required)
|
|
2356
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2357
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2358
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2359
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2360
|
+
:param bool view: feature flag for view/download
|
|
2361
|
+
:param str range: byte ranges to return
|
|
2362
|
+
:param list[str] x_accept_feature: redirect header
|
|
2363
|
+
:param bool async_: Perform the request asynchronously
|
|
2364
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2365
|
+
"""
|
|
2366
|
+
|
|
2367
|
+
all_params = ['container_id','analysis_id','filename','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
2368
|
+
all_params.append('async_')
|
|
2369
|
+
all_params.append('_return_http_data_only')
|
|
2370
|
+
all_params.append('_preload_content')
|
|
2371
|
+
all_params.append('_request_timeout')
|
|
2372
|
+
all_params.append('_request_out')
|
|
2373
|
+
|
|
2374
|
+
params = locals()
|
|
2375
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2376
|
+
if key not in all_params:
|
|
2377
|
+
raise TypeError(
|
|
2378
|
+
"Got an unexpected keyword argument '%s'"
|
|
2379
|
+
" to method download_output_from_container_analysis" % key
|
|
2380
|
+
)
|
|
2381
|
+
params[key] = val
|
|
2382
|
+
del params['kwargs']
|
|
2383
|
+
# verify the required parameter 'container_id' is set
|
|
2384
|
+
if ('container_id' not in params or
|
|
2385
|
+
params['container_id'] is None):
|
|
2386
|
+
raise ValueError("Missing the required parameter `container_id` when calling `download_output_from_container_analysis`") # noqa: E501
|
|
2387
|
+
# verify the required parameter 'analysis_id' is set
|
|
2388
|
+
if ('analysis_id' not in params or
|
|
2389
|
+
params['analysis_id'] is None):
|
|
2390
|
+
raise ValueError("Missing the required parameter `analysis_id` when calling `download_output_from_container_analysis`") # noqa: E501
|
|
2391
|
+
# verify the required parameter 'filename' is set
|
|
2392
|
+
if ('filename' not in params or
|
|
2393
|
+
params['filename'] is None):
|
|
2394
|
+
raise ValueError("Missing the required parameter `filename` when calling `download_output_from_container_analysis`") # noqa: E501
|
|
2395
|
+
check_filename_params(params)
|
|
2396
|
+
|
|
2397
|
+
collection_formats = {}
|
|
2398
|
+
|
|
2399
|
+
path_params = {}
|
|
2400
|
+
if 'container_id' in params:
|
|
2401
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
2402
|
+
if 'analysis_id' in params:
|
|
2403
|
+
path_params['analysis_id'] = params['analysis_id'] # noqa: E501
|
|
2404
|
+
if 'filename' in params:
|
|
2405
|
+
path_params['filename'] = params['filename'] # noqa: E501
|
|
2406
|
+
|
|
2407
|
+
query_params = []
|
|
2408
|
+
if 'info' in params:
|
|
2409
|
+
query_params.append(('info', params['info'])) # noqa: E501
|
|
2410
|
+
if 'member' in params:
|
|
2411
|
+
query_params.append(('member', params['member'])) # noqa: E501
|
|
2412
|
+
if 'view' in params:
|
|
2413
|
+
query_params.append(('view', params['view'])) # noqa: E501
|
|
2414
|
+
|
|
2415
|
+
header_params = {}
|
|
2416
|
+
if 'range' in params:
|
|
2417
|
+
header_params['range'] = params['range'] # noqa: E501
|
|
2418
|
+
if 'x_accept_feature' in params:
|
|
2419
|
+
header_params['x-accept-feature'] = params['x_accept_feature'] # noqa: E501
|
|
2420
|
+
collection_formats['x-accept-feature'] = '' # noqa: E501
|
|
2421
|
+
|
|
2422
|
+
form_params = []
|
|
2423
|
+
local_var_files = {}
|
|
2424
|
+
|
|
2425
|
+
body_params = None
|
|
2426
|
+
# HTTP header `Accept`
|
|
2427
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2428
|
+
['application/octet-stream']) # noqa: E501
|
|
2429
|
+
|
|
2430
|
+
# Authentication setting
|
|
2431
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
2432
|
+
|
|
2433
|
+
return self.api_client.call_api(
|
|
2434
|
+
'/containers/{container_id}/analyses/{analysis_id}/files/{filename}', 'GET',
|
|
2435
|
+
path_params,
|
|
2436
|
+
query_params,
|
|
2437
|
+
header_params,
|
|
2438
|
+
body=body_params,
|
|
2439
|
+
post_params=form_params,
|
|
2440
|
+
files=local_var_files,
|
|
2441
|
+
response_type='union[DownloadTicketStub,ZipfileInfo]', # noqa: E501
|
|
2442
|
+
auth_settings=auth_settings,
|
|
2443
|
+
async_=params.get('async_'),
|
|
2444
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2445
|
+
_preload_content=params.get('_preload_content', True),
|
|
2446
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2447
|
+
_request_out=params.get('_request_out'),
|
|
2448
|
+
collection_formats=collection_formats)
|
|
2449
|
+
|
|
2450
|
+
def get_container_analysis_output_zip_info(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2451
|
+
"""Retrieve the zip info of a child file by name.
|
|
2452
|
+
|
|
2453
|
+
Does not work on files whose names contain a forward slash.
|
|
2454
|
+
This method makes a synchronous HTTP request by default.
|
|
2455
|
+
|
|
2456
|
+
:param str container_id: 24-character hex ID (required)
|
|
2457
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2458
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2459
|
+
:param str ticket: ticket id of the outputs to download
|
|
2460
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2461
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2462
|
+
:param bool view: feature flag for view/download
|
|
2463
|
+
:param str range: byte ranges to return
|
|
2464
|
+
:param list[str] x_accept_feature: redirect header
|
|
2465
|
+
:param bool async_: Perform the request asynchronously
|
|
2466
|
+
:return: FileZipInfo
|
|
2467
|
+
"""
|
|
2468
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2469
|
+
kwargs['_return_http_data_only'] = True
|
|
2470
|
+
|
|
2471
|
+
if kwargs.get('async_'):
|
|
2472
|
+
return self.get_container_analysis_output_zip_info_with_http_info(container_id, analysis_id, filename, **kwargs) # noqa: E501
|
|
2473
|
+
else:
|
|
2474
|
+
(data) = self.get_container_analysis_output_zip_info_with_http_info(container_id, analysis_id, filename, **kwargs) # noqa: E501
|
|
2475
|
+
if (
|
|
2476
|
+
data
|
|
2477
|
+
and hasattr(data, 'return_value')
|
|
2478
|
+
and not ignore_simplified_return_value
|
|
2479
|
+
):
|
|
2480
|
+
return data.return_value()
|
|
2481
|
+
return data
|
|
2482
|
+
|
|
2483
|
+
|
|
2484
|
+
def get_container_analysis_output_zip_info_with_http_info(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2485
|
+
"""Retrieve the zip info of a child file by name.
|
|
2486
|
+
|
|
2487
|
+
Does not work on files whose names contain a forward slash.
|
|
2488
|
+
This method makes a synchronous HTTP request by default.
|
|
2489
|
+
|
|
2490
|
+
:param str container_id: 24-character hex ID (required)
|
|
2491
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2492
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2493
|
+
:param str ticket: ticket id of the outputs to download
|
|
2494
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2495
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2496
|
+
:param bool view: feature flag for view/download
|
|
2497
|
+
:param str range: byte ranges to return
|
|
2498
|
+
:param list[str] x_accept_feature: redirect header
|
|
2499
|
+
:param bool async_: Perform the request asynchronously
|
|
2500
|
+
:return: FileZipInfo
|
|
2501
|
+
"""
|
|
2502
|
+
|
|
2503
|
+
all_params = ['container_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
2504
|
+
all_params.append('async_')
|
|
2505
|
+
all_params.append('_return_http_data_only')
|
|
2506
|
+
all_params.append('_preload_content')
|
|
2507
|
+
all_params.append('_request_timeout')
|
|
2508
|
+
all_params.append('_request_out')
|
|
2509
|
+
|
|
2510
|
+
params = locals()
|
|
2511
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2512
|
+
if key not in all_params:
|
|
2513
|
+
raise TypeError(
|
|
2514
|
+
"Got an unexpected keyword argument '%s'"
|
|
2515
|
+
" to method get_container_analysis_output_zip_info" % key
|
|
2516
|
+
)
|
|
2517
|
+
params[key] = val
|
|
2518
|
+
del params['kwargs']
|
|
2519
|
+
# verify the required parameter 'container_id' is set
|
|
2520
|
+
if ('container_id' not in params or
|
|
2521
|
+
params['container_id'] is None):
|
|
2522
|
+
raise ValueError("Missing the required parameter `container_id` when calling `get_container_analysis_output_zip_info`") # noqa: E501
|
|
2523
|
+
# verify the required parameter 'analysis_id' is set
|
|
2524
|
+
if ('analysis_id' not in params or
|
|
2525
|
+
params['analysis_id'] is None):
|
|
2526
|
+
raise ValueError("Missing the required parameter `analysis_id` when calling `get_container_analysis_output_zip_info`") # noqa: E501
|
|
2527
|
+
# verify the required parameter 'filename' is set
|
|
2528
|
+
if ('filename' not in params or
|
|
2529
|
+
params['filename'] is None):
|
|
2530
|
+
raise ValueError("Missing the required parameter `filename` when calling `get_container_analysis_output_zip_info`") # noqa: E501
|
|
2531
|
+
check_filename_params(params)
|
|
2532
|
+
|
|
2533
|
+
collection_formats = {}
|
|
2534
|
+
|
|
2535
|
+
path_params = {}
|
|
2536
|
+
if 'container_id' in params:
|
|
2537
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
2538
|
+
if 'analysis_id' in params:
|
|
2539
|
+
path_params['analysis_id'] = params['analysis_id'] # noqa: E501
|
|
2540
|
+
if 'filename' in params:
|
|
2541
|
+
path_params['filename'] = params['filename'] # noqa: E501
|
|
2542
|
+
|
|
2543
|
+
query_params = []
|
|
2544
|
+
if 'ticket' in params:
|
|
2545
|
+
query_params.append(('ticket', params['ticket'])) # noqa: E501
|
|
2546
|
+
if 'info' in params:
|
|
2547
|
+
query_params.append(('info', params['info'])) # noqa: E501
|
|
2548
|
+
else:
|
|
2549
|
+
query_params.append(('info', 'true'))
|
|
2550
|
+
if 'member' in params:
|
|
2551
|
+
query_params.append(('member', params['member'])) # noqa: E501
|
|
2552
|
+
if 'view' in params:
|
|
2553
|
+
query_params.append(('view', params['view'])) # noqa: E501
|
|
2554
|
+
|
|
2555
|
+
header_params = {}
|
|
2556
|
+
if 'range' in params:
|
|
2557
|
+
header_params['range'] = params['range'] # noqa: E501
|
|
2558
|
+
if 'x_accept_feature' in params:
|
|
2559
|
+
header_params['x-accept-feature'] = params['x_accept_feature'] # noqa: E501
|
|
2560
|
+
collection_formats['x-accept-feature'] = '' # noqa: E501
|
|
2561
|
+
|
|
2562
|
+
form_params = []
|
|
2563
|
+
local_var_files = {}
|
|
2564
|
+
|
|
2565
|
+
body_params = None
|
|
2566
|
+
# HTTP header `Accept`
|
|
2567
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2568
|
+
['application/json']) # noqa: E501
|
|
2569
|
+
|
|
2570
|
+
# Authentication setting
|
|
2571
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
2572
|
+
|
|
2573
|
+
return self.api_client.call_api(
|
|
2574
|
+
'/containers/{container_id}/analyses/{analysis_id}/files/{filename}', 'GET',
|
|
2575
|
+
path_params,
|
|
2576
|
+
query_params,
|
|
2577
|
+
header_params,
|
|
2578
|
+
body=body_params,
|
|
2579
|
+
post_params=form_params,
|
|
2580
|
+
files=local_var_files,
|
|
2581
|
+
response_type='FileZipInfo', # noqa: E501
|
|
2582
|
+
auth_settings=auth_settings,
|
|
2583
|
+
async_=params.get('async_'),
|
|
2584
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2585
|
+
_preload_content=params.get('_preload_content', True),
|
|
2586
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2587
|
+
_request_out=params.get('_request_out'),
|
|
2588
|
+
collection_formats=collection_formats)
|
|
2589
|
+
|
|
2590
|
+
def get_container_analysis_output_download_ticket(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2591
|
+
"""Get a signed URL to download a named child file.
|
|
2592
|
+
|
|
2593
|
+
This method makes a synchronous HTTP request by default.
|
|
2594
|
+
|
|
2595
|
+
:param str container_id: 24-character hex ID (required)
|
|
2596
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2597
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2598
|
+
:param str ticket: ticket id of the outputs to download
|
|
2599
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2600
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2601
|
+
:param bool view: feature flag for view/download
|
|
2602
|
+
:param str range: byte ranges to return
|
|
2603
|
+
:param list[str] x_accept_feature: redirect header
|
|
2604
|
+
:param bool async_: Perform the request asynchronously
|
|
2605
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2606
|
+
"""
|
|
2607
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2608
|
+
kwargs['_return_http_data_only'] = True
|
|
2609
|
+
|
|
2610
|
+
if kwargs.get('async_'):
|
|
2611
|
+
return self.get_container_analysis_output_download_ticket_with_http_info(container_id, analysis_id, filename, **kwargs) # noqa: E501
|
|
2612
|
+
else:
|
|
2613
|
+
(data) = self.get_container_analysis_output_download_ticket_with_http_info(container_id, analysis_id, filename, **kwargs) # noqa: E501
|
|
2614
|
+
if (
|
|
2615
|
+
data
|
|
2616
|
+
and hasattr(data, 'return_value')
|
|
2617
|
+
and not ignore_simplified_return_value
|
|
2618
|
+
):
|
|
2619
|
+
return data.return_value()
|
|
2620
|
+
return data
|
|
2621
|
+
|
|
2622
|
+
|
|
2623
|
+
def get_container_analysis_output_download_ticket_with_http_info(self, container_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2624
|
+
"""Get a signed URL to download a named child file.
|
|
2625
|
+
|
|
2626
|
+
This method makes a synchronous HTTP request by default.
|
|
2627
|
+
|
|
2628
|
+
:param str container_id: 24-character hex ID (required)
|
|
2629
|
+
:param str analysis_id: 24-char hex analysis id (required)
|
|
2630
|
+
:param str filename: filename to download (get tar of all if empty) (required)
|
|
2631
|
+
:param str ticket: ticket id of the outputs to download
|
|
2632
|
+
:param bool info: If the file is a zipfile, return a json response of zipfile member information
|
|
2633
|
+
:param str member: The filename of a zipfile member to download rather than the entire file
|
|
2634
|
+
:param bool view: feature flag for view/download
|
|
2635
|
+
:param str range: byte ranges to return
|
|
2636
|
+
:param list[str] x_accept_feature: redirect header
|
|
2637
|
+
:param bool async_: Perform the request asynchronously
|
|
2638
|
+
:return: union[DownloadTicketStub,ZipfileInfo]
|
|
2639
|
+
"""
|
|
2640
|
+
|
|
2641
|
+
all_params = ['container_id','analysis_id','filename','ticket','info','member','view','range','x_accept_feature',] # noqa: E501
|
|
2642
|
+
all_params.append('async_')
|
|
2643
|
+
all_params.append('_return_http_data_only')
|
|
2644
|
+
all_params.append('_preload_content')
|
|
2645
|
+
all_params.append('_request_timeout')
|
|
2646
|
+
all_params.append('_request_out')
|
|
2647
|
+
|
|
2648
|
+
params = locals()
|
|
2649
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2650
|
+
if key not in all_params:
|
|
2651
|
+
raise TypeError(
|
|
2652
|
+
"Got an unexpected keyword argument '%s'"
|
|
2653
|
+
" to method get_container_analysis_output_download_ticket" % key
|
|
2654
|
+
)
|
|
2655
|
+
params[key] = val
|
|
2656
|
+
del params['kwargs']
|
|
2657
|
+
# verify the required parameter 'container_id' is set
|
|
2658
|
+
if ('container_id' not in params or
|
|
2659
|
+
params['container_id'] is None):
|
|
2660
|
+
raise ValueError("Missing the required parameter `container_id` when calling `get_container_analysis_output_download_ticket`") # noqa: E501
|
|
2661
|
+
# verify the required parameter 'analysis_id' is set
|
|
2662
|
+
if ('analysis_id' not in params or
|
|
2663
|
+
params['analysis_id'] is None):
|
|
2664
|
+
raise ValueError("Missing the required parameter `analysis_id` when calling `get_container_analysis_output_download_ticket`") # noqa: E501
|
|
2665
|
+
# verify the required parameter 'filename' is set
|
|
2666
|
+
if ('filename' not in params or
|
|
2667
|
+
params['filename'] is None):
|
|
2668
|
+
raise ValueError("Missing the required parameter `filename` when calling `get_container_analysis_output_download_ticket`") # noqa: E501
|
|
2669
|
+
check_filename_params(params)
|
|
2670
|
+
|
|
2671
|
+
collection_formats = {}
|
|
2672
|
+
|
|
2673
|
+
path_params = {}
|
|
2674
|
+
if 'container_id' in params:
|
|
2675
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
2676
|
+
if 'analysis_id' in params:
|
|
2677
|
+
path_params['analysis_id'] = params['analysis_id'] # noqa: E501
|
|
2678
|
+
if 'filename' in params:
|
|
2679
|
+
path_params['filename'] = params['filename'] # noqa: E501
|
|
2680
|
+
|
|
2681
|
+
query_params = []
|
|
2682
|
+
if 'ticket' in params:
|
|
2683
|
+
query_params.append(('ticket', params['ticket'])) # noqa: E501
|
|
2684
|
+
if 'info' in params:
|
|
2685
|
+
query_params.append(('info', params['info'])) # noqa: E501
|
|
2686
|
+
if 'member' in params:
|
|
2687
|
+
query_params.append(('member', params['member'])) # noqa: E501
|
|
2688
|
+
if 'view' in params:
|
|
2689
|
+
query_params.append(('view', params['view'])) # noqa: E501
|
|
2690
|
+
|
|
2691
|
+
header_params = {}
|
|
2692
|
+
if 'range' in params:
|
|
2693
|
+
header_params['range'] = params['range'] # noqa: E501
|
|
2694
|
+
if 'x_accept_feature' in params:
|
|
2695
|
+
header_params['x-accept-feature'] = params['x_accept_feature'] # noqa: E501
|
|
2696
|
+
collection_formats['x-accept-feature'] = '' # noqa: E501
|
|
2697
|
+
|
|
2698
|
+
form_params = []
|
|
2699
|
+
local_var_files = {}
|
|
2700
|
+
|
|
2701
|
+
body_params = None
|
|
2702
|
+
# HTTP header `Accept`
|
|
2703
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2704
|
+
['application/json']) # noqa: E501
|
|
2705
|
+
|
|
2706
|
+
# Authentication setting
|
|
2707
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
2708
|
+
|
|
2709
|
+
return self.api_client.call_api(
|
|
2710
|
+
'/containers/{container_id}/analyses/{analysis_id}/files/{filename}', 'GET',
|
|
2711
|
+
path_params,
|
|
2712
|
+
query_params,
|
|
2713
|
+
header_params,
|
|
2714
|
+
body=body_params,
|
|
2715
|
+
post_params=form_params,
|
|
2716
|
+
files=local_var_files,
|
|
2717
|
+
response_type='union[DownloadTicketStub,ZipfileInfo]', # noqa: E501
|
|
2718
|
+
auth_settings=auth_settings,
|
|
2719
|
+
async_=params.get('async_'),
|
|
2720
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2721
|
+
_preload_content=params.get('_preload_content', True),
|
|
2722
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2723
|
+
_request_out=params.get('_request_out'),
|
|
2724
|
+
collection_formats=collection_formats)
|
|
2725
|
+
|
|
2726
|
+
def get_container(self, container_id, **kwargs): # noqa: E501
|
|
2727
|
+
"""Retrieve a single container
|
|
2728
|
+
|
|
2729
|
+
Find Container by ID
|
|
2730
|
+
This method makes a synchronous HTTP request by default.
|
|
2731
|
+
|
|
2732
|
+
:param str container_id: (required)
|
|
2733
|
+
:param JoinType join:
|
|
2734
|
+
:param bool join_avatars:
|
|
2735
|
+
:param bool async_: Perform the request asynchronously
|
|
2736
|
+
:return: union[GroupContainerOutput,ProjectContainerOutput,SubjectContainerOutput,SessionContainerOutput,AcquisitionContainerOutput,AnalysisContainerOutput,CollectionContainerOutput]
|
|
2737
|
+
"""
|
|
2738
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2739
|
+
kwargs['_return_http_data_only'] = True
|
|
2740
|
+
|
|
2741
|
+
if kwargs.get('async_'):
|
|
2742
|
+
return self.get_container_with_http_info(container_id, **kwargs) # noqa: E501
|
|
2743
|
+
else:
|
|
2744
|
+
(data) = self.get_container_with_http_info(container_id, **kwargs) # noqa: E501
|
|
2745
|
+
if (
|
|
2746
|
+
data
|
|
2747
|
+
and hasattr(data, 'return_value')
|
|
2748
|
+
and not ignore_simplified_return_value
|
|
2749
|
+
):
|
|
2750
|
+
return data.return_value()
|
|
2751
|
+
return data
|
|
2752
|
+
|
|
2753
|
+
|
|
2754
|
+
def get_container_with_http_info(self, container_id, **kwargs): # noqa: E501
|
|
2755
|
+
"""Retrieve a single container
|
|
2756
|
+
|
|
2757
|
+
Find Container by ID
|
|
2758
|
+
This method makes a synchronous HTTP request by default.
|
|
2759
|
+
|
|
2760
|
+
:param str container_id: (required)
|
|
2761
|
+
:param JoinType join:
|
|
2762
|
+
:param bool join_avatars:
|
|
2763
|
+
:param bool async_: Perform the request asynchronously
|
|
2764
|
+
:return: union[GroupContainerOutput,ProjectContainerOutput,SubjectContainerOutput,SessionContainerOutput,AcquisitionContainerOutput,AnalysisContainerOutput,CollectionContainerOutput]
|
|
2765
|
+
"""
|
|
2766
|
+
|
|
2767
|
+
all_params = ['container_id','join','join_avatars',] # noqa: E501
|
|
2768
|
+
all_params.append('async_')
|
|
2769
|
+
all_params.append('_return_http_data_only')
|
|
2770
|
+
all_params.append('_preload_content')
|
|
2771
|
+
all_params.append('_request_timeout')
|
|
2772
|
+
all_params.append('_request_out')
|
|
2773
|
+
|
|
2774
|
+
params = locals()
|
|
2775
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2776
|
+
if key not in all_params:
|
|
2777
|
+
raise TypeError(
|
|
2778
|
+
"Got an unexpected keyword argument '%s'"
|
|
2779
|
+
" to method get_container" % key
|
|
2780
|
+
)
|
|
2781
|
+
params[key] = val
|
|
2782
|
+
del params['kwargs']
|
|
2783
|
+
# verify the required parameter 'container_id' is set
|
|
2784
|
+
if ('container_id' not in params or
|
|
2785
|
+
params['container_id'] is None):
|
|
2786
|
+
raise ValueError("Missing the required parameter `container_id` when calling `get_container`") # noqa: E501
|
|
2787
|
+
check_filename_params(params)
|
|
2788
|
+
|
|
2789
|
+
collection_formats = {}
|
|
2790
|
+
|
|
2791
|
+
path_params = {}
|
|
2792
|
+
if 'container_id' in params:
|
|
2793
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
2794
|
+
|
|
2795
|
+
query_params = []
|
|
2796
|
+
if 'join' in params:
|
|
2797
|
+
query_params.append(('join', params['join'])) # noqa: E501
|
|
2798
|
+
if 'join_avatars' in params:
|
|
2799
|
+
query_params.append(('join_avatars', params['join_avatars'])) # noqa: E501
|
|
2800
|
+
|
|
2801
|
+
header_params = {}
|
|
2802
|
+
|
|
2803
|
+
form_params = []
|
|
2804
|
+
local_var_files = {}
|
|
2805
|
+
|
|
2806
|
+
body_params = None
|
|
2807
|
+
# HTTP header `Accept`
|
|
2808
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2809
|
+
['application/json']) # noqa: E501
|
|
2810
|
+
|
|
2811
|
+
# Authentication setting
|
|
2812
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
2813
|
+
|
|
2814
|
+
return self.api_client.call_api(
|
|
2815
|
+
'/containers/{container_id}', 'GET',
|
|
2816
|
+
path_params,
|
|
2817
|
+
query_params,
|
|
2818
|
+
header_params,
|
|
2819
|
+
body=body_params,
|
|
2820
|
+
post_params=form_params,
|
|
2821
|
+
files=local_var_files,
|
|
2822
|
+
response_type='union[GroupContainerOutput,ProjectContainerOutput,SubjectContainerOutput,SessionContainerOutput,AcquisitionContainerOutput,AnalysisContainerOutput,CollectionContainerOutput]', # noqa: E501
|
|
2823
|
+
auth_settings=auth_settings,
|
|
2824
|
+
async_=params.get('async_'),
|
|
2825
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2826
|
+
_preload_content=params.get('_preload_content', True),
|
|
2827
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2828
|
+
_request_out=params.get('_request_out'),
|
|
2829
|
+
collection_formats=collection_formats)
|
|
2830
|
+
|
|
2831
|
+
def get_container_analyses(self, cid, **kwargs): # noqa: E501
|
|
2832
|
+
"""Get analyses for a(n) container.
|
|
2833
|
+
|
|
2834
|
+
Returns analyses that directly belong to this resource.
|
|
2835
|
+
This method makes a synchronous HTTP request by default.
|
|
2836
|
+
|
|
2837
|
+
:param str cid: (required)
|
|
2838
|
+
:param bool inflate_job:
|
|
2839
|
+
:param bool join_avatars:
|
|
2840
|
+
:param JoinType join:
|
|
2841
|
+
:param bool include_all_info: Include all info in returned objects
|
|
2842
|
+
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
2843
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2844
|
+
:param int limit: The maximum number of entries to return.
|
|
2845
|
+
:param int skip: The number of entries to skip.
|
|
2846
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
2847
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2848
|
+
:param list[str] x_accept_feature:
|
|
2849
|
+
:param bool async_: Perform the request asynchronously
|
|
2850
|
+
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
2851
|
+
"""
|
|
2852
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2853
|
+
kwargs['_return_http_data_only'] = True
|
|
2854
|
+
|
|
2855
|
+
if kwargs.get('async_'):
|
|
2856
|
+
return self.get_container_analyses_with_http_info(cid, **kwargs) # noqa: E501
|
|
2857
|
+
else:
|
|
2858
|
+
(data) = self.get_container_analyses_with_http_info(cid, **kwargs) # noqa: E501
|
|
2859
|
+
if (
|
|
2860
|
+
data
|
|
2861
|
+
and hasattr(data, 'return_value')
|
|
2862
|
+
and not ignore_simplified_return_value
|
|
2863
|
+
):
|
|
2864
|
+
return data.return_value()
|
|
2865
|
+
return data
|
|
2866
|
+
|
|
2867
|
+
|
|
2868
|
+
def get_container_analyses_with_http_info(self, cid, **kwargs): # noqa: E501
|
|
2869
|
+
"""Get analyses for a(n) container.
|
|
2870
|
+
|
|
2871
|
+
Returns analyses that directly belong to this resource.
|
|
2872
|
+
This method makes a synchronous HTTP request by default.
|
|
2873
|
+
|
|
2874
|
+
:param str cid: (required)
|
|
2875
|
+
:param bool inflate_job:
|
|
2876
|
+
:param bool join_avatars:
|
|
2877
|
+
:param JoinType join:
|
|
2878
|
+
:param bool include_all_info: Include all info in returned objects
|
|
2879
|
+
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
2880
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
2881
|
+
:param int limit: The maximum number of entries to return.
|
|
2882
|
+
:param int skip: The number of entries to skip.
|
|
2883
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
2884
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
2885
|
+
:param list[str] x_accept_feature:
|
|
2886
|
+
:param bool async_: Perform the request asynchronously
|
|
2887
|
+
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
2888
|
+
"""
|
|
2889
|
+
|
|
2890
|
+
all_params = ['cid','inflate_job','join_avatars','join','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
2891
|
+
all_params.append('async_')
|
|
2892
|
+
all_params.append('_return_http_data_only')
|
|
2893
|
+
all_params.append('_preload_content')
|
|
2894
|
+
all_params.append('_request_timeout')
|
|
2895
|
+
all_params.append('_request_out')
|
|
2896
|
+
|
|
2897
|
+
params = locals()
|
|
2898
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2899
|
+
if key not in all_params:
|
|
2900
|
+
raise TypeError(
|
|
2901
|
+
"Got an unexpected keyword argument '%s'"
|
|
2902
|
+
" to method get_container_analyses" % key
|
|
2903
|
+
)
|
|
2904
|
+
params[key] = val
|
|
2905
|
+
del params['kwargs']
|
|
2906
|
+
# verify the required parameter 'cid' is set
|
|
2907
|
+
if ('cid' not in params or
|
|
2908
|
+
params['cid'] is None):
|
|
2909
|
+
raise ValueError("Missing the required parameter `cid` when calling `get_container_analyses`") # noqa: E501
|
|
2910
|
+
check_filename_params(params)
|
|
2911
|
+
|
|
2912
|
+
collection_formats = {}
|
|
2913
|
+
|
|
2914
|
+
path_params = {}
|
|
2915
|
+
if 'cid' in params:
|
|
2916
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
2917
|
+
|
|
2918
|
+
query_params = []
|
|
2919
|
+
if 'inflate_job' in params:
|
|
2920
|
+
query_params.append(('inflate_job', params['inflate_job'])) # noqa: E501
|
|
2921
|
+
if 'join_avatars' in params:
|
|
2922
|
+
query_params.append(('join_avatars', params['join_avatars'])) # noqa: E501
|
|
2923
|
+
if 'join' in params:
|
|
2924
|
+
query_params.append(('join', params['join'])) # noqa: E501
|
|
2925
|
+
if 'include_all_info' in params:
|
|
2926
|
+
query_params.append(('include_all_info', params['include_all_info'])) # noqa: E501
|
|
2927
|
+
if 'filter' in params:
|
|
2928
|
+
query_params.append(('filter', params['filter'])) # noqa: E501
|
|
2929
|
+
if 'sort' in params:
|
|
2930
|
+
query_params.append(('sort', params['sort'])) # noqa: E501
|
|
2931
|
+
if 'limit' in params:
|
|
2932
|
+
query_params.append(('limit', params['limit'])) # noqa: E501
|
|
2933
|
+
if 'skip' in params:
|
|
2934
|
+
query_params.append(('skip', params['skip'])) # noqa: E501
|
|
2935
|
+
if 'page' in params:
|
|
2936
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
2937
|
+
if 'after_id' in params:
|
|
2938
|
+
query_params.append(('after_id', params['after_id'])) # noqa: E501
|
|
2939
|
+
|
|
2940
|
+
header_params = {}
|
|
2941
|
+
if 'x_accept_feature' in params:
|
|
2942
|
+
header_params['x-accept-feature'] = params['x_accept_feature'] # noqa: E501
|
|
2943
|
+
collection_formats['x-accept-feature'] = '' # noqa: E501
|
|
2944
|
+
|
|
2945
|
+
form_params = []
|
|
2946
|
+
local_var_files = {}
|
|
2947
|
+
|
|
2948
|
+
body_params = None
|
|
2949
|
+
# HTTP header `Accept`
|
|
2950
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2951
|
+
['application/json']) # noqa: E501
|
|
2952
|
+
|
|
2953
|
+
# Authentication setting
|
|
2954
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
2955
|
+
|
|
2956
|
+
return self.api_client.call_api(
|
|
2957
|
+
'/containers/{cid}/analyses', 'GET',
|
|
2958
|
+
path_params,
|
|
2959
|
+
query_params,
|
|
2960
|
+
header_params,
|
|
2961
|
+
body=body_params,
|
|
2962
|
+
post_params=form_params,
|
|
2963
|
+
files=local_var_files,
|
|
2964
|
+
response_type='union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]', # noqa: E501
|
|
2965
|
+
auth_settings=auth_settings,
|
|
2966
|
+
async_=params.get('async_'),
|
|
2967
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2968
|
+
_preload_content=params.get('_preload_content', True),
|
|
2969
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2970
|
+
_request_out=params.get('_request_out'),
|
|
2971
|
+
collection_formats=collection_formats)
|
|
2972
|
+
|
|
2973
|
+
def get_container_analysis(self, cid, analysis_id, **kwargs): # noqa: E501
|
|
2974
|
+
"""Get an analysis.
|
|
2975
|
+
|
|
2976
|
+
Get an analysis.
|
|
2977
|
+
This method makes a synchronous HTTP request by default.
|
|
2978
|
+
|
|
2979
|
+
:param str cid: (required)
|
|
2980
|
+
:param str analysis_id: (required)
|
|
2981
|
+
:param bool inflate_job: Return job as an object instead of an id
|
|
2982
|
+
:param bool join_avatars:
|
|
2983
|
+
:param JoinType join:
|
|
2984
|
+
:param bool async_: Perform the request asynchronously
|
|
2985
|
+
:return: union[AnalysisOutputInflatedJob,AnalysisOutput]
|
|
2986
|
+
"""
|
|
2987
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
2988
|
+
kwargs['_return_http_data_only'] = True
|
|
2989
|
+
|
|
2990
|
+
if kwargs.get('async_'):
|
|
2991
|
+
return self.get_container_analysis_with_http_info(cid, analysis_id, **kwargs) # noqa: E501
|
|
2992
|
+
else:
|
|
2993
|
+
(data) = self.get_container_analysis_with_http_info(cid, analysis_id, **kwargs) # noqa: E501
|
|
2994
|
+
if (
|
|
2995
|
+
data
|
|
2996
|
+
and hasattr(data, 'return_value')
|
|
2997
|
+
and not ignore_simplified_return_value
|
|
2998
|
+
):
|
|
2999
|
+
return data.return_value()
|
|
3000
|
+
return data
|
|
3001
|
+
|
|
3002
|
+
|
|
3003
|
+
def get_container_analysis_with_http_info(self, cid, analysis_id, **kwargs): # noqa: E501
|
|
3004
|
+
"""Get an analysis.
|
|
3005
|
+
|
|
3006
|
+
Get an analysis.
|
|
3007
|
+
This method makes a synchronous HTTP request by default.
|
|
3008
|
+
|
|
3009
|
+
:param str cid: (required)
|
|
3010
|
+
:param str analysis_id: (required)
|
|
3011
|
+
:param bool inflate_job: Return job as an object instead of an id
|
|
3012
|
+
:param bool join_avatars:
|
|
3013
|
+
:param JoinType join:
|
|
3014
|
+
:param bool async_: Perform the request asynchronously
|
|
3015
|
+
:return: union[AnalysisOutputInflatedJob,AnalysisOutput]
|
|
3016
|
+
"""
|
|
3017
|
+
|
|
3018
|
+
all_params = ['cid','analysis_id','inflate_job','join_avatars','join',] # noqa: E501
|
|
3019
|
+
all_params.append('async_')
|
|
3020
|
+
all_params.append('_return_http_data_only')
|
|
3021
|
+
all_params.append('_preload_content')
|
|
3022
|
+
all_params.append('_request_timeout')
|
|
3023
|
+
all_params.append('_request_out')
|
|
3024
|
+
|
|
3025
|
+
params = locals()
|
|
3026
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3027
|
+
if key not in all_params:
|
|
3028
|
+
raise TypeError(
|
|
3029
|
+
"Got an unexpected keyword argument '%s'"
|
|
3030
|
+
" to method get_container_analysis" % key
|
|
3031
|
+
)
|
|
3032
|
+
params[key] = val
|
|
3033
|
+
del params['kwargs']
|
|
3034
|
+
# verify the required parameter 'cid' is set
|
|
3035
|
+
if ('cid' not in params or
|
|
3036
|
+
params['cid'] is None):
|
|
3037
|
+
raise ValueError("Missing the required parameter `cid` when calling `get_container_analysis`") # noqa: E501
|
|
3038
|
+
# verify the required parameter 'analysis_id' is set
|
|
3039
|
+
if ('analysis_id' not in params or
|
|
3040
|
+
params['analysis_id'] is None):
|
|
3041
|
+
raise ValueError("Missing the required parameter `analysis_id` when calling `get_container_analysis`") # noqa: E501
|
|
3042
|
+
check_filename_params(params)
|
|
3043
|
+
|
|
3044
|
+
collection_formats = {}
|
|
3045
|
+
|
|
3046
|
+
path_params = {}
|
|
3047
|
+
if 'cid' in params:
|
|
3048
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
3049
|
+
if 'analysis_id' in params:
|
|
3050
|
+
path_params['analysis_id'] = params['analysis_id'] # noqa: E501
|
|
3051
|
+
|
|
3052
|
+
query_params = []
|
|
3053
|
+
if 'inflate_job' in params:
|
|
3054
|
+
query_params.append(('inflate_job', params['inflate_job'])) # noqa: E501
|
|
3055
|
+
if 'join_avatars' in params:
|
|
3056
|
+
query_params.append(('join_avatars', params['join_avatars'])) # noqa: E501
|
|
3057
|
+
if 'join' in params:
|
|
3058
|
+
query_params.append(('join', params['join'])) # noqa: E501
|
|
3059
|
+
|
|
3060
|
+
header_params = {}
|
|
3061
|
+
|
|
3062
|
+
form_params = []
|
|
3063
|
+
local_var_files = {}
|
|
3064
|
+
|
|
3065
|
+
body_params = None
|
|
3066
|
+
# HTTP header `Accept`
|
|
3067
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3068
|
+
['application/json']) # noqa: E501
|
|
3069
|
+
|
|
3070
|
+
# Authentication setting
|
|
3071
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
3072
|
+
|
|
3073
|
+
return self.api_client.call_api(
|
|
3074
|
+
'/containers/{cid}/analyses/{analysis_id}', 'GET',
|
|
3075
|
+
path_params,
|
|
3076
|
+
query_params,
|
|
3077
|
+
header_params,
|
|
3078
|
+
body=body_params,
|
|
3079
|
+
post_params=form_params,
|
|
3080
|
+
files=local_var_files,
|
|
3081
|
+
response_type='union[AnalysisOutputInflatedJob,AnalysisOutput]', # noqa: E501
|
|
3082
|
+
auth_settings=auth_settings,
|
|
3083
|
+
async_=params.get('async_'),
|
|
3084
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3085
|
+
_preload_content=params.get('_preload_content', True),
|
|
3086
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3087
|
+
_request_out=params.get('_request_out'),
|
|
3088
|
+
collection_formats=collection_formats)
|
|
3089
|
+
|
|
3090
|
+
def get_container_file_info(self, cid, filename, **kwargs): # noqa: E501
|
|
3091
|
+
"""Get info for a particular file.
|
|
3092
|
+
|
|
3093
|
+
Get info for a particular file.
|
|
3094
|
+
This method makes a synchronous HTTP request by default.
|
|
3095
|
+
|
|
3096
|
+
:param str cid: Container Id (required)
|
|
3097
|
+
:param str filename: (required)
|
|
3098
|
+
:param bool async_: Perform the request asynchronously
|
|
3099
|
+
:return: FileOutput
|
|
3100
|
+
"""
|
|
3101
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3102
|
+
kwargs['_return_http_data_only'] = True
|
|
3103
|
+
|
|
3104
|
+
if kwargs.get('async_'):
|
|
3105
|
+
return self.get_container_file_info_with_http_info(cid, filename, **kwargs) # noqa: E501
|
|
3106
|
+
else:
|
|
3107
|
+
(data) = self.get_container_file_info_with_http_info(cid, filename, **kwargs) # noqa: E501
|
|
3108
|
+
if (
|
|
3109
|
+
data
|
|
3110
|
+
and hasattr(data, 'return_value')
|
|
3111
|
+
and not ignore_simplified_return_value
|
|
3112
|
+
):
|
|
3113
|
+
return data.return_value()
|
|
3114
|
+
return data
|
|
3115
|
+
|
|
3116
|
+
|
|
3117
|
+
def get_container_file_info_with_http_info(self, cid, filename, **kwargs): # noqa: E501
|
|
3118
|
+
"""Get info for a particular file.
|
|
3119
|
+
|
|
3120
|
+
Get info for a particular file.
|
|
3121
|
+
This method makes a synchronous HTTP request by default.
|
|
3122
|
+
|
|
3123
|
+
:param str cid: Container Id (required)
|
|
3124
|
+
:param str filename: (required)
|
|
3125
|
+
:param bool async_: Perform the request asynchronously
|
|
3126
|
+
:return: FileOutput
|
|
3127
|
+
"""
|
|
3128
|
+
|
|
3129
|
+
all_params = ['cid','filename',] # noqa: E501
|
|
3130
|
+
all_params.append('async_')
|
|
3131
|
+
all_params.append('_return_http_data_only')
|
|
3132
|
+
all_params.append('_preload_content')
|
|
3133
|
+
all_params.append('_request_timeout')
|
|
3134
|
+
all_params.append('_request_out')
|
|
3135
|
+
|
|
3136
|
+
params = locals()
|
|
3137
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3138
|
+
if key not in all_params:
|
|
3139
|
+
raise TypeError(
|
|
3140
|
+
"Got an unexpected keyword argument '%s'"
|
|
3141
|
+
" to method get_container_file_info" % key
|
|
3142
|
+
)
|
|
3143
|
+
params[key] = val
|
|
3144
|
+
del params['kwargs']
|
|
3145
|
+
# verify the required parameter 'cid' is set
|
|
3146
|
+
if ('cid' not in params or
|
|
3147
|
+
params['cid'] is None):
|
|
3148
|
+
raise ValueError("Missing the required parameter `cid` when calling `get_container_file_info`") # noqa: E501
|
|
3149
|
+
# verify the required parameter 'filename' is set
|
|
3150
|
+
if ('filename' not in params or
|
|
3151
|
+
params['filename'] is None):
|
|
3152
|
+
raise ValueError("Missing the required parameter `filename` when calling `get_container_file_info`") # noqa: E501
|
|
3153
|
+
check_filename_params(params)
|
|
3154
|
+
|
|
3155
|
+
collection_formats = {}
|
|
3156
|
+
|
|
3157
|
+
path_params = {}
|
|
3158
|
+
if 'cid' in params:
|
|
3159
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
3160
|
+
if 'filename' in params:
|
|
3161
|
+
path_params['filename'] = params['filename'] # noqa: E501
|
|
3162
|
+
|
|
3163
|
+
query_params = []
|
|
3164
|
+
|
|
3165
|
+
header_params = {}
|
|
3166
|
+
|
|
3167
|
+
form_params = []
|
|
3168
|
+
local_var_files = {}
|
|
3169
|
+
|
|
3170
|
+
body_params = None
|
|
3171
|
+
# HTTP header `Accept`
|
|
3172
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3173
|
+
['application/json']) # noqa: E501
|
|
3174
|
+
|
|
3175
|
+
# Authentication setting
|
|
3176
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
3177
|
+
|
|
3178
|
+
return self.api_client.call_api(
|
|
3179
|
+
'/containers/{cid}/files/{filename}/info', 'GET',
|
|
3180
|
+
path_params,
|
|
3181
|
+
query_params,
|
|
3182
|
+
header_params,
|
|
3183
|
+
body=body_params,
|
|
3184
|
+
post_params=form_params,
|
|
3185
|
+
files=local_var_files,
|
|
3186
|
+
response_type='FileOutput', # noqa: E501
|
|
3187
|
+
auth_settings=auth_settings,
|
|
3188
|
+
async_=params.get('async_'),
|
|
3189
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3190
|
+
_preload_content=params.get('_preload_content', True),
|
|
3191
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3192
|
+
_request_out=params.get('_request_out'),
|
|
3193
|
+
collection_formats=collection_formats)
|
|
3194
|
+
|
|
3195
|
+
def get_container_note(self, cid, note_id, **kwargs): # noqa: E501
|
|
3196
|
+
"""Get a note of a(n) container.
|
|
3197
|
+
|
|
3198
|
+
Get a note of a(n) container
|
|
3199
|
+
This method makes a synchronous HTTP request by default.
|
|
3200
|
+
|
|
3201
|
+
:param str cid: (required)
|
|
3202
|
+
:param str note_id: (required)
|
|
3203
|
+
:param bool async_: Perform the request asynchronously
|
|
3204
|
+
:return: Note
|
|
3205
|
+
"""
|
|
3206
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3207
|
+
kwargs['_return_http_data_only'] = True
|
|
3208
|
+
|
|
3209
|
+
if kwargs.get('async_'):
|
|
3210
|
+
return self.get_container_note_with_http_info(cid, note_id, **kwargs) # noqa: E501
|
|
3211
|
+
else:
|
|
3212
|
+
(data) = self.get_container_note_with_http_info(cid, note_id, **kwargs) # noqa: E501
|
|
3213
|
+
if (
|
|
3214
|
+
data
|
|
3215
|
+
and hasattr(data, 'return_value')
|
|
3216
|
+
and not ignore_simplified_return_value
|
|
3217
|
+
):
|
|
3218
|
+
return data.return_value()
|
|
3219
|
+
return data
|
|
3220
|
+
|
|
3221
|
+
|
|
3222
|
+
def get_container_note_with_http_info(self, cid, note_id, **kwargs): # noqa: E501
|
|
3223
|
+
"""Get a note of a(n) container.
|
|
3224
|
+
|
|
3225
|
+
Get a note of a(n) container
|
|
3226
|
+
This method makes a synchronous HTTP request by default.
|
|
3227
|
+
|
|
3228
|
+
:param str cid: (required)
|
|
3229
|
+
:param str note_id: (required)
|
|
3230
|
+
:param bool async_: Perform the request asynchronously
|
|
3231
|
+
:return: Note
|
|
3232
|
+
"""
|
|
3233
|
+
|
|
3234
|
+
all_params = ['cid','note_id',] # noqa: E501
|
|
3235
|
+
all_params.append('async_')
|
|
3236
|
+
all_params.append('_return_http_data_only')
|
|
3237
|
+
all_params.append('_preload_content')
|
|
3238
|
+
all_params.append('_request_timeout')
|
|
3239
|
+
all_params.append('_request_out')
|
|
3240
|
+
|
|
3241
|
+
params = locals()
|
|
3242
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3243
|
+
if key not in all_params:
|
|
3244
|
+
raise TypeError(
|
|
3245
|
+
"Got an unexpected keyword argument '%s'"
|
|
3246
|
+
" to method get_container_note" % key
|
|
3247
|
+
)
|
|
3248
|
+
params[key] = val
|
|
3249
|
+
del params['kwargs']
|
|
3250
|
+
# verify the required parameter 'cid' is set
|
|
3251
|
+
if ('cid' not in params or
|
|
3252
|
+
params['cid'] is None):
|
|
3253
|
+
raise ValueError("Missing the required parameter `cid` when calling `get_container_note`") # noqa: E501
|
|
3254
|
+
# verify the required parameter 'note_id' is set
|
|
3255
|
+
if ('note_id' not in params or
|
|
3256
|
+
params['note_id'] is None):
|
|
3257
|
+
raise ValueError("Missing the required parameter `note_id` when calling `get_container_note`") # noqa: E501
|
|
3258
|
+
check_filename_params(params)
|
|
3259
|
+
|
|
3260
|
+
collection_formats = {}
|
|
3261
|
+
|
|
3262
|
+
path_params = {}
|
|
3263
|
+
if 'cid' in params:
|
|
3264
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
3265
|
+
if 'note_id' in params:
|
|
3266
|
+
path_params['note_id'] = params['note_id'] # noqa: E501
|
|
3267
|
+
|
|
3268
|
+
query_params = []
|
|
3269
|
+
|
|
3270
|
+
header_params = {}
|
|
3271
|
+
|
|
3272
|
+
form_params = []
|
|
3273
|
+
local_var_files = {}
|
|
3274
|
+
|
|
3275
|
+
body_params = None
|
|
3276
|
+
# HTTP header `Accept`
|
|
3277
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3278
|
+
['application/json']) # noqa: E501
|
|
3279
|
+
|
|
3280
|
+
# Authentication setting
|
|
3281
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
3282
|
+
|
|
3283
|
+
return self.api_client.call_api(
|
|
3284
|
+
'/containers/{cid}/notes/{note_id}', 'GET',
|
|
3285
|
+
path_params,
|
|
3286
|
+
query_params,
|
|
3287
|
+
header_params,
|
|
3288
|
+
body=body_params,
|
|
3289
|
+
post_params=form_params,
|
|
3290
|
+
files=local_var_files,
|
|
3291
|
+
response_type='Note', # noqa: E501
|
|
3292
|
+
auth_settings=auth_settings,
|
|
3293
|
+
async_=params.get('async_'),
|
|
3294
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3295
|
+
_preload_content=params.get('_preload_content', True),
|
|
3296
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3297
|
+
_request_out=params.get('_request_out'),
|
|
3298
|
+
collection_formats=collection_formats)
|
|
3299
|
+
|
|
3300
|
+
def get_container_tag(self, cid, value, **kwargs): # noqa: E501
|
|
3301
|
+
"""Get the value of a tag, by name.
|
|
3302
|
+
|
|
3303
|
+
Get the value of a tag, by name
|
|
3304
|
+
This method makes a synchronous HTTP request by default.
|
|
3305
|
+
|
|
3306
|
+
:param str cid: (required)
|
|
3307
|
+
:param str value: The tag to interact with (required)
|
|
3308
|
+
:param bool async_: Perform the request asynchronously
|
|
3309
|
+
:return: str
|
|
3310
|
+
"""
|
|
3311
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3312
|
+
kwargs['_return_http_data_only'] = True
|
|
3313
|
+
|
|
3314
|
+
if kwargs.get('async_'):
|
|
3315
|
+
return self.get_container_tag_with_http_info(cid, value, **kwargs) # noqa: E501
|
|
3316
|
+
else:
|
|
3317
|
+
(data) = self.get_container_tag_with_http_info(cid, value, **kwargs) # noqa: E501
|
|
3318
|
+
if (
|
|
3319
|
+
data
|
|
3320
|
+
and hasattr(data, 'return_value')
|
|
3321
|
+
and not ignore_simplified_return_value
|
|
3322
|
+
):
|
|
3323
|
+
return data.return_value()
|
|
3324
|
+
return data
|
|
3325
|
+
|
|
3326
|
+
|
|
3327
|
+
def get_container_tag_with_http_info(self, cid, value, **kwargs): # noqa: E501
|
|
3328
|
+
"""Get the value of a tag, by name.
|
|
3329
|
+
|
|
3330
|
+
Get the value of a tag, by name
|
|
3331
|
+
This method makes a synchronous HTTP request by default.
|
|
3332
|
+
|
|
3333
|
+
:param str cid: (required)
|
|
3334
|
+
:param str value: The tag to interact with (required)
|
|
3335
|
+
:param bool async_: Perform the request asynchronously
|
|
3336
|
+
:return: str
|
|
3337
|
+
"""
|
|
3338
|
+
|
|
3339
|
+
all_params = ['cid','value',] # noqa: E501
|
|
3340
|
+
all_params.append('async_')
|
|
3341
|
+
all_params.append('_return_http_data_only')
|
|
3342
|
+
all_params.append('_preload_content')
|
|
3343
|
+
all_params.append('_request_timeout')
|
|
3344
|
+
all_params.append('_request_out')
|
|
3345
|
+
|
|
3346
|
+
params = locals()
|
|
3347
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3348
|
+
if key not in all_params:
|
|
3349
|
+
raise TypeError(
|
|
3350
|
+
"Got an unexpected keyword argument '%s'"
|
|
3351
|
+
" to method get_container_tag" % key
|
|
3352
|
+
)
|
|
3353
|
+
params[key] = val
|
|
3354
|
+
del params['kwargs']
|
|
3355
|
+
# verify the required parameter 'cid' is set
|
|
3356
|
+
if ('cid' not in params or
|
|
3357
|
+
params['cid'] is None):
|
|
3358
|
+
raise ValueError("Missing the required parameter `cid` when calling `get_container_tag`") # noqa: E501
|
|
3359
|
+
# verify the required parameter 'value' is set
|
|
3360
|
+
if ('value' not in params or
|
|
3361
|
+
params['value'] is None):
|
|
3362
|
+
raise ValueError("Missing the required parameter `value` when calling `get_container_tag`") # noqa: E501
|
|
3363
|
+
check_filename_params(params)
|
|
3364
|
+
|
|
3365
|
+
collection_formats = {}
|
|
3366
|
+
|
|
3367
|
+
path_params = {}
|
|
3368
|
+
if 'cid' in params:
|
|
3369
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
3370
|
+
if 'value' in params:
|
|
3371
|
+
path_params['value'] = params['value'] # noqa: E501
|
|
3372
|
+
|
|
3373
|
+
query_params = []
|
|
3374
|
+
|
|
3375
|
+
header_params = {}
|
|
3376
|
+
|
|
3377
|
+
form_params = []
|
|
3378
|
+
local_var_files = {}
|
|
3379
|
+
|
|
3380
|
+
body_params = None
|
|
3381
|
+
# HTTP header `Accept`
|
|
3382
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3383
|
+
['application/json']) # noqa: E501
|
|
3384
|
+
|
|
3385
|
+
# Authentication setting
|
|
3386
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
3387
|
+
|
|
3388
|
+
return self.api_client.call_api(
|
|
3389
|
+
'/containers/{cid}/tags/{value}', 'GET',
|
|
3390
|
+
path_params,
|
|
3391
|
+
query_params,
|
|
3392
|
+
header_params,
|
|
3393
|
+
body=body_params,
|
|
3394
|
+
post_params=form_params,
|
|
3395
|
+
files=local_var_files,
|
|
3396
|
+
response_type='str', # noqa: E501
|
|
3397
|
+
auth_settings=auth_settings,
|
|
3398
|
+
async_=params.get('async_'),
|
|
3399
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3400
|
+
_preload_content=params.get('_preload_content', True),
|
|
3401
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3402
|
+
_request_out=params.get('_request_out'),
|
|
3403
|
+
collection_formats=collection_formats)
|
|
3404
|
+
|
|
3405
|
+
def get_views(self, container_id, **kwargs): # noqa: E501
|
|
3406
|
+
"""Return a list of all views belonging to container
|
|
3407
|
+
|
|
3408
|
+
View all containers
|
|
3409
|
+
This method makes a synchronous HTTP request by default.
|
|
3410
|
+
|
|
3411
|
+
:param str container_id: The ID of the container, one of user, group or project. Use \"site\" as containerId to save or get a site data view. (required)
|
|
3412
|
+
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
3413
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3414
|
+
:param int limit: The maximum number of entries to return.
|
|
3415
|
+
:param int skip: The number of entries to skip.
|
|
3416
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
3417
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3418
|
+
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
3419
|
+
:param bool async_: Perform the request asynchronously
|
|
3420
|
+
:return: union[Page,list[ViewOutput]]
|
|
3421
|
+
"""
|
|
3422
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3423
|
+
kwargs['_return_http_data_only'] = True
|
|
3424
|
+
|
|
3425
|
+
if kwargs.get('async_'):
|
|
3426
|
+
return self.get_views_with_http_info(container_id, **kwargs) # noqa: E501
|
|
3427
|
+
else:
|
|
3428
|
+
(data) = self.get_views_with_http_info(container_id, **kwargs) # noqa: E501
|
|
3429
|
+
if (
|
|
3430
|
+
data
|
|
3431
|
+
and hasattr(data, 'return_value')
|
|
3432
|
+
and not ignore_simplified_return_value
|
|
3433
|
+
):
|
|
3434
|
+
return data.return_value()
|
|
3435
|
+
return data
|
|
3436
|
+
|
|
3437
|
+
|
|
3438
|
+
def get_views_with_http_info(self, container_id, **kwargs): # noqa: E501
|
|
3439
|
+
"""Return a list of all views belonging to container
|
|
3440
|
+
|
|
3441
|
+
View all containers
|
|
3442
|
+
This method makes a synchronous HTTP request by default.
|
|
3443
|
+
|
|
3444
|
+
:param str container_id: The ID of the container, one of user, group or project. Use \"site\" as containerId to save or get a site data view. (required)
|
|
3445
|
+
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
3446
|
+
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3447
|
+
:param int limit: The maximum number of entries to return.
|
|
3448
|
+
:param int skip: The number of entries to skip.
|
|
3449
|
+
:param int page: The page number (i.e. skip limit*page entries)
|
|
3450
|
+
:param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
|
|
3451
|
+
:param list[union[HeaderFeature,str]] x_accept_feature:
|
|
3452
|
+
:param bool async_: Perform the request asynchronously
|
|
3453
|
+
:return: union[Page,list[ViewOutput]]
|
|
3454
|
+
"""
|
|
3455
|
+
|
|
3456
|
+
all_params = ['container_id','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
3457
|
+
all_params.append('async_')
|
|
3458
|
+
all_params.append('_return_http_data_only')
|
|
3459
|
+
all_params.append('_preload_content')
|
|
3460
|
+
all_params.append('_request_timeout')
|
|
3461
|
+
all_params.append('_request_out')
|
|
3462
|
+
|
|
3463
|
+
params = locals()
|
|
3464
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3465
|
+
if key not in all_params:
|
|
3466
|
+
raise TypeError(
|
|
3467
|
+
"Got an unexpected keyword argument '%s'"
|
|
3468
|
+
" to method get_views" % key
|
|
3469
|
+
)
|
|
3470
|
+
params[key] = val
|
|
3471
|
+
del params['kwargs']
|
|
3472
|
+
# verify the required parameter 'container_id' is set
|
|
3473
|
+
if ('container_id' not in params or
|
|
3474
|
+
params['container_id'] is None):
|
|
3475
|
+
raise ValueError("Missing the required parameter `container_id` when calling `get_views`") # noqa: E501
|
|
3476
|
+
check_filename_params(params)
|
|
3477
|
+
|
|
3478
|
+
collection_formats = {}
|
|
3479
|
+
|
|
3480
|
+
path_params = {}
|
|
3481
|
+
if 'container_id' in params:
|
|
3482
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
3483
|
+
|
|
3484
|
+
query_params = []
|
|
3485
|
+
if 'filter' in params:
|
|
3486
|
+
query_params.append(('filter', params['filter'])) # noqa: E501
|
|
3487
|
+
if 'sort' in params:
|
|
3488
|
+
query_params.append(('sort', params['sort'])) # noqa: E501
|
|
3489
|
+
if 'limit' in params:
|
|
3490
|
+
query_params.append(('limit', params['limit'])) # noqa: E501
|
|
3491
|
+
if 'skip' in params:
|
|
3492
|
+
query_params.append(('skip', params['skip'])) # noqa: E501
|
|
3493
|
+
if 'page' in params:
|
|
3494
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
3495
|
+
if 'after_id' in params:
|
|
3496
|
+
query_params.append(('after_id', params['after_id'])) # noqa: E501
|
|
3497
|
+
|
|
3498
|
+
header_params = {}
|
|
3499
|
+
if 'x_accept_feature' in params:
|
|
3500
|
+
header_params['x-accept-feature'] = params['x_accept_feature'] # noqa: E501
|
|
3501
|
+
collection_formats['x-accept-feature'] = '' # noqa: E501
|
|
3502
|
+
|
|
3503
|
+
form_params = []
|
|
3504
|
+
local_var_files = {}
|
|
3505
|
+
|
|
3506
|
+
body_params = None
|
|
3507
|
+
# HTTP header `Accept`
|
|
3508
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3509
|
+
['application/json']) # noqa: E501
|
|
3510
|
+
|
|
3511
|
+
# Authentication setting
|
|
3512
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
3513
|
+
|
|
3514
|
+
return self.api_client.call_api(
|
|
3515
|
+
'/containers/{container_id}/views', 'GET',
|
|
3516
|
+
path_params,
|
|
3517
|
+
query_params,
|
|
3518
|
+
header_params,
|
|
3519
|
+
body=body_params,
|
|
3520
|
+
post_params=form_params,
|
|
3521
|
+
files=local_var_files,
|
|
3522
|
+
response_type='union[Page,list[ViewOutput]]', # noqa: E501
|
|
3523
|
+
auth_settings=auth_settings,
|
|
3524
|
+
async_=params.get('async_'),
|
|
3525
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3526
|
+
_preload_content=params.get('_preload_content', True),
|
|
3527
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3528
|
+
_request_out=params.get('_request_out'),
|
|
3529
|
+
collection_formats=collection_formats)
|
|
3530
|
+
|
|
3531
|
+
def modify_container(self, container_id, body, **kwargs): # noqa: E501
|
|
3532
|
+
"""Update a container and its contents
|
|
3533
|
+
|
|
3534
|
+
Modify Container
|
|
3535
|
+
This method makes a synchronous HTTP request by default.
|
|
3536
|
+
|
|
3537
|
+
:param str container_id: (required)
|
|
3538
|
+
:param ContainerUpdate body: (required)
|
|
3539
|
+
:param bool async_: Perform the request asynchronously
|
|
3540
|
+
:return: ModifiedResult
|
|
3541
|
+
"""
|
|
3542
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3543
|
+
kwargs['_return_http_data_only'] = True
|
|
3544
|
+
|
|
3545
|
+
if kwargs.get('async_'):
|
|
3546
|
+
return self.modify_container_with_http_info(container_id, body, **kwargs) # noqa: E501
|
|
3547
|
+
else:
|
|
3548
|
+
(data) = self.modify_container_with_http_info(container_id, body, **kwargs) # noqa: E501
|
|
3549
|
+
if (
|
|
3550
|
+
data
|
|
3551
|
+
and hasattr(data, 'return_value')
|
|
3552
|
+
and not ignore_simplified_return_value
|
|
3553
|
+
):
|
|
3554
|
+
return data.return_value()
|
|
3555
|
+
return data
|
|
3556
|
+
|
|
3557
|
+
|
|
3558
|
+
def modify_container_with_http_info(self, container_id, body, **kwargs): # noqa: E501
|
|
3559
|
+
"""Update a container and its contents
|
|
3560
|
+
|
|
3561
|
+
Modify Container
|
|
3562
|
+
This method makes a synchronous HTTP request by default.
|
|
3563
|
+
|
|
3564
|
+
:param str container_id: (required)
|
|
3565
|
+
:param ContainerUpdate body: (required)
|
|
3566
|
+
:param bool async_: Perform the request asynchronously
|
|
3567
|
+
:return: ModifiedResult
|
|
3568
|
+
"""
|
|
3569
|
+
|
|
3570
|
+
all_params = ['container_id','body',] # noqa: E501
|
|
3571
|
+
all_params.append('async_')
|
|
3572
|
+
all_params.append('_return_http_data_only')
|
|
3573
|
+
all_params.append('_preload_content')
|
|
3574
|
+
all_params.append('_request_timeout')
|
|
3575
|
+
all_params.append('_request_out')
|
|
3576
|
+
|
|
3577
|
+
params = locals()
|
|
3578
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3579
|
+
if key not in all_params:
|
|
3580
|
+
raise TypeError(
|
|
3581
|
+
"Got an unexpected keyword argument '%s'"
|
|
3582
|
+
" to method modify_container" % key
|
|
3583
|
+
)
|
|
3584
|
+
params[key] = val
|
|
3585
|
+
del params['kwargs']
|
|
3586
|
+
# verify the required parameter 'container_id' is set
|
|
3587
|
+
if ('container_id' not in params or
|
|
3588
|
+
params['container_id'] is None):
|
|
3589
|
+
raise ValueError("Missing the required parameter `container_id` when calling `modify_container`") # noqa: E501
|
|
3590
|
+
# verify the required parameter 'body' is set
|
|
3591
|
+
if ('body' not in params or
|
|
3592
|
+
params['body'] is None):
|
|
3593
|
+
raise ValueError("Missing the required parameter `body` when calling `modify_container`") # noqa: E501
|
|
3594
|
+
check_filename_params(params)
|
|
3595
|
+
|
|
3596
|
+
collection_formats = {}
|
|
3597
|
+
|
|
3598
|
+
path_params = {}
|
|
3599
|
+
if 'container_id' in params:
|
|
3600
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
3601
|
+
|
|
3602
|
+
query_params = []
|
|
3603
|
+
|
|
3604
|
+
header_params = {}
|
|
3605
|
+
|
|
3606
|
+
form_params = []
|
|
3607
|
+
local_var_files = {}
|
|
3608
|
+
|
|
3609
|
+
body_params = None
|
|
3610
|
+
if 'body' in params:
|
|
3611
|
+
if 'ContainerUpdate'.startswith('union'):
|
|
3612
|
+
body_type = type(params['body'])
|
|
3613
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
3614
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
3615
|
+
else:
|
|
3616
|
+
body_params = params['body']
|
|
3617
|
+
else:
|
|
3618
|
+
body_params = flywheel.models.ContainerUpdate.positional_to_model(params['body'])
|
|
3619
|
+
# HTTP header `Accept`
|
|
3620
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3621
|
+
['application/json']) # noqa: E501
|
|
3622
|
+
|
|
3623
|
+
# HTTP header `Content-Type`
|
|
3624
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
3625
|
+
['application/json']) # noqa: E501
|
|
3626
|
+
|
|
3627
|
+
# Authentication setting
|
|
3628
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
3629
|
+
|
|
3630
|
+
return self.api_client.call_api(
|
|
3631
|
+
'/containers/{container_id}', 'PUT',
|
|
3632
|
+
path_params,
|
|
3633
|
+
query_params,
|
|
3634
|
+
header_params,
|
|
3635
|
+
body=body_params,
|
|
3636
|
+
post_params=form_params,
|
|
3637
|
+
files=local_var_files,
|
|
3638
|
+
response_type='ModifiedResult', # noqa: E501
|
|
3639
|
+
auth_settings=auth_settings,
|
|
3640
|
+
async_=params.get('async_'),
|
|
3641
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3642
|
+
_preload_content=params.get('_preload_content', True),
|
|
3643
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3644
|
+
_request_out=params.get('_request_out'),
|
|
3645
|
+
collection_formats=collection_formats)
|
|
3646
|
+
|
|
3647
|
+
def modify_container_analysis(self, cid, analysis_id, body, **kwargs): # noqa: E501
|
|
3648
|
+
"""Modify an analysis.
|
|
3649
|
+
|
|
3650
|
+
Modify an analysis.
|
|
3651
|
+
This method makes a synchronous HTTP request by default.
|
|
3652
|
+
|
|
3653
|
+
:param str cid: (required)
|
|
3654
|
+
:param str analysis_id: (required)
|
|
3655
|
+
:param AnalysisModifyInput body: (required)
|
|
3656
|
+
:param bool async_: Perform the request asynchronously
|
|
3657
|
+
:return: ModifiedResult
|
|
3658
|
+
"""
|
|
3659
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3660
|
+
kwargs['_return_http_data_only'] = True
|
|
3661
|
+
|
|
3662
|
+
if kwargs.get('async_'):
|
|
3663
|
+
return self.modify_container_analysis_with_http_info(cid, analysis_id, body, **kwargs) # noqa: E501
|
|
3664
|
+
else:
|
|
3665
|
+
(data) = self.modify_container_analysis_with_http_info(cid, analysis_id, body, **kwargs) # noqa: E501
|
|
3666
|
+
if (
|
|
3667
|
+
data
|
|
3668
|
+
and hasattr(data, 'return_value')
|
|
3669
|
+
and not ignore_simplified_return_value
|
|
3670
|
+
):
|
|
3671
|
+
return data.return_value()
|
|
3672
|
+
return data
|
|
3673
|
+
|
|
3674
|
+
|
|
3675
|
+
def modify_container_analysis_with_http_info(self, cid, analysis_id, body, **kwargs): # noqa: E501
|
|
3676
|
+
"""Modify an analysis.
|
|
3677
|
+
|
|
3678
|
+
Modify an analysis.
|
|
3679
|
+
This method makes a synchronous HTTP request by default.
|
|
3680
|
+
|
|
3681
|
+
:param str cid: (required)
|
|
3682
|
+
:param str analysis_id: (required)
|
|
3683
|
+
:param AnalysisModifyInput body: (required)
|
|
3684
|
+
:param bool async_: Perform the request asynchronously
|
|
3685
|
+
:return: ModifiedResult
|
|
3686
|
+
"""
|
|
3687
|
+
|
|
3688
|
+
all_params = ['cid','analysis_id','body',] # noqa: E501
|
|
3689
|
+
all_params.append('async_')
|
|
3690
|
+
all_params.append('_return_http_data_only')
|
|
3691
|
+
all_params.append('_preload_content')
|
|
3692
|
+
all_params.append('_request_timeout')
|
|
3693
|
+
all_params.append('_request_out')
|
|
3694
|
+
|
|
3695
|
+
params = locals()
|
|
3696
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3697
|
+
if key not in all_params:
|
|
3698
|
+
raise TypeError(
|
|
3699
|
+
"Got an unexpected keyword argument '%s'"
|
|
3700
|
+
" to method modify_container_analysis" % key
|
|
3701
|
+
)
|
|
3702
|
+
params[key] = val
|
|
3703
|
+
del params['kwargs']
|
|
3704
|
+
# verify the required parameter 'cid' is set
|
|
3705
|
+
if ('cid' not in params or
|
|
3706
|
+
params['cid'] is None):
|
|
3707
|
+
raise ValueError("Missing the required parameter `cid` when calling `modify_container_analysis`") # noqa: E501
|
|
3708
|
+
# verify the required parameter 'analysis_id' is set
|
|
3709
|
+
if ('analysis_id' not in params or
|
|
3710
|
+
params['analysis_id'] is None):
|
|
3711
|
+
raise ValueError("Missing the required parameter `analysis_id` when calling `modify_container_analysis`") # noqa: E501
|
|
3712
|
+
# verify the required parameter 'body' is set
|
|
3713
|
+
if ('body' not in params or
|
|
3714
|
+
params['body'] is None):
|
|
3715
|
+
raise ValueError("Missing the required parameter `body` when calling `modify_container_analysis`") # noqa: E501
|
|
3716
|
+
check_filename_params(params)
|
|
3717
|
+
|
|
3718
|
+
collection_formats = {}
|
|
3719
|
+
|
|
3720
|
+
path_params = {}
|
|
3721
|
+
if 'cid' in params:
|
|
3722
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
3723
|
+
if 'analysis_id' in params:
|
|
3724
|
+
path_params['analysis_id'] = params['analysis_id'] # noqa: E501
|
|
3725
|
+
|
|
3726
|
+
query_params = []
|
|
3727
|
+
|
|
3728
|
+
header_params = {}
|
|
3729
|
+
|
|
3730
|
+
form_params = []
|
|
3731
|
+
local_var_files = {}
|
|
3732
|
+
|
|
3733
|
+
body_params = None
|
|
3734
|
+
if 'body' in params:
|
|
3735
|
+
if 'AnalysisModifyInput'.startswith('union'):
|
|
3736
|
+
body_type = type(params['body'])
|
|
3737
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
3738
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
3739
|
+
else:
|
|
3740
|
+
body_params = params['body']
|
|
3741
|
+
else:
|
|
3742
|
+
body_params = flywheel.models.AnalysisModifyInput.positional_to_model(params['body'])
|
|
3743
|
+
# HTTP header `Accept`
|
|
3744
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3745
|
+
['application/json']) # noqa: E501
|
|
3746
|
+
|
|
3747
|
+
# HTTP header `Content-Type`
|
|
3748
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
3749
|
+
['application/json']) # noqa: E501
|
|
3750
|
+
|
|
3751
|
+
# Authentication setting
|
|
3752
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
3753
|
+
|
|
3754
|
+
return self.api_client.call_api(
|
|
3755
|
+
'/containers/{cid}/analyses/{analysis_id}', 'PUT',
|
|
3756
|
+
path_params,
|
|
3757
|
+
query_params,
|
|
3758
|
+
header_params,
|
|
3759
|
+
body=body_params,
|
|
3760
|
+
post_params=form_params,
|
|
3761
|
+
files=local_var_files,
|
|
3762
|
+
response_type='ModifiedResult', # noqa: E501
|
|
3763
|
+
auth_settings=auth_settings,
|
|
3764
|
+
async_=params.get('async_'),
|
|
3765
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3766
|
+
_preload_content=params.get('_preload_content', True),
|
|
3767
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3768
|
+
_request_out=params.get('_request_out'),
|
|
3769
|
+
collection_formats=collection_formats)
|
|
3770
|
+
|
|
3771
|
+
def modify_container_file(self, cid, filename, body, **kwargs): # noqa: E501
|
|
3772
|
+
"""Modify a file's attributes
|
|
3773
|
+
|
|
3774
|
+
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
3775
|
+
This method makes a synchronous HTTP request by default.
|
|
3776
|
+
|
|
3777
|
+
:param str cid: (required)
|
|
3778
|
+
:param str filename: (required)
|
|
3779
|
+
:param FileModifyInput body: (required)
|
|
3780
|
+
:param bool async_: Perform the request asynchronously
|
|
3781
|
+
:return: ModifiedResult
|
|
3782
|
+
"""
|
|
3783
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3784
|
+
kwargs['_return_http_data_only'] = True
|
|
3785
|
+
|
|
3786
|
+
if kwargs.get('async_'):
|
|
3787
|
+
return self.modify_container_file_with_http_info(cid, filename, body, **kwargs) # noqa: E501
|
|
3788
|
+
else:
|
|
3789
|
+
(data) = self.modify_container_file_with_http_info(cid, filename, body, **kwargs) # noqa: E501
|
|
3790
|
+
if (
|
|
3791
|
+
data
|
|
3792
|
+
and hasattr(data, 'return_value')
|
|
3793
|
+
and not ignore_simplified_return_value
|
|
3794
|
+
):
|
|
3795
|
+
return data.return_value()
|
|
3796
|
+
return data
|
|
3797
|
+
|
|
3798
|
+
|
|
3799
|
+
def modify_container_file_with_http_info(self, cid, filename, body, **kwargs): # noqa: E501
|
|
3800
|
+
"""Modify a file's attributes
|
|
3801
|
+
|
|
3802
|
+
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
3803
|
+
This method makes a synchronous HTTP request by default.
|
|
3804
|
+
|
|
3805
|
+
:param str cid: (required)
|
|
3806
|
+
:param str filename: (required)
|
|
3807
|
+
:param FileModifyInput body: (required)
|
|
3808
|
+
:param bool async_: Perform the request asynchronously
|
|
3809
|
+
:return: ModifiedResult
|
|
3810
|
+
"""
|
|
3811
|
+
|
|
3812
|
+
all_params = ['cid','filename','body',] # noqa: E501
|
|
3813
|
+
all_params.append('async_')
|
|
3814
|
+
all_params.append('_return_http_data_only')
|
|
3815
|
+
all_params.append('_preload_content')
|
|
3816
|
+
all_params.append('_request_timeout')
|
|
3817
|
+
all_params.append('_request_out')
|
|
3818
|
+
|
|
3819
|
+
params = locals()
|
|
3820
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3821
|
+
if key not in all_params:
|
|
3822
|
+
raise TypeError(
|
|
3823
|
+
"Got an unexpected keyword argument '%s'"
|
|
3824
|
+
" to method modify_container_file" % key
|
|
3825
|
+
)
|
|
3826
|
+
params[key] = val
|
|
3827
|
+
del params['kwargs']
|
|
3828
|
+
# verify the required parameter 'cid' is set
|
|
3829
|
+
if ('cid' not in params or
|
|
3830
|
+
params['cid'] is None):
|
|
3831
|
+
raise ValueError("Missing the required parameter `cid` when calling `modify_container_file`") # noqa: E501
|
|
3832
|
+
# verify the required parameter 'filename' is set
|
|
3833
|
+
if ('filename' not in params or
|
|
3834
|
+
params['filename'] is None):
|
|
3835
|
+
raise ValueError("Missing the required parameter `filename` when calling `modify_container_file`") # noqa: E501
|
|
3836
|
+
# verify the required parameter 'body' is set
|
|
3837
|
+
if ('body' not in params or
|
|
3838
|
+
params['body'] is None):
|
|
3839
|
+
raise ValueError("Missing the required parameter `body` when calling `modify_container_file`") # noqa: E501
|
|
3840
|
+
check_filename_params(params)
|
|
3841
|
+
|
|
3842
|
+
collection_formats = {}
|
|
3843
|
+
|
|
3844
|
+
path_params = {}
|
|
3845
|
+
if 'cid' in params:
|
|
3846
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
3847
|
+
if 'filename' in params:
|
|
3848
|
+
path_params['filename'] = params['filename'] # noqa: E501
|
|
3849
|
+
|
|
3850
|
+
query_params = []
|
|
3851
|
+
|
|
3852
|
+
header_params = {}
|
|
3853
|
+
|
|
3854
|
+
form_params = []
|
|
3855
|
+
local_var_files = {}
|
|
3856
|
+
|
|
3857
|
+
body_params = None
|
|
3858
|
+
if 'body' in params:
|
|
3859
|
+
if 'FileModifyInput'.startswith('union'):
|
|
3860
|
+
body_type = type(params['body'])
|
|
3861
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
3862
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
3863
|
+
else:
|
|
3864
|
+
body_params = params['body']
|
|
3865
|
+
else:
|
|
3866
|
+
body_params = flywheel.models.FileModifyInput.positional_to_model(params['body'])
|
|
3867
|
+
# HTTP header `Accept`
|
|
3868
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3869
|
+
['application/json']) # noqa: E501
|
|
3870
|
+
|
|
3871
|
+
# HTTP header `Content-Type`
|
|
3872
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
3873
|
+
['application/json']) # noqa: E501
|
|
3874
|
+
|
|
3875
|
+
# Authentication setting
|
|
3876
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
3877
|
+
|
|
3878
|
+
return self.api_client.call_api(
|
|
3879
|
+
'/containers/{cid}/files/{filename}', 'PUT',
|
|
3880
|
+
path_params,
|
|
3881
|
+
query_params,
|
|
3882
|
+
header_params,
|
|
3883
|
+
body=body_params,
|
|
3884
|
+
post_params=form_params,
|
|
3885
|
+
files=local_var_files,
|
|
3886
|
+
response_type='ModifiedResult', # noqa: E501
|
|
3887
|
+
auth_settings=auth_settings,
|
|
3888
|
+
async_=params.get('async_'),
|
|
3889
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3890
|
+
_preload_content=params.get('_preload_content', True),
|
|
3891
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3892
|
+
_request_out=params.get('_request_out'),
|
|
3893
|
+
collection_formats=collection_formats)
|
|
3894
|
+
|
|
3895
|
+
def modify_container_file_classification(self, cid, filename, body, **kwargs): # noqa: E501
|
|
3896
|
+
"""Update classification for a particular file.
|
|
3897
|
+
|
|
3898
|
+
If replacing a file's classification, the modality can optionally be modified as well.
|
|
3899
|
+
This method makes a synchronous HTTP request by default.
|
|
3900
|
+
|
|
3901
|
+
:param str cid: (required)
|
|
3902
|
+
:param str filename: (required)
|
|
3903
|
+
:param FileClassificationDelta body: (required)
|
|
3904
|
+
:param bool async_: Perform the request asynchronously
|
|
3905
|
+
:return: ModifiedResult
|
|
3906
|
+
"""
|
|
3907
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
3908
|
+
kwargs['_return_http_data_only'] = True
|
|
3909
|
+
|
|
3910
|
+
if kwargs.get('async_'):
|
|
3911
|
+
return self.modify_container_file_classification_with_http_info(cid, filename, body, **kwargs) # noqa: E501
|
|
3912
|
+
else:
|
|
3913
|
+
(data) = self.modify_container_file_classification_with_http_info(cid, filename, body, **kwargs) # noqa: E501
|
|
3914
|
+
if (
|
|
3915
|
+
data
|
|
3916
|
+
and hasattr(data, 'return_value')
|
|
3917
|
+
and not ignore_simplified_return_value
|
|
3918
|
+
):
|
|
3919
|
+
return data.return_value()
|
|
3920
|
+
return data
|
|
3921
|
+
|
|
3922
|
+
|
|
3923
|
+
def modify_container_file_classification_with_http_info(self, cid, filename, body, **kwargs): # noqa: E501
|
|
3924
|
+
"""Update classification for a particular file.
|
|
3925
|
+
|
|
3926
|
+
If replacing a file's classification, the modality can optionally be modified as well.
|
|
3927
|
+
This method makes a synchronous HTTP request by default.
|
|
3928
|
+
|
|
3929
|
+
:param str cid: (required)
|
|
3930
|
+
:param str filename: (required)
|
|
3931
|
+
:param FileClassificationDelta body: (required)
|
|
3932
|
+
:param bool async_: Perform the request asynchronously
|
|
3933
|
+
:return: ModifiedResult
|
|
3934
|
+
"""
|
|
3935
|
+
|
|
3936
|
+
all_params = ['cid','filename','body',] # noqa: E501
|
|
3937
|
+
all_params.append('async_')
|
|
3938
|
+
all_params.append('_return_http_data_only')
|
|
3939
|
+
all_params.append('_preload_content')
|
|
3940
|
+
all_params.append('_request_timeout')
|
|
3941
|
+
all_params.append('_request_out')
|
|
3942
|
+
|
|
3943
|
+
params = locals()
|
|
3944
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3945
|
+
if key not in all_params:
|
|
3946
|
+
raise TypeError(
|
|
3947
|
+
"Got an unexpected keyword argument '%s'"
|
|
3948
|
+
" to method modify_container_file_classification" % key
|
|
3949
|
+
)
|
|
3950
|
+
params[key] = val
|
|
3951
|
+
del params['kwargs']
|
|
3952
|
+
# verify the required parameter 'cid' is set
|
|
3953
|
+
if ('cid' not in params or
|
|
3954
|
+
params['cid'] is None):
|
|
3955
|
+
raise ValueError("Missing the required parameter `cid` when calling `modify_container_file_classification`") # noqa: E501
|
|
3956
|
+
# verify the required parameter 'filename' is set
|
|
3957
|
+
if ('filename' not in params or
|
|
3958
|
+
params['filename'] is None):
|
|
3959
|
+
raise ValueError("Missing the required parameter `filename` when calling `modify_container_file_classification`") # noqa: E501
|
|
3960
|
+
# verify the required parameter 'body' is set
|
|
3961
|
+
if ('body' not in params or
|
|
3962
|
+
params['body'] is None):
|
|
3963
|
+
raise ValueError("Missing the required parameter `body` when calling `modify_container_file_classification`") # noqa: E501
|
|
3964
|
+
check_filename_params(params)
|
|
3965
|
+
|
|
3966
|
+
collection_formats = {}
|
|
3967
|
+
|
|
3968
|
+
path_params = {}
|
|
3969
|
+
if 'cid' in params:
|
|
3970
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
3971
|
+
if 'filename' in params:
|
|
3972
|
+
path_params['filename'] = params['filename'] # noqa: E501
|
|
3973
|
+
|
|
3974
|
+
query_params = []
|
|
3975
|
+
|
|
3976
|
+
header_params = {}
|
|
3977
|
+
|
|
3978
|
+
form_params = []
|
|
3979
|
+
local_var_files = {}
|
|
3980
|
+
|
|
3981
|
+
body_params = None
|
|
3982
|
+
if 'body' in params:
|
|
3983
|
+
if 'FileClassificationDelta'.startswith('union'):
|
|
3984
|
+
body_type = type(params['body'])
|
|
3985
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
3986
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
3987
|
+
else:
|
|
3988
|
+
body_params = params['body']
|
|
3989
|
+
else:
|
|
3990
|
+
body_params = flywheel.models.FileClassificationDelta.positional_to_model(params['body'])
|
|
3991
|
+
# HTTP header `Accept`
|
|
3992
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3993
|
+
['application/json']) # noqa: E501
|
|
3994
|
+
|
|
3995
|
+
# HTTP header `Content-Type`
|
|
3996
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
3997
|
+
['application/json']) # noqa: E501
|
|
3998
|
+
|
|
3999
|
+
# Authentication setting
|
|
4000
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
4001
|
+
|
|
4002
|
+
return self.api_client.call_api(
|
|
4003
|
+
'/containers/{cid}/files/{filename}/classification', 'PATCH',
|
|
4004
|
+
path_params,
|
|
4005
|
+
query_params,
|
|
4006
|
+
header_params,
|
|
4007
|
+
body=body_params,
|
|
4008
|
+
post_params=form_params,
|
|
4009
|
+
files=local_var_files,
|
|
4010
|
+
response_type='ModifiedResult', # noqa: E501
|
|
4011
|
+
auth_settings=auth_settings,
|
|
4012
|
+
async_=params.get('async_'),
|
|
4013
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
4014
|
+
_preload_content=params.get('_preload_content', True),
|
|
4015
|
+
_request_timeout=params.get('_request_timeout'),
|
|
4016
|
+
_request_out=params.get('_request_out'),
|
|
4017
|
+
collection_formats=collection_formats)
|
|
4018
|
+
|
|
4019
|
+
def modify_container_file_info(self, cid, filename, body, **kwargs): # noqa: E501
|
|
4020
|
+
"""Update info for a particular file.
|
|
4021
|
+
|
|
4022
|
+
Modify and return the file 'info' field
|
|
4023
|
+
This method makes a synchronous HTTP request by default.
|
|
4024
|
+
|
|
4025
|
+
:param str cid: (required)
|
|
4026
|
+
:param str filename: (required)
|
|
4027
|
+
:param Info body: (required)
|
|
4028
|
+
:param bool async_: Perform the request asynchronously
|
|
4029
|
+
:return: ModifiedResult
|
|
4030
|
+
"""
|
|
4031
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4032
|
+
kwargs['_return_http_data_only'] = True
|
|
4033
|
+
|
|
4034
|
+
if kwargs.get('async_'):
|
|
4035
|
+
return self.modify_container_file_info_with_http_info(cid, filename, body, **kwargs) # noqa: E501
|
|
4036
|
+
else:
|
|
4037
|
+
(data) = self.modify_container_file_info_with_http_info(cid, filename, body, **kwargs) # noqa: E501
|
|
4038
|
+
if (
|
|
4039
|
+
data
|
|
4040
|
+
and hasattr(data, 'return_value')
|
|
4041
|
+
and not ignore_simplified_return_value
|
|
4042
|
+
):
|
|
4043
|
+
return data.return_value()
|
|
4044
|
+
return data
|
|
4045
|
+
|
|
4046
|
+
|
|
4047
|
+
def modify_container_file_info_with_http_info(self, cid, filename, body, **kwargs): # noqa: E501
|
|
4048
|
+
"""Update info for a particular file.
|
|
4049
|
+
|
|
4050
|
+
Modify and return the file 'info' field
|
|
4051
|
+
This method makes a synchronous HTTP request by default.
|
|
4052
|
+
|
|
4053
|
+
:param str cid: (required)
|
|
4054
|
+
:param str filename: (required)
|
|
4055
|
+
:param Info body: (required)
|
|
4056
|
+
:param bool async_: Perform the request asynchronously
|
|
4057
|
+
:return: ModifiedResult
|
|
4058
|
+
"""
|
|
4059
|
+
|
|
4060
|
+
all_params = ['cid','filename','body',] # noqa: E501
|
|
4061
|
+
all_params.append('async_')
|
|
4062
|
+
all_params.append('_return_http_data_only')
|
|
4063
|
+
all_params.append('_preload_content')
|
|
4064
|
+
all_params.append('_request_timeout')
|
|
4065
|
+
all_params.append('_request_out')
|
|
4066
|
+
|
|
4067
|
+
params = locals()
|
|
4068
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
4069
|
+
if key not in all_params:
|
|
4070
|
+
raise TypeError(
|
|
4071
|
+
"Got an unexpected keyword argument '%s'"
|
|
4072
|
+
" to method modify_container_file_info" % key
|
|
4073
|
+
)
|
|
4074
|
+
params[key] = val
|
|
4075
|
+
del params['kwargs']
|
|
4076
|
+
# verify the required parameter 'cid' is set
|
|
4077
|
+
if ('cid' not in params or
|
|
4078
|
+
params['cid'] is None):
|
|
4079
|
+
raise ValueError("Missing the required parameter `cid` when calling `modify_container_file_info`") # noqa: E501
|
|
4080
|
+
# verify the required parameter 'filename' is set
|
|
4081
|
+
if ('filename' not in params or
|
|
4082
|
+
params['filename'] is None):
|
|
4083
|
+
raise ValueError("Missing the required parameter `filename` when calling `modify_container_file_info`") # noqa: E501
|
|
4084
|
+
# verify the required parameter 'body' is set
|
|
4085
|
+
if ('body' not in params or
|
|
4086
|
+
params['body'] is None):
|
|
4087
|
+
raise ValueError("Missing the required parameter `body` when calling `modify_container_file_info`") # noqa: E501
|
|
4088
|
+
check_filename_params(params)
|
|
4089
|
+
|
|
4090
|
+
collection_formats = {}
|
|
4091
|
+
|
|
4092
|
+
path_params = {}
|
|
4093
|
+
if 'cid' in params:
|
|
4094
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
4095
|
+
if 'filename' in params:
|
|
4096
|
+
path_params['filename'] = params['filename'] # noqa: E501
|
|
4097
|
+
|
|
4098
|
+
query_params = []
|
|
4099
|
+
|
|
4100
|
+
header_params = {}
|
|
4101
|
+
|
|
4102
|
+
form_params = []
|
|
4103
|
+
local_var_files = {}
|
|
4104
|
+
|
|
4105
|
+
body_params = None
|
|
4106
|
+
if 'body' in params:
|
|
4107
|
+
if 'Info'.startswith('union'):
|
|
4108
|
+
body_type = type(params['body'])
|
|
4109
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
4110
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
4111
|
+
else:
|
|
4112
|
+
body_params = params['body']
|
|
4113
|
+
else:
|
|
4114
|
+
body_params = flywheel.models.Info.positional_to_model(params['body'])
|
|
4115
|
+
# HTTP header `Accept`
|
|
4116
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
4117
|
+
['application/json']) # noqa: E501
|
|
4118
|
+
|
|
4119
|
+
# HTTP header `Content-Type`
|
|
4120
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
4121
|
+
['application/json']) # noqa: E501
|
|
4122
|
+
|
|
4123
|
+
# Authentication setting
|
|
4124
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
4125
|
+
|
|
4126
|
+
return self.api_client.call_api(
|
|
4127
|
+
'/containers/{cid}/files/{filename}/info', 'PATCH',
|
|
4128
|
+
path_params,
|
|
4129
|
+
query_params,
|
|
4130
|
+
header_params,
|
|
4131
|
+
body=body_params,
|
|
4132
|
+
post_params=form_params,
|
|
4133
|
+
files=local_var_files,
|
|
4134
|
+
response_type='ModifiedResult', # noqa: E501
|
|
4135
|
+
auth_settings=auth_settings,
|
|
4136
|
+
async_=params.get('async_'),
|
|
4137
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
4138
|
+
_preload_content=params.get('_preload_content', True),
|
|
4139
|
+
_request_timeout=params.get('_request_timeout'),
|
|
4140
|
+
_request_out=params.get('_request_out'),
|
|
4141
|
+
collection_formats=collection_formats)
|
|
4142
|
+
|
|
4143
|
+
def modify_container_info(self, cid, body, **kwargs): # noqa: E501
|
|
4144
|
+
"""Update or replace info for a(n) container.
|
|
4145
|
+
|
|
4146
|
+
Update or replace info for a(n) container. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
4147
|
+
This method makes a synchronous HTTP request by default.
|
|
4148
|
+
|
|
4149
|
+
:param str cid: (required)
|
|
4150
|
+
:param Info body: (required)
|
|
4151
|
+
:param bool async_: Perform the request asynchronously
|
|
4152
|
+
:return: ModifiedResult
|
|
4153
|
+
"""
|
|
4154
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4155
|
+
kwargs['_return_http_data_only'] = True
|
|
4156
|
+
|
|
4157
|
+
if kwargs.get('async_'):
|
|
4158
|
+
return self.modify_container_info_with_http_info(cid, body, **kwargs) # noqa: E501
|
|
4159
|
+
else:
|
|
4160
|
+
(data) = self.modify_container_info_with_http_info(cid, body, **kwargs) # noqa: E501
|
|
4161
|
+
if (
|
|
4162
|
+
data
|
|
4163
|
+
and hasattr(data, 'return_value')
|
|
4164
|
+
and not ignore_simplified_return_value
|
|
4165
|
+
):
|
|
4166
|
+
return data.return_value()
|
|
4167
|
+
return data
|
|
4168
|
+
|
|
4169
|
+
|
|
4170
|
+
def modify_container_info_with_http_info(self, cid, body, **kwargs): # noqa: E501
|
|
4171
|
+
"""Update or replace info for a(n) container.
|
|
4172
|
+
|
|
4173
|
+
Update or replace info for a(n) container. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
4174
|
+
This method makes a synchronous HTTP request by default.
|
|
4175
|
+
|
|
4176
|
+
:param str cid: (required)
|
|
4177
|
+
:param Info body: (required)
|
|
4178
|
+
:param bool async_: Perform the request asynchronously
|
|
4179
|
+
:return: ModifiedResult
|
|
4180
|
+
"""
|
|
4181
|
+
|
|
4182
|
+
all_params = ['cid','body',] # noqa: E501
|
|
4183
|
+
all_params.append('async_')
|
|
4184
|
+
all_params.append('_return_http_data_only')
|
|
4185
|
+
all_params.append('_preload_content')
|
|
4186
|
+
all_params.append('_request_timeout')
|
|
4187
|
+
all_params.append('_request_out')
|
|
4188
|
+
|
|
4189
|
+
params = locals()
|
|
4190
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
4191
|
+
if key not in all_params:
|
|
4192
|
+
raise TypeError(
|
|
4193
|
+
"Got an unexpected keyword argument '%s'"
|
|
4194
|
+
" to method modify_container_info" % key
|
|
4195
|
+
)
|
|
4196
|
+
params[key] = val
|
|
4197
|
+
del params['kwargs']
|
|
4198
|
+
# verify the required parameter 'cid' is set
|
|
4199
|
+
if ('cid' not in params or
|
|
4200
|
+
params['cid'] is None):
|
|
4201
|
+
raise ValueError("Missing the required parameter `cid` when calling `modify_container_info`") # noqa: E501
|
|
4202
|
+
# verify the required parameter 'body' is set
|
|
4203
|
+
if ('body' not in params or
|
|
4204
|
+
params['body'] is None):
|
|
4205
|
+
raise ValueError("Missing the required parameter `body` when calling `modify_container_info`") # noqa: E501
|
|
4206
|
+
check_filename_params(params)
|
|
4207
|
+
|
|
4208
|
+
collection_formats = {}
|
|
4209
|
+
|
|
4210
|
+
path_params = {}
|
|
4211
|
+
if 'cid' in params:
|
|
4212
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
4213
|
+
|
|
4214
|
+
query_params = []
|
|
4215
|
+
|
|
4216
|
+
header_params = {}
|
|
4217
|
+
|
|
4218
|
+
form_params = []
|
|
4219
|
+
local_var_files = {}
|
|
4220
|
+
|
|
4221
|
+
body_params = None
|
|
4222
|
+
if 'body' in params:
|
|
4223
|
+
if 'Info'.startswith('union'):
|
|
4224
|
+
body_type = type(params['body'])
|
|
4225
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
4226
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
4227
|
+
else:
|
|
4228
|
+
body_params = params['body']
|
|
4229
|
+
else:
|
|
4230
|
+
body_params = flywheel.models.Info.positional_to_model(params['body'])
|
|
4231
|
+
# HTTP header `Accept`
|
|
4232
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
4233
|
+
['application/json']) # noqa: E501
|
|
4234
|
+
|
|
4235
|
+
# HTTP header `Content-Type`
|
|
4236
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
4237
|
+
['application/json']) # noqa: E501
|
|
4238
|
+
|
|
4239
|
+
# Authentication setting
|
|
4240
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
4241
|
+
|
|
4242
|
+
return self.api_client.call_api(
|
|
4243
|
+
'/containers/{cid}/info', 'PATCH',
|
|
4244
|
+
path_params,
|
|
4245
|
+
query_params,
|
|
4246
|
+
header_params,
|
|
4247
|
+
body=body_params,
|
|
4248
|
+
post_params=form_params,
|
|
4249
|
+
files=local_var_files,
|
|
4250
|
+
response_type='ModifiedResult', # noqa: E501
|
|
4251
|
+
auth_settings=auth_settings,
|
|
4252
|
+
async_=params.get('async_'),
|
|
4253
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
4254
|
+
_preload_content=params.get('_preload_content', True),
|
|
4255
|
+
_request_timeout=params.get('_request_timeout'),
|
|
4256
|
+
_request_out=params.get('_request_out'),
|
|
4257
|
+
collection_formats=collection_formats)
|
|
4258
|
+
|
|
4259
|
+
def modify_container_note(self, cid, note_id, body, **kwargs): # noqa: E501
|
|
4260
|
+
"""Update a note of a(n) container.
|
|
4261
|
+
|
|
4262
|
+
Update a note of a(n) container
|
|
4263
|
+
This method makes a synchronous HTTP request by default.
|
|
4264
|
+
|
|
4265
|
+
:param str cid: (required)
|
|
4266
|
+
:param str note_id: (required)
|
|
4267
|
+
:param NoteInput body: (required)
|
|
4268
|
+
:param bool async_: Perform the request asynchronously
|
|
4269
|
+
:return: int
|
|
4270
|
+
"""
|
|
4271
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4272
|
+
kwargs['_return_http_data_only'] = True
|
|
4273
|
+
|
|
4274
|
+
if kwargs.get('async_'):
|
|
4275
|
+
return self.modify_container_note_with_http_info(cid, note_id, body, **kwargs) # noqa: E501
|
|
4276
|
+
else:
|
|
4277
|
+
(data) = self.modify_container_note_with_http_info(cid, note_id, body, **kwargs) # noqa: E501
|
|
4278
|
+
if (
|
|
4279
|
+
data
|
|
4280
|
+
and hasattr(data, 'return_value')
|
|
4281
|
+
and not ignore_simplified_return_value
|
|
4282
|
+
):
|
|
4283
|
+
return data.return_value()
|
|
4284
|
+
return data
|
|
4285
|
+
|
|
4286
|
+
|
|
4287
|
+
def modify_container_note_with_http_info(self, cid, note_id, body, **kwargs): # noqa: E501
|
|
4288
|
+
"""Update a note of a(n) container.
|
|
4289
|
+
|
|
4290
|
+
Update a note of a(n) container
|
|
4291
|
+
This method makes a synchronous HTTP request by default.
|
|
4292
|
+
|
|
4293
|
+
:param str cid: (required)
|
|
4294
|
+
:param str note_id: (required)
|
|
4295
|
+
:param NoteInput body: (required)
|
|
4296
|
+
:param bool async_: Perform the request asynchronously
|
|
4297
|
+
:return: int
|
|
4298
|
+
"""
|
|
4299
|
+
|
|
4300
|
+
all_params = ['cid','note_id','body',] # noqa: E501
|
|
4301
|
+
all_params.append('async_')
|
|
4302
|
+
all_params.append('_return_http_data_only')
|
|
4303
|
+
all_params.append('_preload_content')
|
|
4304
|
+
all_params.append('_request_timeout')
|
|
4305
|
+
all_params.append('_request_out')
|
|
4306
|
+
|
|
4307
|
+
params = locals()
|
|
4308
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
4309
|
+
if key not in all_params:
|
|
4310
|
+
raise TypeError(
|
|
4311
|
+
"Got an unexpected keyword argument '%s'"
|
|
4312
|
+
" to method modify_container_note" % key
|
|
4313
|
+
)
|
|
4314
|
+
params[key] = val
|
|
4315
|
+
del params['kwargs']
|
|
4316
|
+
# verify the required parameter 'cid' is set
|
|
4317
|
+
if ('cid' not in params or
|
|
4318
|
+
params['cid'] is None):
|
|
4319
|
+
raise ValueError("Missing the required parameter `cid` when calling `modify_container_note`") # noqa: E501
|
|
4320
|
+
# verify the required parameter 'note_id' is set
|
|
4321
|
+
if ('note_id' not in params or
|
|
4322
|
+
params['note_id'] is None):
|
|
4323
|
+
raise ValueError("Missing the required parameter `note_id` when calling `modify_container_note`") # noqa: E501
|
|
4324
|
+
# verify the required parameter 'body' is set
|
|
4325
|
+
if ('body' not in params or
|
|
4326
|
+
params['body'] is None):
|
|
4327
|
+
raise ValueError("Missing the required parameter `body` when calling `modify_container_note`") # noqa: E501
|
|
4328
|
+
check_filename_params(params)
|
|
4329
|
+
|
|
4330
|
+
collection_formats = {}
|
|
4331
|
+
|
|
4332
|
+
path_params = {}
|
|
4333
|
+
if 'cid' in params:
|
|
4334
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
4335
|
+
if 'note_id' in params:
|
|
4336
|
+
path_params['note_id'] = params['note_id'] # noqa: E501
|
|
4337
|
+
|
|
4338
|
+
query_params = []
|
|
4339
|
+
|
|
4340
|
+
header_params = {}
|
|
4341
|
+
|
|
4342
|
+
form_params = []
|
|
4343
|
+
local_var_files = {}
|
|
4344
|
+
|
|
4345
|
+
body_params = None
|
|
4346
|
+
if 'body' in params:
|
|
4347
|
+
if 'NoteInput'.startswith('union'):
|
|
4348
|
+
body_type = type(params['body'])
|
|
4349
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
4350
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
4351
|
+
else:
|
|
4352
|
+
body_params = params['body']
|
|
4353
|
+
else:
|
|
4354
|
+
body_params = flywheel.models.NoteInput.positional_to_model(params['body'])
|
|
4355
|
+
# HTTP header `Accept`
|
|
4356
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
4357
|
+
['application/json']) # noqa: E501
|
|
4358
|
+
|
|
4359
|
+
# HTTP header `Content-Type`
|
|
4360
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
4361
|
+
['application/json']) # noqa: E501
|
|
4362
|
+
|
|
4363
|
+
# Authentication setting
|
|
4364
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
4365
|
+
|
|
4366
|
+
return self.api_client.call_api(
|
|
4367
|
+
'/containers/{cid}/notes/{note_id}', 'PUT',
|
|
4368
|
+
path_params,
|
|
4369
|
+
query_params,
|
|
4370
|
+
header_params,
|
|
4371
|
+
body=body_params,
|
|
4372
|
+
post_params=form_params,
|
|
4373
|
+
files=local_var_files,
|
|
4374
|
+
response_type='int', # noqa: E501
|
|
4375
|
+
auth_settings=auth_settings,
|
|
4376
|
+
async_=params.get('async_'),
|
|
4377
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
4378
|
+
_preload_content=params.get('_preload_content', True),
|
|
4379
|
+
_request_timeout=params.get('_request_timeout'),
|
|
4380
|
+
_request_out=params.get('_request_out'),
|
|
4381
|
+
collection_formats=collection_formats)
|
|
4382
|
+
|
|
4383
|
+
def rename_container_tag(self, cid, value, body, **kwargs): # noqa: E501
|
|
4384
|
+
"""Rename a tag.
|
|
4385
|
+
|
|
4386
|
+
Rename a tag
|
|
4387
|
+
This method makes a synchronous HTTP request by default.
|
|
4388
|
+
|
|
4389
|
+
:param str cid: (required)
|
|
4390
|
+
:param str value: The tag to interact with (required)
|
|
4391
|
+
:param Tag body: (required)
|
|
4392
|
+
:param bool async_: Perform the request asynchronously
|
|
4393
|
+
:return: str
|
|
4394
|
+
"""
|
|
4395
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4396
|
+
kwargs['_return_http_data_only'] = True
|
|
4397
|
+
|
|
4398
|
+
if kwargs.get('async_'):
|
|
4399
|
+
return self.rename_container_tag_with_http_info(cid, value, body, **kwargs) # noqa: E501
|
|
4400
|
+
else:
|
|
4401
|
+
(data) = self.rename_container_tag_with_http_info(cid, value, body, **kwargs) # noqa: E501
|
|
4402
|
+
if (
|
|
4403
|
+
data
|
|
4404
|
+
and hasattr(data, 'return_value')
|
|
4405
|
+
and not ignore_simplified_return_value
|
|
4406
|
+
):
|
|
4407
|
+
return data.return_value()
|
|
4408
|
+
return data
|
|
4409
|
+
|
|
4410
|
+
|
|
4411
|
+
def rename_container_tag_with_http_info(self, cid, value, body, **kwargs): # noqa: E501
|
|
4412
|
+
"""Rename a tag.
|
|
4413
|
+
|
|
4414
|
+
Rename a tag
|
|
4415
|
+
This method makes a synchronous HTTP request by default.
|
|
4416
|
+
|
|
4417
|
+
:param str cid: (required)
|
|
4418
|
+
:param str value: The tag to interact with (required)
|
|
4419
|
+
:param Tag body: (required)
|
|
4420
|
+
:param bool async_: Perform the request asynchronously
|
|
4421
|
+
:return: str
|
|
4422
|
+
"""
|
|
4423
|
+
|
|
4424
|
+
all_params = ['cid','value','body',] # noqa: E501
|
|
4425
|
+
all_params.append('async_')
|
|
4426
|
+
all_params.append('_return_http_data_only')
|
|
4427
|
+
all_params.append('_preload_content')
|
|
4428
|
+
all_params.append('_request_timeout')
|
|
4429
|
+
all_params.append('_request_out')
|
|
4430
|
+
|
|
4431
|
+
params = locals()
|
|
4432
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
4433
|
+
if key not in all_params:
|
|
4434
|
+
raise TypeError(
|
|
4435
|
+
"Got an unexpected keyword argument '%s'"
|
|
4436
|
+
" to method rename_container_tag" % key
|
|
4437
|
+
)
|
|
4438
|
+
params[key] = val
|
|
4439
|
+
del params['kwargs']
|
|
4440
|
+
# verify the required parameter 'cid' is set
|
|
4441
|
+
if ('cid' not in params or
|
|
4442
|
+
params['cid'] is None):
|
|
4443
|
+
raise ValueError("Missing the required parameter `cid` when calling `rename_container_tag`") # noqa: E501
|
|
4444
|
+
# verify the required parameter 'value' is set
|
|
4445
|
+
if ('value' not in params or
|
|
4446
|
+
params['value'] is None):
|
|
4447
|
+
raise ValueError("Missing the required parameter `value` when calling `rename_container_tag`") # noqa: E501
|
|
4448
|
+
# verify the required parameter 'body' is set
|
|
4449
|
+
if ('body' not in params or
|
|
4450
|
+
params['body'] is None):
|
|
4451
|
+
raise ValueError("Missing the required parameter `body` when calling `rename_container_tag`") # noqa: E501
|
|
4452
|
+
check_filename_params(params)
|
|
4453
|
+
|
|
4454
|
+
collection_formats = {}
|
|
4455
|
+
|
|
4456
|
+
path_params = {}
|
|
4457
|
+
if 'cid' in params:
|
|
4458
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
4459
|
+
if 'value' in params:
|
|
4460
|
+
path_params['value'] = params['value'] # noqa: E501
|
|
4461
|
+
|
|
4462
|
+
query_params = []
|
|
4463
|
+
|
|
4464
|
+
header_params = {}
|
|
4465
|
+
|
|
4466
|
+
form_params = []
|
|
4467
|
+
local_var_files = {}
|
|
4468
|
+
|
|
4469
|
+
body_params = None
|
|
4470
|
+
if 'body' in params:
|
|
4471
|
+
if 'Tag'.startswith('union'):
|
|
4472
|
+
body_type = type(params['body'])
|
|
4473
|
+
if getattr(body_type, 'positional_to_model', None):
|
|
4474
|
+
body_params = body_type.positional_to_model(params['body'])
|
|
4475
|
+
else:
|
|
4476
|
+
body_params = params['body']
|
|
4477
|
+
else:
|
|
4478
|
+
body_params = flywheel.models.Tag.positional_to_model(params['body'])
|
|
4479
|
+
# HTTP header `Accept`
|
|
4480
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
4481
|
+
['application/json']) # noqa: E501
|
|
4482
|
+
|
|
4483
|
+
# HTTP header `Content-Type`
|
|
4484
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
4485
|
+
['application/json']) # noqa: E501
|
|
4486
|
+
|
|
4487
|
+
# Authentication setting
|
|
4488
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
4489
|
+
|
|
4490
|
+
return self.api_client.call_api(
|
|
4491
|
+
'/containers/{cid}/tags/{value}', 'PUT',
|
|
4492
|
+
path_params,
|
|
4493
|
+
query_params,
|
|
4494
|
+
header_params,
|
|
4495
|
+
body=body_params,
|
|
4496
|
+
post_params=form_params,
|
|
4497
|
+
files=local_var_files,
|
|
4498
|
+
response_type='str', # noqa: E501
|
|
4499
|
+
auth_settings=auth_settings,
|
|
4500
|
+
async_=params.get('async_'),
|
|
4501
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
4502
|
+
_preload_content=params.get('_preload_content', True),
|
|
4503
|
+
_request_timeout=params.get('_request_timeout'),
|
|
4504
|
+
_request_out=params.get('_request_out'),
|
|
4505
|
+
collection_formats=collection_formats)
|
|
4506
|
+
|
|
4507
|
+
def upload_file_to_container(self, container_id, file, **kwargs): # noqa: E501
|
|
4508
|
+
"""Upload a file to a(n) container.
|
|
4509
|
+
|
|
4510
|
+
Upload a file to a(n) container.
|
|
4511
|
+
This method makes a synchronous HTTP request by default.
|
|
4512
|
+
|
|
4513
|
+
:param str container_id: (required)
|
|
4514
|
+
:param str file: The file to upload (required)
|
|
4515
|
+
:param bool preserve_metadata:
|
|
4516
|
+
:param str ticket:
|
|
4517
|
+
:param str id:
|
|
4518
|
+
:param ContainerType level:
|
|
4519
|
+
:param str job:
|
|
4520
|
+
:param object metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
4521
|
+
:param list[str] x_accept_feature: redirect header
|
|
4522
|
+
:param str content_type:
|
|
4523
|
+
:param bool async_: Perform the request asynchronously
|
|
4524
|
+
:return: union[list[FileOutput],UploadTicketOutput]
|
|
4525
|
+
"""
|
|
4526
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4527
|
+
kwargs['_return_http_data_only'] = True
|
|
4528
|
+
|
|
4529
|
+
if kwargs.get('async_'):
|
|
4530
|
+
return self.upload_file_to_container_with_http_info(container_id, file, **kwargs) # noqa: E501
|
|
4531
|
+
else:
|
|
4532
|
+
(data) = self.upload_file_to_container_with_http_info(container_id, file, **kwargs) # noqa: E501
|
|
4533
|
+
if (
|
|
4534
|
+
data
|
|
4535
|
+
and hasattr(data, 'return_value')
|
|
4536
|
+
and not ignore_simplified_return_value
|
|
4537
|
+
):
|
|
4538
|
+
return data.return_value()
|
|
4539
|
+
return data
|
|
4540
|
+
|
|
4541
|
+
|
|
4542
|
+
def upload_file_to_container_with_http_info(self, container_id, file, **kwargs): # noqa: E501
|
|
4543
|
+
"""Upload a file to a(n) container.
|
|
4544
|
+
|
|
4545
|
+
Upload a file to a(n) container.
|
|
4546
|
+
This method makes a synchronous HTTP request by default.
|
|
4547
|
+
|
|
4548
|
+
:param str container_id: (required)
|
|
4549
|
+
:param str file: The file to upload (required)
|
|
4550
|
+
:param bool preserve_metadata:
|
|
4551
|
+
:param str ticket:
|
|
4552
|
+
:param str id:
|
|
4553
|
+
:param ContainerType level:
|
|
4554
|
+
:param str job:
|
|
4555
|
+
:param object metadata: Dictionary of file metadata (type, modality, info, etc.)
|
|
4556
|
+
:param list[str] x_accept_feature: redirect header
|
|
4557
|
+
:param str content_type:
|
|
4558
|
+
:param bool async_: Perform the request asynchronously
|
|
4559
|
+
:return: union[list[FileOutput],UploadTicketOutput]
|
|
4560
|
+
"""
|
|
4561
|
+
|
|
4562
|
+
all_params = ['container_id','file','preserve_metadata','ticket','id','level','job','metadata','x_accept_feature','content_type',] # noqa: E501
|
|
4563
|
+
all_params.append('async_')
|
|
4564
|
+
all_params.append('_return_http_data_only')
|
|
4565
|
+
all_params.append('_preload_content')
|
|
4566
|
+
all_params.append('_request_timeout')
|
|
4567
|
+
all_params.append('_request_out')
|
|
4568
|
+
|
|
4569
|
+
params = locals()
|
|
4570
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
4571
|
+
if key not in all_params:
|
|
4572
|
+
raise TypeError(
|
|
4573
|
+
"Got an unexpected keyword argument '%s'"
|
|
4574
|
+
" to method upload_file_to_container" % key
|
|
4575
|
+
)
|
|
4576
|
+
params[key] = val
|
|
4577
|
+
del params['kwargs']
|
|
4578
|
+
# verify the required parameter 'container_id' is set
|
|
4579
|
+
if ('container_id' not in params or
|
|
4580
|
+
params['container_id'] is None):
|
|
4581
|
+
raise ValueError("Missing the required parameter `container_id` when calling `upload_file_to_container`") # noqa: E501
|
|
4582
|
+
# verify the required parameter 'file' is set
|
|
4583
|
+
if ('file' not in params or
|
|
4584
|
+
params['file'] is None):
|
|
4585
|
+
raise ValueError("Missing the required parameter `file` when calling `upload_file_to_container`") # noqa: E501
|
|
4586
|
+
check_filename_params(params)
|
|
4587
|
+
|
|
4588
|
+
collection_formats = {}
|
|
4589
|
+
|
|
4590
|
+
path_params = {}
|
|
4591
|
+
if 'container_id' in params:
|
|
4592
|
+
path_params['container_id'] = params['container_id'] # noqa: E501
|
|
4593
|
+
|
|
4594
|
+
query_params = []
|
|
4595
|
+
if 'preserve_metadata' in params:
|
|
4596
|
+
query_params.append(('preserve_metadata', params['preserve_metadata'])) # noqa: E501
|
|
4597
|
+
if 'ticket' in params:
|
|
4598
|
+
query_params.append(('ticket', params['ticket'])) # noqa: E501
|
|
4599
|
+
if 'id' in params:
|
|
4600
|
+
query_params.append(('id', params['id'])) # noqa: E501
|
|
4601
|
+
if 'level' in params:
|
|
4602
|
+
query_params.append(('level', params['level'])) # noqa: E501
|
|
4603
|
+
if 'job' in params:
|
|
4604
|
+
query_params.append(('job', params['job'])) # noqa: E501
|
|
4605
|
+
|
|
4606
|
+
header_params = {}
|
|
4607
|
+
if 'x_accept_feature' in params:
|
|
4608
|
+
header_params['x-accept-feature'] = params['x_accept_feature'] # noqa: E501
|
|
4609
|
+
collection_formats['x-accept-feature'] = '' # noqa: E501
|
|
4610
|
+
if 'content_type' in params:
|
|
4611
|
+
header_params['content-type'] = params['content_type'] # noqa: E501
|
|
4612
|
+
|
|
4613
|
+
form_params = []
|
|
4614
|
+
local_var_files = {}
|
|
4615
|
+
if 'file' in params:
|
|
4616
|
+
local_var_files['file'] = params['file'] # noqa: E501
|
|
4617
|
+
if 'metadata' in params:
|
|
4618
|
+
form_params.append(('metadata', params['metadata'])) # noqa: E501
|
|
4619
|
+
|
|
4620
|
+
body_params = None
|
|
4621
|
+
# HTTP header `Accept`
|
|
4622
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
4623
|
+
['application/json']) # noqa: E501
|
|
4624
|
+
|
|
4625
|
+
# HTTP header `Content-Type`
|
|
4626
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
4627
|
+
['multipart/form-data']) # noqa: E501
|
|
4628
|
+
|
|
4629
|
+
# Authentication setting
|
|
4630
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
4631
|
+
|
|
4632
|
+
return self.api_client.call_api(
|
|
4633
|
+
'/containers/{container_id}/files', 'POST',
|
|
4634
|
+
path_params,
|
|
4635
|
+
query_params,
|
|
4636
|
+
header_params,
|
|
4637
|
+
body=body_params,
|
|
4638
|
+
post_params=form_params,
|
|
4639
|
+
files=local_var_files,
|
|
4640
|
+
response_type='union[list[FileOutput],UploadTicketOutput]', # noqa: E501
|
|
4641
|
+
auth_settings=auth_settings,
|
|
4642
|
+
async_=params.get('async_'),
|
|
4643
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
4644
|
+
_preload_content=params.get('_preload_content', True),
|
|
4645
|
+
_request_timeout=params.get('_request_timeout'),
|
|
4646
|
+
_request_out=params.get('_request_out'),
|
|
4647
|
+
collection_formats=collection_formats)
|
|
4648
|
+
|
|
4649
|
+
def upload_output_to_container_analysis(self, cid, analysis_id, file, **kwargs): # noqa: E501
|
|
4650
|
+
"""Upload an output file to an analysis.
|
|
4651
|
+
|
|
4652
|
+
Upload an output file to an analysis
|
|
4653
|
+
This method makes a synchronous HTTP request by default.
|
|
4654
|
+
|
|
4655
|
+
:param str cid: (required)
|
|
4656
|
+
:param str analysis_id: (required)
|
|
4657
|
+
:param str file: The file to upload (required)
|
|
4658
|
+
:param str ticket:
|
|
4659
|
+
:param str id:
|
|
4660
|
+
:param ContainerType level:
|
|
4661
|
+
:param str job:
|
|
4662
|
+
:param str content_type:
|
|
4663
|
+
:param bool async_: Perform the request asynchronously
|
|
4664
|
+
:return: list[FileOutput]
|
|
4665
|
+
"""
|
|
4666
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
4667
|
+
kwargs['_return_http_data_only'] = True
|
|
4668
|
+
|
|
4669
|
+
if kwargs.get('async_'):
|
|
4670
|
+
return self.upload_output_to_container_analysis_with_http_info(cid, analysis_id, file, **kwargs) # noqa: E501
|
|
4671
|
+
else:
|
|
4672
|
+
(data) = self.upload_output_to_container_analysis_with_http_info(cid, analysis_id, file, **kwargs) # noqa: E501
|
|
4673
|
+
if (
|
|
4674
|
+
data
|
|
4675
|
+
and hasattr(data, 'return_value')
|
|
4676
|
+
and not ignore_simplified_return_value
|
|
4677
|
+
):
|
|
4678
|
+
return data.return_value()
|
|
4679
|
+
return data
|
|
4680
|
+
|
|
4681
|
+
|
|
4682
|
+
def upload_output_to_container_analysis_with_http_info(self, cid, analysis_id, file, **kwargs): # noqa: E501
|
|
4683
|
+
"""Upload an output file to an analysis.
|
|
4684
|
+
|
|
4685
|
+
Upload an output file to an analysis
|
|
4686
|
+
This method makes a synchronous HTTP request by default.
|
|
4687
|
+
|
|
4688
|
+
:param str cid: (required)
|
|
4689
|
+
:param str analysis_id: (required)
|
|
4690
|
+
:param str file: The file to upload (required)
|
|
4691
|
+
:param str ticket:
|
|
4692
|
+
:param str id:
|
|
4693
|
+
:param ContainerType level:
|
|
4694
|
+
:param str job:
|
|
4695
|
+
:param str content_type:
|
|
4696
|
+
:param bool async_: Perform the request asynchronously
|
|
4697
|
+
:return: list[FileOutput]
|
|
4698
|
+
"""
|
|
4699
|
+
|
|
4700
|
+
all_params = ['cid','analysis_id','file','ticket','id','level','job','content_type',] # noqa: E501
|
|
4701
|
+
all_params.append('async_')
|
|
4702
|
+
all_params.append('_return_http_data_only')
|
|
4703
|
+
all_params.append('_preload_content')
|
|
4704
|
+
all_params.append('_request_timeout')
|
|
4705
|
+
all_params.append('_request_out')
|
|
4706
|
+
|
|
4707
|
+
params = locals()
|
|
4708
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
4709
|
+
if key not in all_params:
|
|
4710
|
+
raise TypeError(
|
|
4711
|
+
"Got an unexpected keyword argument '%s'"
|
|
4712
|
+
" to method upload_output_to_container_analysis" % key
|
|
4713
|
+
)
|
|
4714
|
+
params[key] = val
|
|
4715
|
+
del params['kwargs']
|
|
4716
|
+
# verify the required parameter 'cid' is set
|
|
4717
|
+
if ('cid' not in params or
|
|
4718
|
+
params['cid'] is None):
|
|
4719
|
+
raise ValueError("Missing the required parameter `cid` when calling `upload_output_to_container_analysis`") # noqa: E501
|
|
4720
|
+
# verify the required parameter 'analysis_id' is set
|
|
4721
|
+
if ('analysis_id' not in params or
|
|
4722
|
+
params['analysis_id'] is None):
|
|
4723
|
+
raise ValueError("Missing the required parameter `analysis_id` when calling `upload_output_to_container_analysis`") # noqa: E501
|
|
4724
|
+
# verify the required parameter 'file' is set
|
|
4725
|
+
if ('file' not in params or
|
|
4726
|
+
params['file'] is None):
|
|
4727
|
+
raise ValueError("Missing the required parameter `file` when calling `upload_output_to_container_analysis`") # noqa: E501
|
|
4728
|
+
check_filename_params(params)
|
|
4729
|
+
|
|
4730
|
+
collection_formats = {}
|
|
4731
|
+
|
|
4732
|
+
path_params = {}
|
|
4733
|
+
if 'cid' in params:
|
|
4734
|
+
path_params['cid'] = params['cid'] # noqa: E501
|
|
4735
|
+
if 'analysis_id' in params:
|
|
4736
|
+
path_params['analysis_id'] = params['analysis_id'] # noqa: E501
|
|
4737
|
+
|
|
4738
|
+
query_params = []
|
|
4739
|
+
if 'ticket' in params:
|
|
4740
|
+
query_params.append(('ticket', params['ticket'])) # noqa: E501
|
|
4741
|
+
if 'id' in params:
|
|
4742
|
+
query_params.append(('id', params['id'])) # noqa: E501
|
|
4743
|
+
if 'level' in params:
|
|
4744
|
+
query_params.append(('level', params['level'])) # noqa: E501
|
|
4745
|
+
if 'job' in params:
|
|
4746
|
+
query_params.append(('job', params['job'])) # noqa: E501
|
|
4747
|
+
|
|
4748
|
+
header_params = {}
|
|
4749
|
+
if 'content_type' in params:
|
|
4750
|
+
header_params['content-type'] = params['content_type'] # noqa: E501
|
|
4751
|
+
|
|
4752
|
+
form_params = []
|
|
4753
|
+
local_var_files = {}
|
|
4754
|
+
if 'file' in params:
|
|
4755
|
+
local_var_files['file'] = params['file'] # noqa: E501
|
|
4756
|
+
|
|
4757
|
+
body_params = None
|
|
4758
|
+
# HTTP header `Accept`
|
|
4759
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
4760
|
+
['application/json']) # noqa: E501
|
|
4761
|
+
|
|
4762
|
+
# HTTP header `Content-Type`
|
|
4763
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
4764
|
+
['multipart/form-data']) # noqa: E501
|
|
4765
|
+
|
|
4766
|
+
# Authentication setting
|
|
4767
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
4768
|
+
|
|
4769
|
+
return self.api_client.call_api(
|
|
4770
|
+
'/containers/{cid}/analyses/{analysis_id}/files', 'POST',
|
|
4771
|
+
path_params,
|
|
4772
|
+
query_params,
|
|
4773
|
+
header_params,
|
|
4774
|
+
body=body_params,
|
|
4775
|
+
post_params=form_params,
|
|
4776
|
+
files=local_var_files,
|
|
4777
|
+
response_type='list[FileOutput]', # noqa: E501
|
|
4778
|
+
auth_settings=auth_settings,
|
|
4779
|
+
async_=params.get('async_'),
|
|
4780
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
4781
|
+
_preload_content=params.get('_preload_content', True),
|
|
4782
|
+
_request_timeout=params.get('_request_timeout'),
|
|
4783
|
+
_request_out=params.get('_request_out'),
|
|
4784
|
+
collection_formats=collection_formats)
|