NiPyApi: A Python Client SDK for Apache NiFi

Contents:

• NiPyApi
  • Features
  • Quick Start
  • Background and Documentation
  • NiFi Version Support
  • Python Support
• Installation
  • Stable release
  • From sources
• NiPyApi Package Reference
  • Demos
    • FDLC
    • Console
    • Secured Connection
    • bbende How Do I Deploy My Flow
  • Client SDK modules
    • Canvas
      • create_connection()
      • create_controller()
      • create_funnel()
      • create_port()
      • create_process_group()
      • create_processor()
      • create_remote_process_group()
      • delete_connection()
      • delete_controller()
      • delete_funnel()
      • delete_port()
      • delete_process_group()
      • delete_processor()
      • delete_remote_process_group()
      • get_bulletin_board()
      • get_bulletins()
      • get_component_connections()
      • get_controller()
      • get_flow()
      • get_funnel()
      • get_pg_parents_ids()
      • get_process_group()
      • get_process_group_status()
      • get_processor()
      • get_processor_type()
      • get_remote_process_group()
      • get_root_pg_id()
      • get_variable_registry()
      • list_all_by_kind()
      • list_all_connections()
      • list_all_controller_types()
      • list_all_controllers()
      • list_all_funnels()
      • list_all_input_ports()
      • list_all_output_ports()
      • list_all_process_groups()
      • list_all_processor_types()
      • list_all_processors()
      • list_all_remote_process_groups()
      • list_invalid_processors()
      • list_sensitive_processors()
      • purge_connection()
      • purge_process_group()
      • recurse_flow()
      • schedule_components()
      • schedule_controller()
      • schedule_process_group()
      • schedule_processor()
      • set_remote_process_group_transmission()
      • update_controller()
      • update_process_group()
      • update_processor()
      • update_variable_registry()
    • Config
    • Parameters
      • assign_context_to_process_group()
      • create_parameter_context()
      • delete_parameter_context()
      • delete_parameter_from_context()
      • get_parameter_context()
      • list_all_parameter_contexts()
      • prepare_parameter()
      • remove_context_from_process_group()
      • update_parameter_context()
      • upsert_parameter_to_context()
    • Security
      • add_user_group_to_access_policy()
      • add_user_to_access_policy()
      • bootstrap_security_policies()
      • create_access_policy()
      • create_service_user()
      • create_service_user_group()
      • get_access_policy_for_resource()
      • get_service_access_status()
      • get_service_user()
      • get_service_user_group()
      • list_service_user_groups()
      • list_service_users()
      • remove_service_user()
      • remove_service_user_group()
      • service_login()
      • service_logout()
      • set_service_auth_token()
      • set_service_ssl_context()
      • update_access_policy()
    • System
      • get_cluster()
      • get_nifi_version_info()
      • get_node()
      • get_system_diagnostics()
    • Templates
      • create_pg_snippet()
      • create_template()
      • delete_template()
      • deploy_template()
      • export_template()
      • get_template()
      • get_template_by_name()
      • list_all_templates()
      • load_template_from_xml_file_path()
      • load_template_from_xml_file_stream()
      • load_template_from_xml_string()
      • upload_template()
    • Utils
      • DockerContainer
      • bypass_slash_encoding()
      • check_version()
      • dump()
      • enforce_min_ver()
      • exception_handler()
      • filter_obj()
      • fs_read()
      • fs_write()
      • infer_object_label_from_class()
      • is_endpoint_up()
      • load()
      • set_endpoint()
      • start_docker_containers()
      • validate_parameters_versioning_support()
      • wait_to_complete()
    • Versioning
      • create_flow()
      • create_flow_version()
      • create_registry_bucket()
      • create_registry_client()
      • delete_registry_bucket()
      • delete_registry_client()
      • deploy_flow_version()
      • export_flow_version()
      • get_flow_in_bucket()
      • get_flow_version()
      • get_latest_flow_ver()
      • get_registry_bucket()
      • get_registry_client()
      • get_version_info()
      • import_flow_version()
      • list_flow_versions()
      • list_flows_in_bucket()
      • list_registry_buckets()
      • list_registry_clients()
      • save_flow_ver()
      • update_flow_ver()
  • Swagger Client SDKs
    • NiFi Swagger Client
      • Subpackages
      • Submodules
      • nipyapi.nifi.api_client module
      • nipyapi.nifi.configuration module
      • nipyapi.nifi.rest module
    • NiFi-Registry Swagger Client
      • Subpackages
      • Submodules
      • nipyapi.registry.api_client module
      • nipyapi.registry.configuration module
      • nipyapi.registry.rest module
• ToDo
• Contributing
  • Types of Contributions
    • Report Bugs
    • Fix Bugs
    • Implement Features
    • Write Documentation
    • Submit Feedback
  • Get Started!
  • Pull Request Guidelines
• Development Notes
  • Decision Points
  • Testing Notes
  • Docker Test Environment
  • Remote testing on AWS:AL3 with Visual Studio Code on OSX
  • Setup Code Signing
  • Remote Testing on Centos7
  • Testing on OSX
  • Generate Swagger Client
    • NiFi Swagger Client
    • NiFi Registry Swagger Client
  • Release Process
• Credits
  • Development Lead
  • Contributors
  • Shout Outs
• History
  • 0.20.0 (2024-04-14)
  • 0.19.1 (2022-08-08)
  • 0.19.0 (2022-05-13)
  • 0.18.0 (2021-11-29)
  • 0.17.1 (2021-10-21)
  • 0.17.0 (2021-10-13)
  • 0.16.3 (2021-10-11)
  • 0.16.2 (2021-02-10)
  • 0.16.3 (2021-10-11)
  • 0.16.2 (2021-02-10)
  • 0.15.0 (2020-11-06)
  • 0.14.0 (2019-11-06)
  • 0.13.3 (2019-10-09)
  • 0.13.0 (2019-04-22)
  • 0.12.0 (2018-12-20)
  • 0.11.0 (2018-10-12)
  • 0.10.3 (2018-08-28)
  • 0.10.2 (2018-08-27)
  • 0.10.1 (2018-08-21)
  • 0.10.0 (2018-08-03)
  • 0.9.1 (2018-05-18)
  • 0.9.0 (2018-05-16)
  • 0.8.0 (2018-03-06)
  • 0.7.0 (2018-01-30)
  • 0.6.1 (2018-01-04)
  • 0.6.0 (2017-12-31)
  • 0.5.1 (2017-12-07)
  • 0.5.0 (2017-12-06)
  • 0.4.0 (2017-10-29)
  • 0.3.2 (2017-09-04)
  • 0.3.1 (2017-09-04)
  • 0.3.0 (2017-09-04)
  • 0.2.1 (2017-08-26)
  • 0.2.0 (2017-08-25)
  • 0.1.2 (2017-08-24)
  • 0.1.1 (2017-08-24)
  • 0.1.0 (2017-08-24)

Indices and tables

• Index

• Search Page