NiFi Swagger Client¶
Subpackages¶
- nipyapi.nifi.apis package
- Submodules
- nipyapi.nifi.apis.access_api module
- nipyapi.nifi.apis.connections_api module
- nipyapi.nifi.apis.controller_api module
- nipyapi.nifi.apis.controller_services_api module
- nipyapi.nifi.apis.counters_api module
- nipyapi.nifi.apis.data_transfer_api module
- nipyapi.nifi.apis.flow_api module
- nipyapi.nifi.apis.flowfile_queues_api module
- nipyapi.nifi.apis.funnel_api module
- nipyapi.nifi.apis.input_ports_api module
- nipyapi.nifi.apis.labels_api module
- nipyapi.nifi.apis.output_ports_api module
- nipyapi.nifi.apis.parameter_contexts_api module
- nipyapi.nifi.apis.policies_api module
- nipyapi.nifi.apis.process_groups_api module
- nipyapi.nifi.apis.processors_api module
- nipyapi.nifi.apis.provenance_api module
- nipyapi.nifi.apis.provenance_events_api module
- nipyapi.nifi.apis.remote_process_groups_api module
- nipyapi.nifi.apis.reporting_tasks_api module
- nipyapi.nifi.apis.resources_api module
- nipyapi.nifi.apis.site_to_site_api module
- nipyapi.nifi.apis.snippets_api module
- nipyapi.nifi.apis.system_diagnostics_api module
- nipyapi.nifi.apis.templates_api module
- nipyapi.nifi.apis.tenants_api module
- nipyapi.nifi.apis.versions_api module
- nipyapi.nifi.models package
- Submodules
- nipyapi.nifi.models.about_dto module
- nipyapi.nifi.models.about_entity module
- nipyapi.nifi.models.access_configuration_dto module
- nipyapi.nifi.models.access_configuration_entity module
- nipyapi.nifi.models.access_policy_dto module
- nipyapi.nifi.models.access_policy_entity module
- nipyapi.nifi.models.access_policy_summary_dto module
- nipyapi.nifi.models.access_policy_summary_entity module
- nipyapi.nifi.models.access_status_dto module
- nipyapi.nifi.models.access_status_entity module
- nipyapi.nifi.models.action_details_dto module
- nipyapi.nifi.models.action_dto module
- nipyapi.nifi.models.action_entity module
- nipyapi.nifi.models.activate_controller_services_entity module
- nipyapi.nifi.models.affected_component_dto module
- nipyapi.nifi.models.affected_component_entity module
- nipyapi.nifi.models.allowable_value_dto module
- nipyapi.nifi.models.allowable_value_entity module
- nipyapi.nifi.models.attribute_dto module
- nipyapi.nifi.models.banner_dto module
- nipyapi.nifi.models.banner_entity module
- nipyapi.nifi.models.batch_settings_dto module
- nipyapi.nifi.models.batch_size module
- nipyapi.nifi.models.bucket module
- nipyapi.nifi.models.bucket_dto module
- nipyapi.nifi.models.bucket_entity module
- nipyapi.nifi.models.buckets_entity module
- nipyapi.nifi.models.bulletin_board_dto module
- nipyapi.nifi.models.bulletin_board_entity module
- nipyapi.nifi.models.bulletin_dto module
- nipyapi.nifi.models.bulletin_entity module
- nipyapi.nifi.models.bundle module
- nipyapi.nifi.models.bundle_dto module
- nipyapi.nifi.models.cluste_summary_entity module
- nipyapi.nifi.models.cluster_dto module
- nipyapi.nifi.models.cluster_entity module
- nipyapi.nifi.models.cluster_search_results_entity module
- nipyapi.nifi.models.cluster_summary_dto module
- nipyapi.nifi.models.component_details_dto module
- nipyapi.nifi.models.component_difference_dto module
- nipyapi.nifi.models.component_history_dto module
- nipyapi.nifi.models.component_history_entity module
- nipyapi.nifi.models.component_reference_dto module
- nipyapi.nifi.models.component_reference_entity module
- nipyapi.nifi.models.component_search_result_dto module
- nipyapi.nifi.models.component_state_dto module
- nipyapi.nifi.models.component_state_entity module
- nipyapi.nifi.models.connectable_component module
- nipyapi.nifi.models.connectable_dto module
- nipyapi.nifi.models.connection_dto module
- nipyapi.nifi.models.connection_entity module
- nipyapi.nifi.models.connection_status_dto module
- nipyapi.nifi.models.connection_status_entity module
- nipyapi.nifi.models.connection_status_snapshot_dto module
- nipyapi.nifi.models.connection_status_snapshot_entity module
- nipyapi.nifi.models.connections_entity module
- nipyapi.nifi.models.controller_bulletins_entity module
- nipyapi.nifi.models.controller_configuration_dto module
- nipyapi.nifi.models.controller_configuration_entity module
- nipyapi.nifi.models.controller_dto module
- nipyapi.nifi.models.controller_entity module
- nipyapi.nifi.models.controller_service_api module
- nipyapi.nifi.models.controller_service_api_dto module
- nipyapi.nifi.models.controller_service_dto module
- nipyapi.nifi.models.controller_service_entity module
- nipyapi.nifi.models.controller_service_referencing_component_dto module
- nipyapi.nifi.models.controller_service_referencing_component_entity module
- nipyapi.nifi.models.controller_service_referencing_components_entity module
- nipyapi.nifi.models.controller_service_types_entity module
- nipyapi.nifi.models.controller_services_entity module
- nipyapi.nifi.models.controller_status_dto module
- nipyapi.nifi.models.controller_status_entity module
- nipyapi.nifi.models.copy_snippet_request_entity module
- nipyapi.nifi.models.counter_dto module
- nipyapi.nifi.models.counter_entity module
- nipyapi.nifi.models.counters_dto module
- nipyapi.nifi.models.counters_entity module
- nipyapi.nifi.models.counters_snapshot_dto module
- nipyapi.nifi.models.create_active_request_entity module
- nipyapi.nifi.models.create_template_request_entity module
- nipyapi.nifi.models.current_user_entity module
- nipyapi.nifi.models.difference_dto module
- nipyapi.nifi.models.dimensions_dto module
- nipyapi.nifi.models.documented_type_dto module
- nipyapi.nifi.models.drop_request_dto module
- nipyapi.nifi.models.drop_request_entity module
- nipyapi.nifi.models.flow_breadcrumb_dto module
- nipyapi.nifi.models.flow_breadcrumb_entity module
- nipyapi.nifi.models.flow_comparison_entity module
- nipyapi.nifi.models.flow_configuration_dto module
- nipyapi.nifi.models.flow_configuration_entity module
- nipyapi.nifi.models.flow_dto module
- nipyapi.nifi.models.flow_entity module
- nipyapi.nifi.models.flow_file_dto module
- nipyapi.nifi.models.flow_file_entity module
- nipyapi.nifi.models.flow_file_summary_dto module
- nipyapi.nifi.models.flow_snippet_dto module
- nipyapi.nifi.models.funnel_dto module
- nipyapi.nifi.models.funnel_entity module
- nipyapi.nifi.models.funnels_entity module
- nipyapi.nifi.models.garbage_collection_dto module
- nipyapi.nifi.models.history_dto module
- nipyapi.nifi.models.history_entity module
- nipyapi.nifi.models.input_ports_entity module
- nipyapi.nifi.models.instantiate_template_request_entity module
- nipyapi.nifi.models.label_dto module
- nipyapi.nifi.models.label_entity module
- nipyapi.nifi.models.labels_entity module
- nipyapi.nifi.models.lineage_dto module
- nipyapi.nifi.models.lineage_entity module
- nipyapi.nifi.models.lineage_request_dto module
- nipyapi.nifi.models.lineage_results_dto module
- nipyapi.nifi.models.listing_request_dto module
- nipyapi.nifi.models.listing_request_entity module
- nipyapi.nifi.models.node_connection_status_snapshot_dto module
- nipyapi.nifi.models.node_counters_snapshot_dto module
- nipyapi.nifi.models.node_dto module
- nipyapi.nifi.models.node_entity module
- nipyapi.nifi.models.node_event_dto module
- nipyapi.nifi.models.node_port_status_snapshot_dto module
- nipyapi.nifi.models.node_process_group_status_snapshot_dto module
- nipyapi.nifi.models.node_processor_status_snapshot_dto module
- nipyapi.nifi.models.node_remote_process_group_status_snapshot_dto module
- nipyapi.nifi.models.node_search_result_dto module
- nipyapi.nifi.models.node_status_snapshots_dto module
- nipyapi.nifi.models.node_system_diagnostics_snapshot_dto module
- nipyapi.nifi.models.output_ports_entity module
- nipyapi.nifi.models.peer_dto module
- nipyapi.nifi.models.peers_entity module
- nipyapi.nifi.models.permissions module
- nipyapi.nifi.models.permissions_dto module
- nipyapi.nifi.models.port_dto module
- nipyapi.nifi.models.port_entity module
- nipyapi.nifi.models.port_status_dto module
- nipyapi.nifi.models.port_status_entity module
- nipyapi.nifi.models.port_status_snapshot_dto module
- nipyapi.nifi.models.port_status_snapshot_entity module
- nipyapi.nifi.models.position_dto module
- nipyapi.nifi.models.previous_value_dto module
- nipyapi.nifi.models.prioritizer_types_entity module
- nipyapi.nifi.models.process_group_dto module
- nipyapi.nifi.models.process_group_entity module
- nipyapi.nifi.models.process_group_flow_dto module
- nipyapi.nifi.models.process_group_flow_entity module
- nipyapi.nifi.models.process_group_status_dto module
- nipyapi.nifi.models.process_group_status_entity module
- nipyapi.nifi.models.process_group_status_snapshot_dto module
- nipyapi.nifi.models.process_group_status_snapshot_entity module
- nipyapi.nifi.models.process_groups_entity module
- nipyapi.nifi.models.processor_config_dto module
- nipyapi.nifi.models.processor_dto module
- nipyapi.nifi.models.processor_entity module
- nipyapi.nifi.models.processor_status_dto module
- nipyapi.nifi.models.processor_status_entity module
- nipyapi.nifi.models.processor_status_snapshot_dto module
- nipyapi.nifi.models.processor_status_snapshot_entity module
- nipyapi.nifi.models.processor_types_entity module
- nipyapi.nifi.models.processors_entity module
- nipyapi.nifi.models.property_descriptor_dto module
- nipyapi.nifi.models.property_descriptor_entity module
- nipyapi.nifi.models.property_history_dto module
- nipyapi.nifi.models.provenance_dto module
- nipyapi.nifi.models.provenance_entity module
- nipyapi.nifi.models.provenance_event_dto module
- nipyapi.nifi.models.provenance_event_entity module
- nipyapi.nifi.models.provenance_link_dto module
- nipyapi.nifi.models.provenance_node_dto module
- nipyapi.nifi.models.provenance_options_dto module
- nipyapi.nifi.models.provenance_options_entity module
- nipyapi.nifi.models.provenance_request_dto module
- nipyapi.nifi.models.provenance_results_dto module
- nipyapi.nifi.models.provenance_searchable_field_dto module
- nipyapi.nifi.models.queue_size_dto module
- nipyapi.nifi.models.registry_client_entity module
- nipyapi.nifi.models.registry_clients_entity module
- nipyapi.nifi.models.registry_dto module
- nipyapi.nifi.models.relationship_dto module
- nipyapi.nifi.models.remote_process_group_contents_dto module
- nipyapi.nifi.models.remote_process_group_dto module
- nipyapi.nifi.models.remote_process_group_entity module
- nipyapi.nifi.models.remote_process_group_port_dto module
- nipyapi.nifi.models.remote_process_group_port_entity module
- nipyapi.nifi.models.remote_process_group_status_dto module
- nipyapi.nifi.models.remote_process_group_status_entity module
- nipyapi.nifi.models.remote_process_group_status_snapshot_dto module
- nipyapi.nifi.models.remote_process_group_status_snapshot_entity module
- nipyapi.nifi.models.remote_process_groups_entity module
- nipyapi.nifi.models.reporting_task_dto module
- nipyapi.nifi.models.reporting_task_entity module
- nipyapi.nifi.models.reporting_task_types_entity module
- nipyapi.nifi.models.reporting_tasks_entity module
- nipyapi.nifi.models.resource_dto module
- nipyapi.nifi.models.resources_entity module
- nipyapi.nifi.models.revision_dto module
- nipyapi.nifi.models.schedule_components_entity module
- nipyapi.nifi.models.search_results_dto module
- nipyapi.nifi.models.search_results_entity module
- nipyapi.nifi.models.snippet_dto module
- nipyapi.nifi.models.snippet_entity module
- nipyapi.nifi.models.start_version_control_request_entity module
- nipyapi.nifi.models.state_entry_dto module
- nipyapi.nifi.models.state_map_dto module
- nipyapi.nifi.models.status_descriptor_dto module
- nipyapi.nifi.models.status_history_dto module
- nipyapi.nifi.models.status_history_entity module
- nipyapi.nifi.models.status_snapshot_dto module
- nipyapi.nifi.models.storage_usage_dto module
- nipyapi.nifi.models.streaming_output module
- nipyapi.nifi.models.submit_replay_request_entity module
- nipyapi.nifi.models.system_diagnostics_dto module
- nipyapi.nifi.models.system_diagnostics_entity module
- nipyapi.nifi.models.system_diagnostics_snapshot_dto module
- nipyapi.nifi.models.template_dto module
- nipyapi.nifi.models.template_entity module
- nipyapi.nifi.models.templates_entity module
- nipyapi.nifi.models.tenant_dto module
- nipyapi.nifi.models.tenant_entity module
- nipyapi.nifi.models.tenants_entity module
- nipyapi.nifi.models.transaction_result_entity module
- nipyapi.nifi.models.update_controller_service_reference_request_entity module
- nipyapi.nifi.models.user_dto module
- nipyapi.nifi.models.user_entity module
- nipyapi.nifi.models.user_group_dto module
- nipyapi.nifi.models.user_group_entity module
- nipyapi.nifi.models.user_groups_entity module
- nipyapi.nifi.models.users_entity module
- nipyapi.nifi.models.variable_dto module
- nipyapi.nifi.models.variable_entity module
- nipyapi.nifi.models.variable_registry_dto module
- nipyapi.nifi.models.variable_registry_entity module
- nipyapi.nifi.models.variable_registry_update_request_dto module
- nipyapi.nifi.models.variable_registry_update_request_entity module
- nipyapi.nifi.models.variable_registry_update_step_dto module
- nipyapi.nifi.models.version_control_component_mapping_entity module
- nipyapi.nifi.models.version_control_information_dto module
- nipyapi.nifi.models.version_control_information_entity module
- nipyapi.nifi.models.version_info_dto module
- nipyapi.nifi.models.versioned_connection module
- nipyapi.nifi.models.versioned_controller_service module
- nipyapi.nifi.models.versioned_flow module
- nipyapi.nifi.models.versioned_flow_coordinates module
- nipyapi.nifi.models.versioned_flow_dto module
- nipyapi.nifi.models.versioned_flow_entity module
- nipyapi.nifi.models.versioned_flow_snapshot module
- nipyapi.nifi.models.versioned_flow_snapshot_entity module
- nipyapi.nifi.models.versioned_flow_snapshot_metadata_entity module
- nipyapi.nifi.models.versioned_flow_snapshot_metadata_set_entity module
- nipyapi.nifi.models.versioned_flow_update_request_dto module
- nipyapi.nifi.models.versioned_flow_update_request_entity module
- nipyapi.nifi.models.versioned_flows_entity module
- nipyapi.nifi.models.versioned_funnel module
- nipyapi.nifi.models.versioned_label module
- nipyapi.nifi.models.versioned_port module
- nipyapi.nifi.models.versioned_process_group module
- nipyapi.nifi.models.versioned_processor module
- nipyapi.nifi.models.versioned_property_descriptor module
- nipyapi.nifi.models.versioned_remote_group_port module
- nipyapi.nifi.models.versioned_remote_process_group module
Submodules¶
nipyapi.nifi.api_client module¶
NiFi Rest API
The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.
OpenAPI spec version: 1.19.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
nipyapi.nifi.api_client.
ApiClient
(host=None, header_name=None, header_value=None, cookie=None)[source]¶ Bases:
object
Generic API client for Swagger client library builds.
Swagger generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the Swagger templates.
NOTE: This class is auto generated by the swagger code generator program. Ref: https://github.com/swagger-api/swagger-codegen Do not edit the class manually.
Parameters: - host – The base path for the server to call.
- header_name – a header to pass when making calls to the API.
- header_value – a header value to pass when making calls to the API.
Constructor of the class.
-
NATIVE_TYPES_MAPPING
= {'bool': <class 'bool'>, 'date': <class 'datetime.date'>, 'datetime': <class 'datetime.datetime'>, 'float': <class 'float'>, 'int': <class 'int'>, 'long': <class 'int'>, 'object': <class 'object'>, 'str': <class 'str'>}¶
-
PRIMITIVE_TYPES
= (<class 'float'>, <class 'bool'>, <class 'bytes'>, <class 'str'>, <class 'int'>)¶
-
call_api
(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_type=None, auth_settings=None, callback=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None)[source]¶ Makes the HTTP request (synchronous) and return the deserialized data. To make an async request, define a function for callback.
Parameters: - resource_path – Path to method endpoint.
- method – Method to call.
- path_params – Path parameters in the url.
- query_params – Query parameters in the url.
- header_params – Header parameters to be placed in the request header.
- body – Request body.
- dict (files) – Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.
- list (auth_settings) – Auth Settings names for the request.
- response – Response data type.
- dict – key -> filename, value -> filepath, for multipart/form-data.
- function (callback) – Callback function for asynchronous request. If provide this parameter, the request will be called asynchronously.
- _return_http_data_only – response data without head status code and headers
- collection_formats – dict of collection formats for path, query, header, and post parameters.
- _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
- _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns: If provide parameter callback, the request will be called asynchronously. The method will return the request thread. If parameter callback is None, then the method will return the response directly.
-
deserialize
(response, response_type)[source]¶ Deserializes response into an object.
Parameters: - response – RESTResponse object to be deserialized.
- response_type – class literal for deserialized object, or string of class name.
Returns: deserialized object.
-
deserialize_model
(data, klass)[source]¶ Deserializes list or dict to model.
Parameters: - data – dict, list.
- klass – class literal.
Returns: model object.
-
parameters_to_tuples
(params, collection_formats)[source]¶ Get parameters as list of tuples, formatting collections.
Parameters: - params – Parameters as dict or list of two-tuples
- collection_formats (dict) – Parameter collection formats
Returns: Parameters as list of tuples, collections formatted
-
prepare_post_parameters
(post_params=None, files=None)[source]¶ Builds form parameters.
Parameters: - post_params – Normal form parameters.
- files – File parameters.
Returns: Form parameters with files.
-
request
(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)[source]¶ Makes the HTTP request using RESTClient.
-
sanitize_for_serialization
(obj)[source]¶ Builds a JSON POST object.
If obj is None, return None. If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date
convert to string in iso8601 format.If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is swagger model, return the properties dict.
Parameters: obj – The data to serialize. Returns: The serialized form of data.
-
select_header_accept
(accepts)[source]¶ Returns Accept based on an array of accepts provided.
Parameters: accepts – List of headers. Returns: Accept (e.g. application/json).
-
select_header_content_type
(content_types)[source]¶ Returns Content-Type based on an array of content_types provided.
Parameters: content_types – List of content-types. Returns: Content-Type (e.g. application/json).
-
update_params_for_auth
(headers, querys, auth_settings)[source]¶ Updates header and query params based on authentication setting.
Parameters: - headers – Header parameters dict to be updated.
- querys – Query parameters tuple list to be updated.
- auth_settings – Authentication setting identifiers list.
-
user_agent
¶ Gets user agent.
nipyapi.nifi.configuration module¶
NiFi Rest API
The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.
OpenAPI spec version: 1.19.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git
nipyapi.nifi.rest module¶
NiFi Rest API
The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.
OpenAPI spec version: 1.19.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git
-
exception
nipyapi.nifi.rest.
ApiException
(status=None, reason=None, http_resp=None)[source]¶ Bases:
Exception
-
class
nipyapi.nifi.rest.
RESTClientObject
(pools_size=4, maxsize=4)[source]¶ Bases:
object
-
DELETE
(url, headers=None, query_params=None, body=None, _preload_content=True, _request_timeout=None)[source]¶
-
OPTIONS
(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)[source]¶
-
PATCH
(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)[source]¶
-
POST
(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)[source]¶
-
PUT
(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)[source]¶
-
request
(method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None)[source]¶ Parameters: - method – http request method
- url – http request url
- query_params – query parameters in the url
- headers – http request headers
- body – request json body, for application/json
- post_params – request post parameters, application/x-www-form-urlencoded and multipart/form-data
- _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
- _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
-