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
      • DockerContainer.get_container()
      • DockerContainer.get_test_url_status()
      • DockerContainer.set_container()
    • 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
      • nipyapi.nifi.apis package
      • nipyapi.nifi.models package
    • Submodules
    • nipyapi.nifi.api_client module
      • ApiClient
    • nipyapi.nifi.configuration module
      • Configuration()
      • singleton()
    • nipyapi.nifi.rest module
      • ApiException
      • RESTClientObject
      • RESTResponse
  • NiFi-Registry Swagger Client
    • Subpackages
      • nipyapi.registry.apis package
      • nipyapi.registry.models package
    • Submodules
    • nipyapi.registry.api_client module
      • ApiClient
    • nipyapi.registry.configuration module
      • Configuration()
      • singleton()
    • nipyapi.registry.rest module
      • ApiException
      • RESTClientObject
      • RESTResponse