NiPyApi: A Python Client SDK for Apache NiFi

Contents:

NiPyApi

Nifi-Python-Api: A rich Apache NiFi Python Client SDK

Features

Three layers of Python support for working with Apache NiFi:

• High-level Demos and example scripts
• Mid-level Client SDK for typical complex tasks
• Low-level Client SDKs for the full API implementation of NiFi and selected sub-projects

Functionality Highlights:

• Detailed documentation of the full SDK at all levels
• CRUD wrappers for common task areas like Processor Groups, Processors, Templates, Registry Clients, Registry Buckets, Registry Flows, etc.
• Convenience functions for inventory tasks, such as recursively retrieving the entire canvas, or a flat list of all Process Groups
• Support for scheduling and purging flows, controller services, and connections
• Support for fetching and updating Variable Registries
• Support for import/export of Versioned Flows from NiFi-Registry
• Docker Compose configurations for testing and deployment
• A scripted deployment of an interactive environment, and a secured configuration, for testing and demonstration purposes

Please see the issue register for more information on current development.

Quick Start

There are several scripts to produce demo environments in nipyapi.demo.*

The mid-level functionality is in nipyapi.canvas / nipyapi.security / nipyapi.templates / nipyapi.versioning

You can access the entire API using the low-level SDKs in nipyapi.nifi / nipyapi.registry

The easiest way to install NiPyApi is with pip:

# in bash
pip install nipyapi

You can set the config for your endpoints in the central config file:

# in python
import nipyapi
nipyapi.config.nifi_config.host = 'http://localhost:8080/nifi-api'
nipyapi.config.registry_config.host = 'http://localhost:18080/nifi-registry-api'

Then import a module and execute tasks:

nipyapi.canvas.get_root_pg_id()
>'4d5dcf9a-015e-1000-097e-e505ed0f7fd2'

You can use the Docker demos to create a secured interactive console showing many features:

from nipyapi.demo.secured_console import *
from nipyapi.demo.console import *

You can also explore the scripts to get ideas for how NiPyAPi can be used to automate your environment.

Please check out the Contribution Guide if you are interested in contributing to the feature set.

Background and Documentation

For more information on Apache NiFi, please visit https://nifi.apache.org

For Documentation on this package please visit https://nipyapi.readthedocs.io.

NiFi Version Support

Currently we are testing against NiFi versions 1.1.2 - 1.15.0, and NiFi-Registry versions 0.1.0 - 1.15.0.

If you find a version compatibility problem please raise an issue

Python Requirements

Python 2.7 or 3.6-9 supported, though other versions may work. We will shortly stop supporting Python2 There are known issues on Python 3.10

Tested on AL2 and OSX 10.14.x - Windows automated testing not attempted

Outside of the standard Python modules, we make use of lxml, DeepDiff, ruamel.yaml and xmltodict in processing, and Docker for demo/tests.

Installation

Stable release

To install Nipyapi, run this command in your terminal:

$ pip install nipyapi

This is the preferred method to install Nipyapi, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for Nipyapi can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/Chaffelson/nipyapi

Or download the tarball:

$ curl  -OL https://github.com/Chaffelson/nipyapi/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

NiPyApi Package Reference

Demos

These modules leverage functionality within the rest of the Package to demonstrate various capabilities

FDLC

Importing this module provides further instructions for it’s use. It will guide you through the steps involved in flow promotion.

Note that it makes extensive use of Docker Containers.

Usage:

from nipyapi.demo.fdlc import *

Console

Importing this module will run a script which populates the NiFi canvas with a Process Group containing a processor, and creates a sequence of Versioned Flow Objects from it, along with a Template and various export versions.

This is intended to give the user a base set of objects to explore the API.

Usage:

from nipyapi.demo.console import *

Secured Connection

Importing this module will pull recent Docker containers from Dockerhub, deploy them in a secured configuration, and prepare the environment for access via TLS in NiFi-Registry’s case, and public LDAP username/password for NiFi.

This is intended to give the user an example of a secured environment. May be combined with the Console to produce a secured environment with demo objects.

Note that this demo makes extensive use of Docker Containers.

Usage:

from nipyapi.demo.secured_connection import *

bbende How Do I Deploy My Flow

An incomplete version of BBende’s excellent demo. It currently deploys some Docker NiFi and Registry instances.

Client SDK modules

These wrapper modules contain collections of convenience functions for daily operations of your NiFi and NiFi-Registry environment. They wrap and surface underlying data structures and calls to the full SDK swagger clients which are also included in the package.

Canvas

For interactions with the NiFi Canvas.

nipyapi.canvas.get_root_pg_id()

Convenience function to return the UUID of the Root Process Group

Returns (str): The UUID of the root PG

nipyapi.canvas.recurse_flow(pg_id='root')

Returns information about a Process Group and all its Child Flows. Recurses the child flows by appending each process group with a ‘nipyapi_extended’ parameter which contains the child process groups, etc. Note: This previously used actual recursion which broke on large NiFi

environments, we now use a task/list update approach

Parameters:pg_id (str) – The Process Group UUID Returns:enriched NiFi Flow object Return type:(ProcessGroupFlowEntity)

nipyapi.canvas.get_flow(pg_id='root')

Returns information about a Process Group and flow.

This surfaces the native implementation, for the recursed implementation see ‘recurse_flow’

Parameters:pg_id (str) – id of the Process Group to retrieve, defaults to the root process group if not set Returns:The Process Group object Return type:(ProcessGroupFlowEntity)

nipyapi.canvas.get_process_group_status(pg_id='root', detail='names')

Returns an entity containing the status of the Process Group. Optionally may be configured to return a simple dict of name:id pairings

Note that there is also a ‘process group status’ command available, but it returns a subset of this data anyway, and this call is more useful

Parameters:

• pg_id (str) – The UUID of the Process Group
• detail (str) – ‘names’ or ‘all’; whether to return a simple dict of name:id pairings, or the full details. Defaults to ‘names’

Returns:

The Process Group Entity including the status

Return type:

(ProcessGroupEntity)

nipyapi.canvas.get_process_group(identifier, identifier_type='name', greedy=True)

Filters the list of all process groups against a given identifier string occurring in a given identifier_type field.

Parameters:

• identifier (str) – the string to filter the list for
• identifier_type (str) – the field to filter on, set in config.py
• greedy (bool) – True for partial match, False for exact match

Returns:

None for no matches, Single Object for unique match, list(Objects) for multiple matches

nipyapi.canvas.list_all_process_groups(pg_id='root')

Returns a flattened list of all Process Groups on the canvas. Potentially slow if you have a large canvas.

Note that the ProcessGroupsApi().get_process_groups(pg_id) command only provides the first layer of pgs, whereas this trawls the entire canvas

Parameters:pg_id (str) – The UUID of the Process Group to start from, defaults to the Canvas root Returns:list[ProcessGroupEntity]

nipyapi.canvas.delete_process_group(process_group, force=False, refresh=True)

Deletes a given Process Group, with optional prejudice.

Parameters:

• process_group (ProcessGroupEntity) – The target Process Group
• force (bool) – Stop, purge and clean the target Process Group before deletion. Experimental.
• refresh (bool) – Whether to refresh the state first

Returns:

The updated object state

Return type:

(ProcessGroupEntity

nipyapi.canvas.schedule_process_group(process_group_id, scheduled)

Start or Stop a Process Group and all components.

Note that this doesn’t guarantee that all components have started, as some may be in Invalid states.

Parameters:

• process_group_id (str) – The UUID of the target Process Group
• scheduled (bool) – True to start, False to stop

Returns:

True of successfully scheduled, False if not

Return type:

(bool)

nipyapi.canvas.create_process_group(parent_pg, new_pg_name, location, comment='')

Creates a new Process Group with the given name under the provided parent Process Group at the given Location

Parameters:

• parent_pg (ProcessGroupEntity) – The parent Process Group to create the new process group in
• new_pg_name (str) – The name of the new Process Group
• location (tuple[x, y]) – the x,y coordinates to place the new Process Group under the parent
• comment (str) – Entry for the Comments field

Returns:

The new Process Group

Return type:

(ProcessGroupEntity)

nipyapi.canvas.list_all_processors(pg_id='root')

Returns a flat list of all Processors under the provided Process Group

Parameters:pg_id (str) – The UUID of the Process Group to start from, defaults to the Canvas root Returns:list[ProcessorEntity]

nipyapi.canvas.list_all_processor_types()

Produces the list of all available processor types in the NiFi instance

Returns:A native datatype containing the processors list Return type:list(ProcessorTypesEntity)

nipyapi.canvas.get_processor_type(identifier, identifier_type='name', greedy=True)

Gets the abstract object describing a Processor, or list thereof

Parameters:

• identifier (str) – the string to filter the list for
• identifier_type (str) – the field to filter on, set in config.py
• greedy (bool) – False for exact match, True for greedy match

Returns:

None for no matches, Single Object for unique match, list(Objects) for multiple matches

nipyapi.canvas.create_processor(parent_pg, processor, location, name=None, config=None)

Instantiates a given processor on the canvas

Parameters:

• parent_pg (ProcessGroupEntity) – The parent Process Group
• processor (DocumentedTypeDTO) – The abstract processor type object to be instantiated
• location (tuple[x, y]) – The location coordinates
• name (Optional [str]) – The name for the new Processor
• config (Optional [ProcessorConfigDTO]) – A configuration object for the new processor

Returns:

The new Processor

Return type:

(ProcessorEntity)

nipyapi.canvas.delete_processor(processor, refresh=True, force=False)

Deletes a Processor from the canvas, with optional prejudice.

Parameters:

• processor (ProcessorEntity) – The processor to delete
• refresh (bool) – Whether to refresh the Processor state before action
• force (bool) – Whether to stop, purge and remove connections to the Processor before deletion. Behavior may change in future releases.

Returns:

The updated ProcessorEntity

Return type:

(ProcessorEntity)

nipyapi.canvas.get_processor(identifier, identifier_type='name', greedy=True)

Filters the list of all Processors against the given identifier string in the given identifier_type field

Parameters:

• identifier (str) – The String to filter against
• identifier_type (str) – The field to apply the filter to. Set in config.py
• greedy (bool) – Whether to exact match (False) or partial match (True)

Returns:

None for no matches, Single Object for unique match, list(Objects) for multiple matches

nipyapi.canvas.schedule_processor(processor, scheduled, refresh=True)

Set a Processor to Start or Stop.

Note that this doesn’t guarantee that it will change state, merely that it will be instructed to try. Some effort is made to wait and see if the processor starts

Parameters:

• processor (ProcessorEntity) – The Processor to target
• scheduled (bool) – True to start, False to stop
• refresh (bool) – Whether to refresh the object before action

Returns:

True for success, False for failure

Return type:

(bool)

nipyapi.canvas.get_funnel(funnel_id)

Gets a given Funnel by ID

nipyapi.canvas.update_processor(processor, update, refresh=True)

Updates configuration parameters for a given Processor.

An example update would be: nifi.ProcessorConfigDTO(scheduling_period=’3s’)

Parameters:

• processor (ProcessorEntity) – The Processor to target for update
• update (ProcessorConfigDTO) – The new configuration parameters
• refresh (bool) – Whether to refresh the Processor object state before applying the update

Returns:

The updated ProcessorEntity

Return type:

(ProcessorEntity)

nipyapi.canvas.get_variable_registry(process_group, ancestors=True)

Gets the contents of the variable registry attached to a Process Group

Parameters:

• process_group (ProcessGroupEntity) – The Process Group to retrieve the Variable Registry from
• ancestors (bool) – Whether to include the Variable Registries from child Process Groups

Returns:

The Variable Registry

Return type:

(VariableRegistryEntity)

nipyapi.canvas.update_variable_registry(process_group, update, refresh=True)

Updates one or more key:value pairs in the variable registry

Parameters:

• process_group (ProcessGroupEntity) – The Process Group which has the
• Registry to be updated (Variable) –
• update (list[tuple]) – The variables to write to the registry
• refresh (bool) – Whether to refresh the object revision before updating

Returns:

The created or updated Variable Registry Entries

Return type:

(VariableRegistryEntity)

nipyapi.canvas.purge_connection(con_id)

EXPERIMENTAL Drops all FlowFiles in a given connection. Waits until the action is complete before returning.

Note that if upstream component isn’t stopped, more data may flow into the connection after this action.

Parameters:con_id (str) – The UUID of the Connection to be purged Returns:The status reporting object for the drop request. Return type:(DropRequestEntity)

nipyapi.canvas.purge_process_group(process_group, stop=False)

EXPERIMENTAL Purges the connections in a given Process Group of FlowFiles, and optionally stops it first

Parameters:

• process_group (ProcessGroupEntity) – Target Process Group
• stop (Optional [bool]) – Whether to stop the Process Group before action

Returns:

True|False}]): Result set. A list of Dicts of

Return type:

(list[dict{ID

Connection IDs mapped to True or False for success of each connection

nipyapi.canvas.schedule_components(pg_id, scheduled, components=None)

Changes the scheduled target state of a list of components within a given Process Group.

Note that this does not guarantee that components will be Started or Stopped afterwards, merely that they will have their scheduling updated.

Parameters:

• pg_id (str) – The UUID of the parent Process Group
• scheduled (bool) – True to start, False to stop
• components (list[ComponentType]) – The list of Component Entities to schdule, e.g. ProcessorEntity’s

Returns:

True for success, False for not

Return type:

(bool)

nipyapi.canvas.get_bulletins()

Retrieves current bulletins (alerts) from the Flow Canvas

Returns:The native datatype containing a list Return type:(ControllerBulletinsEntity)

of bulletins

nipyapi.canvas.get_bulletin_board()

Retrieves the bulletin board object

Returns:The native datatype BulletinBoard object Return type:(BulletinBoardEntity)

nipyapi.canvas.list_invalid_processors(pg_id='root', summary=False)

Returns a flattened list of all Processors with Invalid Statuses

Parameters:

• pg_id (str) – The UUID of the Process Group to start from, defaults to the Canvas root
• summary (bool) – True to return just the list of relevant properties per Processor, False for the full listing

Returns:

list[ProcessorEntity]

nipyapi.canvas.list_sensitive_processors(pg_id='root', summary=False)

Returns a flattened list of all Processors on the canvas which have sensitive properties that would need to be managed during deployment

Parameters:

• pg_id (str) – The UUID of the Process Group to start from, defaults to the Canvas root
• summary (bool) – True to return just the list of relevant properties per Processor, False for the full listing

Returns:

list[ProcessorEntity] or list(dict)

nipyapi.canvas.list_all_connections(pg_id='root', descendants=True)

Lists all connections for a given Process Group ID

Parameters:

• pg_id (str) – ID of the Process Group to retrieve Connections from
• descendants (bool) – True to recurse child PGs, False to not

Returns:

List of ConnectionEntity objects

Return type:

(list)

nipyapi.canvas.create_connection(source, target, relationships=None, name=None)

Creates a connection between two objects for the given relationships

Parameters:

• source – Object to initiate the connection, e.g. ProcessorEntity
• target – Object to terminate the connection, e.g. FunnelEntity
• relationships (list) – list of strings of relationships to connect, may be collected from the object ‘relationships’ property (optional)
• name (str) – Defaults to None, String of Name for Connection (optional)

Returns:

for the created connection

Return type:

(ConnectionEntity)

nipyapi.canvas.delete_connection(connection, purge=False)

Deletes a connection, optionally purges it first

Parameters:

• connection (ConnectionEntity) – Connection to delete
• purge (bool) – True to Purge, Defaults to False

Returns:

the modified Connection

Return type:

(ConnectionEntity)

nipyapi.canvas.get_component_connections(component)

Returns list of Connections related to a given Component, e.g. Processor

Parameters:component – Component Object to filter by, e.g. a ProcessorEntity Returns:List of ConnectionEntity Objects Return type:(list)

nipyapi.canvas.create_controller(parent_pg, controller, name=None)

Creates a new Controller Service in a given Process Group of the given

Controller type, with the given Name

Parameters:

• parent_pg (ProcessGroupEntity) – Target Parent PG
• controller (DocumentedTypeDTO) – Type of Controller to create, found via the list_all_controller_types method
• name (str[Optional]) – Name for the new Controller as a String

Returns:

(ControllerServiceEntity)

nipyapi.canvas.list_all_controllers(pg_id='root', descendants=True)

Lists all controllers under a given Process Group, defaults to Root

Optionally recurses all child Process Groups as well

Parameters:

• pg_id (str) – String of the ID of the Process Group to list from
• descendants (bool) – True to recurse child PGs, False to not

Returns:

None, ControllerServiceEntity, or list(ControllerServiceEntity)

nipyapi.canvas.delete_controller(controller, force=False)

Delete a Controller service, with optional prejudice

Parameters:

• controller (ControllerServiceEntity) – Target Controller to delete
• force (bool) – True to attempt Disable the Controller before deletion

Returns:

(ControllerServiceEntity)

nipyapi.canvas.update_controller(controller, update)

Updates the Configuration of a Controller Service

Parameters:

• controller (ControllerServiceEntity) – Target Controller to update
• update (ControllerServiceDTO) – Controller Service configuration object containing the new config params and properties

Returns:

(ControllerServiceEntity)

nipyapi.canvas.schedule_controller(controller, scheduled, refresh=False)

Start/Enable or Stop/Disable a Controller Service

Parameters:

• controller (ControllerServiceEntity) – Target Controller to schedule
• scheduled (bool) – True to start, False to stop
• refresh (bool) – Whether to refresh the component revision before execution

Returns:

(ControllerServiceEntity)

nipyapi.canvas.get_controller(identifier, identifier_type='name', bool_response=False)

Retrieve a given Controller

Parameters:

• identifier (str) – ID or Name of a Controller to find
• identifier_type (str) – ‘id’ or ‘name’, defaults to name
• bool_response (bool) – If True, will return False if the Controller is not found - useful when testing for deletion completion

Returns:

nipyapi.canvas.list_all_controller_types()

Lists all Controller Service types available on the environment

Returns:list(DocumentedTypeDTO)

nipyapi.canvas.list_all_by_kind(kind, pg_id='root', descendants=True)

Retrieves a list of all instances of a supported object type

Parameters:

• kind (str) – one of input_ports, output_ports, funnels, controllers, connections, remote_process_groups
• pg_id (str) – optional, ID of the Process Group to use as search base
• descendants (bool) – optional, whether to collect child group info

Returns:

list of the Entity type of the kind, or single instance, or None

nipyapi.canvas.list_all_input_ports(pg_id='root', descendants=True)

Convenience wrapper for list_all_by_kind for input ports

nipyapi.canvas.list_all_output_ports(pg_id='root', descendants=True)

Convenience wrapper for list_all_by_kind for output ports

nipyapi.canvas.list_all_funnels(pg_id='root', descendants=True)

Convenience wrapper for list_all_by_kind for funnels

nipyapi.canvas.list_all_remote_process_groups(pg_id='root', descendants=True)

Convenience wrapper for list_all_by_kind for remote process groups

nipyapi.canvas.delete_funnel(funnel, refresh=True)

Deletes a Funnel Object

Parameters:

• funnel (FunnelEntity) – The Funnel to delete
• refresh (bool) – Whether to refresh the object state before execution

Returns:

(FunnelEntity) Deleted FunnelEntity reference

nipyapi.canvas.get_remote_process_group(rpg_id, summary=False)

Fetch a remote process group object, with optional summary of just ports

nipyapi.canvas.update_process_group(pg, update, refresh=True)

Updates a given Process Group.

Parameters:

• pg (ProcessGroupEntity) – The Process Group to target for update
• update (dict) – key:value pairs to update
• refresh (bool) – Whether to refresh the Process Group before applying the update

Returns:

The updated ProcessorEntity

Return type:

(ProcessGroupEntity)

nipyapi.canvas.create_funnel(pg_id, position=None)

Creates a Funnel Object

Parameters:

• pg_id (str) – ID of the parent Process Group
• position (tuple[int, int]) – Position on canvas

Returns:

(FunnelEntity) Created Funnel

nipyapi.canvas.create_remote_process_group(target_uris, transport='RAW', pg_id='root', position=None)

Creates a new Remote Process Group with given parameters

Parameters:

• target_uris (str) – Comma separated list of target URIs
• transport (str) – optional, RAW or HTTP
• pg_id (str) – optional, UUID of parent Process Group for remote process group
• position (tuple) – optional, tuple of location ints

Returns:

(RemoteProcessGroupEntity)

nipyapi.canvas.delete_remote_process_group(rpg, refresh=True)

Deletes a given remote process group

Parameters:

• rpg (RemoteProcessGroupEntity) – Remote Process Group to remove
• refresh (bool) – Whether to refresh the object before action

Returns:

(RemoteProcessGroupEntity)

nipyapi.canvas.set_remote_process_group_transmission(rpg, enable=True, refresh=True)

Enable or Disable Transmission for an RPG

Parameters:

• rpg (RemoteProcessGroupEntity) – The ID of the remote process group to modify
• enable (bool) – True to enable, False to disable
• refresh (bool) – Whether to refresh the object before action

Returns:

nipyapi.canvas.get_pg_parents_ids(pg_id)

Retrieve the ids of the parent Process Groups.

Parameters:pg_id (str) – Process group id Returns:(list) List of ids of the input PG parents

nipyapi.canvas.delete_port(port)

Deletes a given port from the canvas if possible

nipyapi.canvas.create_port(pg_id, port_type, name, state, position=None)

Creates a new input or output port of given characteristics

Parameters:

• pg_id (str) – ID of the parent Process Group
• port_type (str) – Either of INPUT_PORT or OUTPUT_PORT
• name (str) – optional, Name to assign to the port
• state (str) – One of RUNNING, STOPPED, DISABLED
• position (tuple) – optional, tuple of ints like (400, 400)

Returns:

(PortEntity) of the created port

Config

A set of defaults and parameters used elsewhere in the project. Also provides a handy link to the low-level client SDK configuration singleton objects.

Parameters

For Managing NiFi Parameter Contexts

nipyapi.parameters.list_all_parameter_contexts()

Lists all Parameter Contexts available on the Canvas

Returns:list(ParameterContextEntity)

nipyapi.parameters.create_parameter_context(name, description=None, parameters=None, inherited_contexts=None)

Create a new Parameter Context with optional description and

initial Parameters

Parameters:

• name (str) – The Name for the new Context
• description (str) – An optional description
• parameters (list[ParameterEntity]) – A list of prepared Parameters
• inherited_contexts (list[ParameterContextEntity]) – A list of inherited Parameter Contexts

Returns:

(ParameterContextEntity) The New Parameter Context

nipyapi.parameters.delete_parameter_context(context, refresh=True)

Removes a Parameter Context

Parameters:

• context (ParameterContextEntity) – Parameter Context to be deleted
• refresh (bool) – Whether to refresh the Context before Deletion

Returns:

(ParameterContextEntity) The removed Parameter Context

nipyapi.parameters.get_parameter_context(identifier, identifier_type='name', greedy=True)

Gets one or more Parameter Contexts matching a given identifier

Parameters:

• identifier (str) – The Name or ID matching Parameter Context(s)
• identifier_type (str) – ‘name’ or ‘id’
• greedy (bool) – False for exact match, True for string match

Returns:

None for no matches, Single Object for unique match, list(Objects) for multiple matches

nipyapi.parameters.update_parameter_context(context)

Update an already existing Parameter Context

Parameters:

• context (ParameterContextEntity) – Parameter Context updated to be applied
• refresh (bool) – Whether to refresh the object before Updating

Returns:

(ParameterContextEntity) The updated Parameter Context

nipyapi.parameters.prepare_parameter(name, value, description=None, sensitive=False)

Parses basic inputs into a Parameter object ready for submission

Parameters:

• name (str) – The Name for the Parameter
• value (str, int, float) – The Value for the Parameter
• description (str) – Optional Description for the Parameter
• sensitive (bool) – Whether to mark the Parameter Value as sensitive

Returns:

(ParameterEntity) The ParameterEntity ready for use

nipyapi.parameters.delete_parameter_from_context(context, parameter_name)

Delete a specific Parameter from a Parameter Context :param context: The Parameter Context to Update :type context: ParameterContextEntity :param parameter_name: The Parameter to delete :type parameter_name: str

Returns:(ParameterContextEntity) The updated Parameter Context

nipyapi.parameters.upsert_parameter_to_context(context, parameter)

Insert or Update Parameter within a Parameter Context

Parameters:

• context (ParameterContextEntity) – The Parameter Context to Modify
• parameter (ParameterEntity) – The ParameterEntity to insert or update

Returns:

(ParameterContextEntity) The updated Parameter Context

nipyapi.parameters.assign_context_to_process_group(pg, context_id, cascade=False)

Assigns a given Parameter Context to a specific Process Group Optionally cascades down to direct children Process Groups

Parameters:

• pg (ProcessGroupEntity) – The Process Group to target
• context_id (str) – The ID of the Parameter Context
• cascade (bool) – Cascade Parameter Context down to child Process Groups?

Returns:

(ProcessGroupEntity) The updated Process Group

nipyapi.parameters.remove_context_from_process_group(pg)

Clears any Parameter Context from the given Process Group

Parameters:pg (ProcessGroupEntity) – The Process Group to target Returns:(ProcessGroupEntity) The updated Process Group

Security

Secure connectivity management for NiPyApi

nipyapi.security.create_service_user(identity, service='nifi', strict=True)

Attempts to create a user with the provided identity in the given service

Parameters:

• identity (str) – Identity string for the user
• service (str) – ‘nifi’ or ‘registry’
• strict (bool) – If Strict, will error if user already exists

Returns:

The new (User) or (UserEntity) object

nipyapi.security.create_service_user_group(identity, service='nifi', users=None, strict=True)

Attempts to create a user with the provided identity and member users in the given service

Parameters:

• identity (str) – Identity string for the user group
• service (str) – ‘nifi’ or ‘registry’
• users (list) – A list of nifi.UserEntity or registry.User belonging to the group
• strict (bool) – Whether to throw an error on already exists

Returns:

The new (UserGroup) or (UserGroupEntity) object

nipyapi.security.set_service_auth_token(token=None, token_name='tokenAuth', service='nifi')

Helper method to set the auth token correctly for the specified service

Parameters:

• token (Optional[str]) – The token to set. Defaults to None.
• token_name (str) – the api_key field name to set the token to. Defaults to ‘tokenAuth’
• service (str) – ‘nifi’ or ‘registry’, the service to set

Returns:

True on success, False if token not set

Return type:

(bool)

nipyapi.security.service_logout(service='nifi')

Logs out from the service by resetting the token :param service: ‘nifi’ or ‘registry’; the target service :type service: str

Returns:True of access removed, False if still set Return type:(bool)

nipyapi.security.get_service_access_status(service='nifi', bool_response=False)

Gets the access status for the current session

Parameters:

• service (str) – A String of ‘nifi’ or ‘registry’ to indicate which service to check status for
• bool_response (bool) – If True, the function will return False on hitting an Error instead of raising it. Useful for connection testing.

Returns:

(bool) if bool_response, else the Service Access Status of the User

nipyapi.security.add_user_to_access_policy(user, policy, service='nifi', refresh=True, strict=True)

Attempts to add the given user object to the given access policy

Parameters:

• user (User) or (UserEntity) – User object to add
• policy (AccessPolicyEntity) or (AccessPolicy) – Access Policy object
• service (str) – ‘nifi’ or ‘registry’ to identify the target service
• refresh (bool) – Whether to refresh the policy object before submit
• strict (bool) – If True, will return error if user already present, if False will ignore the already exists

Returns:

Updated Policy object

nipyapi.security.update_access_policy(policy, service='nifi')

Applies an updated access policy to the service indicated

Parameters:

• policy (PolicyEntity) – The policy object to submit
• service (str) – ‘nifi’ or ‘registry’ to indicate the target service

Returns:

The updated policy if successful

Return type:

(PolicyEntity)

nipyapi.security.get_access_policy_for_resource(resource, action, r_id=None, service='nifi', auto_create=False)

Attempts to retrieve the access policy for a given resource and action, and optionally resource_id if targeting NiFi. Optionally creates the policy if it doesn’t already exist

Parameters:

• resource (str) – A valid resource in the target service
• action (str) – A valid action, typically ‘read’, ‘write’ or ‘delete’
• r_id (Optional[str]) – The UUID of the resource, valid only if targeting NiFi resources
• service (str) – Which service to target, typically ‘nifi’ or ‘registry’
• auto_create (bool) – Whether to create the targeted policy if it doesn’t already exist

Returns:

The relevant AccessPolicy object

nipyapi.security.create_access_policy(resource, action, r_id=None, service='nifi')

Creates an access policy for the given resource, action and optionally resource_id for NiFi.

Parameters:

• resource (str) – a valid resource type for this service, e.g. ‘bucket’
• action (str) – a valid action type for this service, typically ‘read’, ‘write’ or ‘delete’
• r_id (optional[str]) – if NiFi, the resource ID of the resource
• service (str) – the service to target

Returns:

An access policy object for that service

nipyapi.security.list_service_users(service='nifi')

Lists all users of a given service, takes a service name as a string

nipyapi.security.get_service_user(identifier, identifier_type='identity', service='nifi')

Gets the unique user matching to the given identifier and type.

Parameters:

• identifier (str) – the string to search for
• identifier_type (str) – the field to search in
• service (str) – the name of the service

Returns:

None if no match, else single object

nipyapi.security.set_service_ssl_context(service='nifi', ca_file=None, client_cert_file=None, client_key_file=None, client_key_password=None, check_hostname=None)

Create an SSLContext for connecting over https to a secured NiFi or NiFi-Registry instance.

This method can be used to create an SSLContext for two-way TLS in which a client cert is used by the service to authenticate the client.

This method can also be used for one-way TLS in which the client verifies the server’s certificate, but authenticates using a different form of credentials, such as LDAP username/password.

If you are using one-way TLS with a certificate signed by a root CA trusted by your system/platform, this step is not necessary as the default TLS-handshake should “just work.”

Parameters:

• service (str) – ‘nifi’ or ‘registry’ to indicate which service config to set the ssl context to
• ca_file (str) – A PEM file containing certs for the root CA(s) for the NiFi Registry server
• client_cert_file (str) – A PEM file containing the public certificates for the user/client identity
• client_key_file (str) – An encrypted (password-protected) PEM file containing the client’s secret key
• client_key_password (str) – The password to decrypt the client_key_file
• check_hostname (bool) – Enable or Disable hostname checking

Returns:

(None)

nipyapi.security.add_user_group_to_access_policy(user_group, policy, service='nifi', refresh=True)

Attempts to add the given user group object to the given access policy

Parameters:

• user_group (UserGroup) or (UserGroupEntity) – User group object to add
• policy (AccessPolicyEntity) or (AccessPolicy) – Access Policy object
• service (str) – ‘nifi’ or ‘registry’ to identify the target service
• refresh (bool) – Whether to refresh the policy object before submission

Returns:

Updated Policy object

nipyapi.security.bootstrap_security_policies(service, user_identity=None, group_identity=None)

Creates a default security context within NiFi or Nifi-Registry

Parameters:

• service (str) – ‘nifi’ or ‘registry’ to indicate which service
• user_identity – a service user to establish in the security context
• group_identity – a service group to establish in the security context

Returns:

None

nipyapi.security.service_login(service='nifi', username=None, password=None, bool_response=False)

Login to the currently configured NiFi or NiFi-Registry server.

Login requires a secure connection over https. Prior to calling this method, the host must be specified and the SSLContext should be configured (if necessary).

Successful login will result in a generated token (JWT) being cached in the api_client config that will be passed in all future REST API calls. To clear that token, call service_logout.

The token is temporary and will expire after a duration set by the server. After a token expires, you must call this method again to generate a new token.

Parameters:

• service (str) – ‘nifi’ or ‘registry’; the service to login to
• username (str) – The username to submit
• password (str) – The password to use
• bool_response (bool) – If True, the function will return False instead of an error. Useful for connection testing.

Returns:

True if successful, False or an Error if not. See bool_response

Return type:

(bool)

nipyapi.security.remove_service_user(user, service='nifi', strict=True)

Removes a given User from the given Service

Parameters:

• user – [(nifi.UserEntity), (registry.User)] Target User object
• service (str) – ‘nifi’ or ‘registry’
• strict (bool) – Whether to throw an error if User not found

Returns:

Updated User Entity or None

nipyapi.security.list_service_user_groups(service='nifi')

Returns list of service user groups for a given service :param service: ‘nifi’ or ‘registry’ :type service: str

Returns:[(nifi.UserGroupEntity, registry.UserGroup)]

nipyapi.security.get_service_user_group(identifier, identifier_type='identity', service='nifi')

Gets the unique group matching to the given identifier and type.

Parameters:

• identifier (str) – the string to search for
• identifier_type (str) – the field to search in, identity or id
• service (str) – the name of the service

Returns:

None if no match, else single object

nipyapi.security.remove_service_user_group(group, service='nifi', strict=True)

Removes a given User Group from the given Service

Parameters:

• group – [(nifi.UserEntity), (registry.User)] Target User object
• service (str) – ‘nifi’ or ‘registry’
• strict (bool) – Whether to throw an error if User not found

Returns:

Updated User Group or None

System

For system and cluster level functions interacting with the underlying NiFi Services

nipyapi.system.get_system_diagnostics()

Returns NiFi Sytems diagnostics page

Returns (json):

nipyapi.system.get_cluster()

EXPERIMENTAL Returns the contents of the NiFi cluster

Returns (json):

nipyapi.system.get_node(nid)

Returns the cluster node information

Parameters:nid (str) – The UUID of the Node to target

Returns:

nipyapi.system.get_nifi_version_info()

Returns the version information of the connected NiFi instance

Returns (VersionInfoDTO):

Templates

For Managing NiFi Templates

nipyapi.templates.list_all_templates(native=True)

Gets a list of all templates on the canvas

Returns:A list of TemplateEntity’s Return type:(list[TemplateEntity])

nipyapi.templates.get_template_by_name(name)

DEPRECATED Returns a specific template by name, if it exists.

Note: This function is replaced by get_template

Parameters:name (str) – The Name of the template, exact match required Returns:(TemplateEntity)

nipyapi.templates.deploy_template(pg_id, template_id, loc_x=0.0, loc_y=0.0)

Instantiates a given template request in a given process group

Parameters:

• pg_id (str) – The UUID of the Process Group to deploy into
• template_id (str) – The UUID of the Template to deploy. Note that the Template must already be uploaded and available to the target Process Group
• loc_x (float) – The X coordinate to deploy the Template at. Default(0.0)
• loc_y (float) – The X coordinate to deploy the Template at. Default(0.0)

Returns:

The FlowEntity of the Process Group with the deployed

template

Return type:

(FlowEntity)

nipyapi.templates.upload_template(pg_id, template_file)

Uploads a given template xml from from the file system to the given Process Group

Parameters:

• pg_id (str) – The UUID of the Process Group to upload to
• template_file (str) – The path including filename to the template file

Returns:

The new Template object

Return type:

(TemplateEntity)

nipyapi.templates.create_pg_snippet(pg_id)

Creates a snippet of the targeted process group, and returns the object ready to be turned into a Template

Parameters:pg_id – UUID of the process Group to snippet Returns:The Snippet Object Return type:(SnippetEntity)

nipyapi.templates.create_template(pg_id, name, desc='')

Creates a Template from a Process Group

Parameters:

• pg_id (str) – The UUID of the target Process Group
• name (str) – The name for the new Template. Must be unique
• desc (optional[str]) – The description for the new Template

Returns:

The newly created Template

Return type:

(TemplateEntity)

nipyapi.templates.delete_template(t_id)

Deletes a Template

Parameters:t_id (str) – UUID of the Template to be deleted Returns:The updated Template object

nipyapi.templates.export_template(t_id, output='string', file_path=None)

Exports a given Template as either a string or a file.

Note that to reimport the Template it must be a file

Parameters:

• t_id (str) – The UUID of the Template to export
• output (str) – ‘string’ or ‘file’ to set the export action
• file_path (Optional [str]) – The full path including filename to write the Template export to

Returns:

A String representation of the exported Template XML. Note

that this may not be utf-8 encoded.

Return type:

(str)

nipyapi.templates.get_template(identifier, identifier_type='name', greedy=False)

Filters the list of all Templates for a given string in a given field. Note that filters are configured in config.py

Parameters:

• identifier (str) – The string to filter on
• identifier_type (str) – The identifier of the field to filter on
• greedy (bool) – True for greedy match, False for exact match

Returns:

None for no matches, Single Object for unique match, list(Objects) for multiple matches

nipyapi.templates.load_template_from_xml_file_path(file_path)

Loads a TemplateEntity from an xml file for a given path

Parameters:file_path (str) – path to the xml file Returns:TemplateEntity

nipyapi.templates.load_template_from_xml_file_stream(file_stream)

Loads a TemplateEntity from a template xml file

Parameters:file_stream (io stream) – the xml file stream as returned by open Returns:TemplateEntity

nipyapi.templates.load_template_from_xml_string(xml_string)

Loads a TemplateEntity from xml string, as if you had read in the xml file to string

Parameters:xml_string (str) – string of xml Returns:TemplateEntity

Utils

Convenience utility functions for NiPyApi, not really intended for external use

nipyapi.utils.dump(obj, mode='json')

Dumps a native datatype object or swagger entity to json or yaml

defaults to json

Parameters:

• obj (varies) – The native datatype object or swagger type to serialise
• mode (str) – ‘json’ or ‘yaml’, the supported export modes

Returns (str): The serialised object

nipyapi.utils.load(obj, dto=None)

Loads a serialised object back into native datatypes, and optionally imports it back into the native NiFi DTO

Warning: Using this on objects not produced by this Package may have unintended results! While efforts have been made to ensure that unsafe loading is not possible, no stringent security testing has been completed.

Parameters:

• obj (dict, list) – The serialised object to import
• dto (Optional [tuple{str, str}]) – A Tuple describing the service and
• that should be constructed. (object) –
• dto = (e.g.) –

Returns: Either the loaded object in native Python datatypes, or the

constructed native datatype object

nipyapi.utils.fs_read(file_path)

Convenience function to read an Object from a FilePath

Parameters:file_path (str) – The Full path including filename to read from

Returns: The object that was read

nipyapi.utils.fs_write(obj, file_path)

Convenience function to write an Object to a FilePath

Parameters:

• obj (varies) – The Object to write out
• file_path (str) – The Full path including filename to write to

Returns: The object that was written

nipyapi.utils.filter_obj(obj, value, key, greedy=True)

Implements a custom filter method because native datatypes don’t have consistently named or located fields.

Note that each object used by this function must be registered with identifier_types and identifiers in config

Parameters:

• obj (varies) – the NiFi or NiFi-Registry object to filter on
• value (str) – the String value to look for
• key (str) – the object key to filter against
• greedy (bool) – If True, the value will be matched anywhere in the string, if False it will require exact match

Returns: None if 0 matches, list if > 1, single Object entity if ==1

nipyapi.utils.wait_to_complete(test_function, *args, **kwargs)

Implements a basic return loop for a given function which is capable of a True|False output

Parameters:

• test_function – Function which returns a bool once the target state is reached
• delay (int) – The number of seconds between each attempt, defaults to config.short_retry_delay
• max_wait (int) – the maximum number of seconds before issuing a Timeout, defaults to config.short_max_wait
• *args – Any args to pass through to the test function
• **kwargs – Any Keword Args to pass through to the test function

Returns (bool): True for success, False for not

nipyapi.utils.is_endpoint_up(endpoint_url)

Tests if a URL is available for requests

Parameters:endpoint_url (str) – The URL to test

Returns (bool): True for a 200 response, False for not

nipyapi.utils.set_endpoint(endpoint_url, ssl=False, login=False, username=None, password=None)

EXPERIMENTAL

Sets the endpoint when switching between instances of NiFi or other projects. Not tested extensively with secured instances.

Parameters:

• endpoint_url (str) – The URL to set as the endpoint. Auto-detects the relevant service e.g. ‘http://localhost:18080/nifi-registry-api’
• ssl (bool) – Whether to use the default security context in nipyapi.config to authenticate if a secure URL is detected
• login (bool) – Whether to attempt login using default cred in config requires ssl to be set
• username (str) – The username to use for login, if specified
• password (str) – The password to use for login, if specified

Returns (bool): True for success, False for not

nipyapi.utils.start_docker_containers(docker_containers, network_name='demo')

Deploys a list of DockerContainer’s on a given network

Parameters:

• docker_containers (list[DockerContainer]) – list of Dockers to start
• network_name (str) – The name of the Docker Bridge Network to get or create for the Docker Containers

Returns: Nothing

class nipyapi.utils.DockerContainer(name=None, image_name=None, image_tag=None, ports=None, env=None, volumes=None, test_url=None, endpoint=None)

Bases: object

Helper class for Docker container automation without using Ansible

get_container()

Fetch the container object

get_test_url_status()

Checks if a URL is available :return: status code if available, String ‘ConnectionError’ if not

set_container(container)

Set the container object

nipyapi.utils.infer_object_label_from_class(obj)

Returns the expected STRING label for an object class required by certain

functions.

Parameters:obj – The object to infer the name of Returns:str of the relevant name, or raises an AssertionError

nipyapi.utils.bypass_slash_encoding(service, bypass)

Instructs the API Client to bypass encoding the ‘/’ character

Parameters:

• service (str) – ‘nifi’ or ‘registry’
• bypass (bool) – True will not encode ‘/’ in fields via API calls

Returns:

None

nipyapi.utils.exception_handler(status_code=None, response=None)

Simple Function wrapper to handle HTTP Status Exceptions

nipyapi.utils.enforce_min_ver(min_version, bool_response=False, service='nifi')

Raises an error if target NiFi environment is not minimum version :param min_version: Version to check against :type min_version: str :param bool_response: If True, will return True instead of

raising error

Returns:(bool) or (NotImplementedError)

nipyapi.utils.check_version(base, comparator=None, service='nifi', default_version='0.2.0')

Compares version base against either version comparator, or the version of the currently connected service instance.

Since NiFi is java, it may return a version with -SNAPSHOT as part of it. As such, that will be stripped from either the comparator version or the version returned from NiFi

Parameters:

• base (str) – The base version for the comparison test
• comparator (optional[str]) – The version to compare against
• default_version (optional[str]) – The version to assume the service is if the check cannot be completed
• service (str) – The service to test the version against, currently only supports NiFi

Returns (int): -1/0/1 if base is lower/equal/newer than comparator

nipyapi.utils.validate_parameters_versioning_support(verify_nifi=True, verify_registry=True)

Convenience method to check if Parameters are supported :param verify_nifi: If True, check NiFi meets the min version :type verify_nifi: bool :param verify_registry: If True, check Registry meets the min version :type verify_registry: bool

Versioning

For interactions with the NiFi Registry Service and related functions

nipyapi.versioning.create_registry_client(name, uri, description)

Creates a Registry Client in the NiFi Controller Services

Parameters:

• name (str) – The name of the new Client
• uri (str) – The URI for the connection, such as ‘http://registry:18080’
• description (str) – A description for the Client

Returns:

The new registry client object

Return type:

(RegistryClientEntity)

nipyapi.versioning.list_registry_clients()

Lists the available Registry Clients in the NiFi Controller Services

Returns:(list[RegistryClientEntity]) objects

nipyapi.versioning.delete_registry_client(client, refresh=True)

Deletes a Registry Client from the list of NiFI Controller Services

Parameters:

• client (RegistryClientEntity) – The client to delete
• refresh (bool) – Whether to refresh the object before action

Returns:

The updated client object

Return type:

(RegistryClientEntity)

nipyapi.versioning.get_registry_client(identifier, identifier_type='name')

Filters the Registry clients to a particular identifier

Parameters:

• identifier (str) – the filter string
• identifier_type (str) – the parameter to filter on

Returns:

None for no matches, Single Object for unique match, list(Objects) for multiple matches

nipyapi.versioning.list_registry_buckets()

Lists all available Buckets in the NiFi Registry

Returns:(list[Bucket]) objects

nipyapi.versioning.create_registry_bucket(name)

Creates a new Registry Bucket

Parameters:name (str) – name for the bucket, must be unique in the Registry Returns:The new Bucket object Return type:(Bucket)

nipyapi.versioning.delete_registry_bucket(bucket)

Removes a bucket from the NiFi Registry

Parameters:bucket (Bucket) – the Bucket object to remove Returns:The updated Bucket object Return type:(Bucket)

nipyapi.versioning.get_registry_bucket(identifier, identifier_type='name', greedy=True)

Filters the Bucket list to a particular identifier

Parameters:

• identifier (str) – the filter string
• identifier_type (str) – the param to filter on
• greedy (bool) – False for exact match, True for greedy match

Returns:

None for no matches, Single Object for unique match, list(Objects) for multiple matches

nipyapi.versioning.save_flow_ver(process_group, registry_client, bucket, flow_name=None, flow_id=None, comment='', desc='', refresh=True, force=False)

Adds a Process Group into NiFi Registry Version Control, or saves a new version to an existing VersionedFlow with a new version

Parameters:

• process_group (ProcessGroupEntity) – the ProcessGroup object to save as a new Flow Version
• registry_client (RegistryClient) – The Client linked to the Registry which contains the Bucket to save to
• bucket (Bucket) – the Bucket on the NiFi Registry to save to
• flow_name (str) – A name for the VersionedFlow in the Bucket Note you need either a name for a new VersionedFlow, or the ID of an existing one to save a new version
• flow_id (Optional [str]) – Identifier of an existing VersionedFlow in the bucket, if saving a new version to an existing flow
• comment (str) – A comment for the version commit
• desc (str) – A description of the VersionedFlow
• refresh (bool) – Whether to refresh the object revisions before action
• force (bool) – Whether to Force Commit, or just regular Commit

Returns:

(VersionControlInformationEntity)

nipyapi.versioning.list_flows_in_bucket(bucket_id)

List of all Flows in a given NiFi Registry Bucket

Parameters:bucket_id (str) – The UUID of the Bucket to fetch from Returns:(list[VersionedFlow]) objects

nipyapi.versioning.get_flow_in_bucket(bucket_id, identifier, identifier_type='name', greedy=True)

Filters the Flows in a Bucket against a particular identifier

Parameters:

• bucket_id (str) – UUID of the Bucket to filter against
• identifier (str) – The string to filter on
• identifier_type (str) – The param to check
• greedy (bool) – False for exact match, True for greedy match

Returns:

None for no matches, Single Object for unique match, list(Objects) for multiple matches

nipyapi.versioning.get_latest_flow_ver(bucket_id, flow_id)

Gets the most recent version of a VersionedFlowSnapshot from a bucket

Parameters:

• bucket_id (str) – the UUID of the Bucket containing the flow
• flow_id (str) – the UUID of the VersionedFlow to be retrieved

Returns:

(VersionedFlowSnapshot)

nipyapi.versioning.update_flow_ver(process_group, target_version=None)

Changes a versioned flow to the specified version, or the latest version

Parameters:

• process_group (ProcessGroupEntity) – ProcessGroupEntity under version control to change
• target_version (Optional [None, Int]) – Either None to move to the
• available version, or Int of the version number to move to (latest) –

Returns:

True if successful, False if not

Return type:

(bool)

nipyapi.versioning.get_version_info(process_group)

Gets the Version Control information for a particular Process Group

Parameters:process_group (ProcessGroupEntity) – the ProcessGroup to work with Returns:(VersionControlInformationEntity)

nipyapi.versioning.create_flow(bucket_id, flow_name, flow_desc='', flow_type='Flow')

Creates a new VersionedFlow stub in NiFi Registry. Can be used to write VersionedFlow information to without using a NiFi Process Group directly

Parameters:

• bucket_id (str) – UUID of the Bucket to write to
• flow_name (str) – Name for the new VersionedFlow object
• flow_desc (Optional [str]) – Description for the new VersionedFlow object
• flow_type (Optional [str]) – Type of the VersionedFlow, should be ‘Flow’

Returns:

(VersionedFlow)

nipyapi.versioning.create_flow_version(flow, flow_snapshot, refresh=True)

EXPERIMENTAL

Writes a FlowSnapshot into a VersionedFlow as a new version update

Note that this differs from save_flow_ver which creates a new Flow Version containing the snapshot. This function writes a snapshot to an existing Flow Version. Useful in migrating Flow Versions between environments.

Parameters:

• flow (VersionedFlowObject) – the VersionedFlow object to write to
• flow_snapshot (VersionedFlowSnapshot) – the Snapshot to write into the VersionedFlow
• refresh (bool) – Whether to refresh the object status before actioning

Returns:

The new (VersionedFlowSnapshot)

nipyapi.versioning.get_flow_version(bucket_id, flow_id, version=None, export=False)

Retrieves the latest, or a specific, version of a Flow

Parameters:

• bucket_id (str) – the UUID of the bucket containing the Flow
• flow_id (str) – the UUID of the Flow to be retrieved from the Bucket
• version (Optional [None, str]) – ‘None’ to retrieve the latest version, or a version number as a string to get that version
• export (bool) – True to get the raw json object from the server for export, False to get the native DataType

Returns:

If export=False, or the raw json otherwise

Return type:

(VersionedFlowSnapshot)

WARNING: This call is impacted by https://issues.apache.org/jira/browse/NIFIREG-135 Which means you sometimes can’t trust the version count

nipyapi.versioning.export_flow_version(bucket_id, flow_id, version=None, file_path=None, mode='json')

Convenience method to export the identified VersionedFlowSnapshot in the provided format mode.

Parameters:

• bucket_id (str) – the UUID of the bucket containing the Flow
• flow_id (str) – the UUID of the Flow to be retrieved from the Bucket
• version (Optional [None, Str]) – ‘None’ to retrieve the latest version, or a version number as a string to get that version
• file_path (str) – The path and filename to write to. Defaults to None which returns the serialised obj
• mode (str) – ‘json’ or ‘yaml’ to specific the encoding format

Returns:

(str) of the encoded Snapshot

nipyapi.versioning.import_flow_version(bucket_id, encoded_flow=None, file_path=None, flow_name=None, flow_id=None)

Imports a given encoded_flow version into the bucket and flow described, may optionally be passed a file to read the encoded flow_contents from.

Note that only one of encoded_flow or file_path, and only one of flow_name or flow_id should be specified.

Parameters:

• bucket_id (str) – UUID of the bucket to write the encoded_flow version
• encoded_flow (Optional [str]) – The encoded flow to import; if not specified file_path is read from.
• file_path (Optional [str]) – The file path to read the encoded flow from , if not specified encoded_flow is read from.
• flow_name (Optional [str]) – If this is to be the first version in a new flow object, then this is the String name for the flow object.
• flow_id (Optional [str]) – If this is a new version for an existing flow object, then this is the ID of that object.

Returns:

The new (VersionedFlowSnapshot)

nipyapi.versioning.list_flow_versions(bucket_id, flow_id, registry_id=None, service='registry')

EXPERIMENTAL List all the versions of a given Flow in a given Bucket

Parameters:

• bucket_id (str) – UUID of the bucket holding the flow to be enumerated
• flow_id (str) – UUID of the flow in the bucket to be enumerated
• registry_id (str) – UUID of the registry client linking the bucket, only required if requesting flows via NiFi instead of directly Registry
• service (str) – Accepts ‘nifi’ or ‘registry’, indicating which service to query

Returns:

list(VersionedFlowSnapshotMetadata) or

(VersionedFlowSnapshotMetadataSetEntity)

nipyapi.versioning.deploy_flow_version(parent_id, location, bucket_id, flow_id, reg_client_id, version=None)

Deploys a versioned flow as a new process group inside the given parent process group. If version is not provided, the latest version will be deployed.

Parameters:

• parent_id (str) – The ID of the parent Process Group to create the new process group in.
• location (tuple[x, y]) – the x,y coordinates to place the new Process Group under the parent
• bucket_id (str) – ID of the bucket containing the versioned flow to deploy.
• reg_client_id (str) – ID of the registry client connection to use.
• flow_id (str) – ID of the versioned flow to deploy.
• version (Optional [int,str]) – version to deploy, if not provided latest version will be deployed.

Returns:

(ProcessGroupEntity) of the newly deployed Process Group

Swagger Client SDKs

These sub-packages are full swagger clients to the NiFi and NiFi-Registry APIs and may be used directly, or wrapped into the NiPyApi SDK convenience functions

NiFi Swagger Client

Subpackages

nipyapi.nifi.apis package

Submodules

nipyapi.nifi.apis.access_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.access_api.AccessApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

create_access_token(**kwargs)

Creates a token for accessing the REST API via username/password The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. It is stored in the browser as a cookie, but also returned inthe response body to be stored/used by third party client scripts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• username (str) –
• password (str) –

Returns:

str If the method is called asynchronously, returns the request thread.

create_access_token_from_ticket(**kwargs)

Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. It is also stored in the browser as a cookie. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_from_ticket(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

create_access_token_from_ticket_with_http_info(**kwargs)

Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. It is also stored in the browser as a cookie. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_from_ticket_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

create_access_token_with_http_info(**kwargs)

Creates a token for accessing the REST API via username/password The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. It is stored in the browser as a cookie, but also returned inthe response body to be stored/used by third party client scripts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_with_http_info(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• username (str) –
• password (str) –

Returns:

str If the method is called asynchronously, returns the request thread.

get_access_status(**kwargs)

Gets the status the client’s access Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_status(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:AccessStatusEntity If the method is called asynchronously, returns the request thread.

get_access_status_with_http_info(**kwargs)

Gets the status the client’s access Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_status_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:AccessStatusEntity If the method is called asynchronously, returns the request thread.

get_access_token_expiration(**kwargs)

Get expiration for current Access Token Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_token_expiration(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:AccessTokenExpirationEntity If the method is called asynchronously, returns the request thread.

get_access_token_expiration_with_http_info(**kwargs)

Get expiration for current Access Token Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_token_expiration_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:AccessTokenExpirationEntity If the method is called asynchronously, returns the request thread.

get_login_config(**kwargs)

Retrieves the access configuration for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_login_config(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:AccessConfigurationEntity If the method is called asynchronously, returns the request thread.

get_login_config_with_http_info(**kwargs)

Retrieves the access configuration for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_login_config_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:AccessConfigurationEntity If the method is called asynchronously, returns the request thread.

knox_callback(**kwargs)

Redirect/callback URI for processing the result of the Apache Knox login sequence. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.knox_callback(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

knox_callback_with_http_info(**kwargs)

Redirect/callback URI for processing the result of the Apache Knox login sequence. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.knox_callback_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

knox_logout(**kwargs)

Performs a logout in the Apache Knox. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.knox_logout(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

knox_logout_with_http_info(**kwargs)

Performs a logout in the Apache Knox. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.knox_logout_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

knox_request(**kwargs)

Initiates a request to authenticate through Apache Knox. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.knox_request(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

knox_request_with_http_info(**kwargs)

Initiates a request to authenticate through Apache Knox. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.knox_request_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

log_out(**kwargs)

Performs a logout for other providers that have been issued a JWT. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.log_out(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

log_out_complete(**kwargs)

Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.log_out_complete(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

log_out_complete_with_http_info(**kwargs)

Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.log_out_complete_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

log_out_with_http_info(**kwargs)

Performs a logout for other providers that have been issued a JWT. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.log_out_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.connections_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.connections_api.ConnectionsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

delete_connection(id, **kwargs)

Deletes a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_connection(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

delete_connection_with_http_info(id, **kwargs)

Deletes a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_connection_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

get_connection(id, **kwargs)

Gets a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

get_connection_with_http_info(id, **kwargs)

Gets a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

update_connection(id, body, **kwargs)

Updates a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_connection(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• body (ConnectionEntity) – The connection configuration details. (required)

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

update_connection_with_http_info(id, body, **kwargs)

Updates a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_connection_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• body (ConnectionEntity) – The connection configuration details. (required)

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.controller_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.controller_api.ControllerApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

create_bulletin(body, **kwargs)

Creates a new bulletin

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_bulletin(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (BulletinEntity) – The reporting task configuration details. (required)

Returns:

BulletinEntity If the method is called asynchronously, returns the request thread.

create_bulletin_with_http_info(body, **kwargs)

Creates a new bulletin

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_bulletin_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (BulletinEntity) – The reporting task configuration details. (required)

Returns:

BulletinEntity If the method is called asynchronously, returns the request thread.

create_controller_service(body, **kwargs)

Creates a new controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_controller_service(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (ControllerServiceEntity) – The controller service configuration details. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

create_controller_service_with_http_info(body, **kwargs)

Creates a new controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_controller_service_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (ControllerServiceEntity) – The controller service configuration details. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

create_registry_client(body, **kwargs)

Creates a new registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_registry_client(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (RegistryClientEntity) – The registry configuration details. (required)

Returns:

RegistryClientEntity If the method is called asynchronously, returns the request thread.

create_registry_client_with_http_info(body, **kwargs)

Creates a new registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_registry_client_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (RegistryClientEntity) – The registry configuration details. (required)

Returns:

RegistryClientEntity If the method is called asynchronously, returns the request thread.

create_reporting_task(body, **kwargs)

Creates a new reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_reporting_task(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (ReportingTaskEntity) – The reporting task configuration details. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

create_reporting_task_with_http_info(body, **kwargs)

Creates a new reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_reporting_task_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (ReportingTaskEntity) – The reporting task configuration details. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

delete_history(end_date, **kwargs)

Purges history

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_history(end_date, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• end_date (str) – Purge actions before this date/time. (required)

Returns:

HistoryEntity If the method is called asynchronously, returns the request thread.

delete_history_with_http_info(end_date, **kwargs)

Purges history

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_history_with_http_info(end_date, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• end_date (str) – Purge actions before this date/time. (required)

Returns:

HistoryEntity If the method is called asynchronously, returns the request thread.

delete_node(id, **kwargs)

Removes a node from the cluster

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_node(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The node id. (required)

Returns:

NodeEntity If the method is called asynchronously, returns the request thread.

delete_node_with_http_info(id, **kwargs)

Removes a node from the cluster

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_node_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The node id. (required)

Returns:

NodeEntity If the method is called asynchronously, returns the request thread.

delete_registry_client(id, **kwargs)

Deletes a registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_registry_client(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The registry id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

RegistryClientEntity If the method is called asynchronously, returns the request thread.

delete_registry_client_with_http_info(id, **kwargs)

Deletes a registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_registry_client_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The registry id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

RegistryClientEntity If the method is called asynchronously, returns the request thread.

get_cluster(**kwargs)

Gets the contents of the cluster Returns the contents of the cluster including all nodes and their status. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_cluster(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ClusterEntity If the method is called asynchronously, returns the request thread.

get_cluster_with_http_info(**kwargs)

Gets the contents of the cluster Returns the contents of the cluster including all nodes and their status. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_cluster_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ClusterEntity If the method is called asynchronously, returns the request thread.

get_controller_config(**kwargs)

Retrieves the configuration for this NiFi Controller

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_config(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ControllerConfigurationEntity If the method is called asynchronously, returns the request thread.

get_controller_config_with_http_info(**kwargs)

Retrieves the configuration for this NiFi Controller

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_config_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ControllerConfigurationEntity If the method is called asynchronously, returns the request thread.

get_node(id, **kwargs)

Gets a node in the cluster

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_node(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The node id. (required)

Returns:

NodeEntity If the method is called asynchronously, returns the request thread.

get_node_status_history(**kwargs)

Gets status history for the node Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_node_status_history(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ComponentHistoryEntity If the method is called asynchronously, returns the request thread.

get_node_status_history_with_http_info(**kwargs)

Gets status history for the node Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_node_status_history_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ComponentHistoryEntity If the method is called asynchronously, returns the request thread.

get_node_with_http_info(id, **kwargs)

Gets a node in the cluster

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_node_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The node id. (required)

Returns:

NodeEntity If the method is called asynchronously, returns the request thread.

get_registry_client(id, **kwargs)

Gets a registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_registry_client(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The registry id. (required)

Returns:

RegistryClientEntity If the method is called asynchronously, returns the request thread.

get_registry_client_with_http_info(id, **kwargs)

Gets a registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_registry_client_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The registry id. (required)

Returns:

RegistryClientEntity If the method is called asynchronously, returns the request thread.

get_registry_clients(**kwargs)

Gets the listing of available registry clients

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_registry_clients(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:RegistryClientsEntity If the method is called asynchronously, returns the request thread.

get_registry_clients_with_http_info(**kwargs)

Gets the listing of available registry clients

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_registry_clients_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:RegistryClientsEntity If the method is called asynchronously, returns the request thread.

update_controller_config(body, **kwargs)

Retrieves the configuration for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_controller_config(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (ControllerConfigurationEntity) – The controller configuration. (required)

Returns:

ControllerConfigurationEntity If the method is called asynchronously, returns the request thread.

update_controller_config_with_http_info(body, **kwargs)

Retrieves the configuration for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_controller_config_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (ControllerConfigurationEntity) – The controller configuration. (required)

Returns:

ControllerConfigurationEntity If the method is called asynchronously, returns the request thread.

update_node(id, body, **kwargs)

Updates a node in the cluster

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_node(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The node id. (required)
• body (NodeEntity) – The node configuration. The only configuration that will be honored at this endpoint is the status. (required)

Returns:

NodeEntity If the method is called asynchronously, returns the request thread.

update_node_with_http_info(id, body, **kwargs)

Updates a node in the cluster

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_node_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The node id. (required)
• body (NodeEntity) – The node configuration. The only configuration that will be honored at this endpoint is the status. (required)

Returns:

NodeEntity If the method is called asynchronously, returns the request thread.

update_registry_client(id, body, **kwargs)

Updates a registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_registry_client(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The registry id. (required)
• body (RegistryClientEntity) – The registry configuration details. (required)

Returns:

RegistryClientEntity If the method is called asynchronously, returns the request thread.

update_registry_client_with_http_info(id, body, **kwargs)

Updates a registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_registry_client_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The registry id. (required)
• body (RegistryClientEntity) – The registry configuration details. (required)

Returns:

RegistryClientEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.controller_services_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.controller_services_api.ControllerServicesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

analyze_configuration(id, body, **kwargs)

Performs analysis of the component’s configuration, providing information about which attributes are referenced.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.analyze_configuration(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• body (ConfigurationAnalysisEntity) – The configuration analysis request. (required)

Returns:

ConfigurationAnalysisEntity If the method is called asynchronously, returns the request thread.

analyze_configuration_with_http_info(id, body, **kwargs)

Performs analysis of the component’s configuration, providing information about which attributes are referenced.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.analyze_configuration_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• body (ConfigurationAnalysisEntity) – The configuration analysis request. (required)

Returns:

ConfigurationAnalysisEntity If the method is called asynchronously, returns the request thread.

clear_state(id, **kwargs)

Clears the state for a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.clear_state(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

clear_state_with_http_info(id, **kwargs)

Clears the state for a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.clear_state_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

delete_validation_request(id, request_id, **kwargs)

Deletes the Verification Request with the given ID Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_validation_request(id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Controller Service (required)
• request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

delete_validation_request_with_http_info(id, request_id, **kwargs)

Deletes the Verification Request with the given ID Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_validation_request_with_http_info(id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Controller Service (required)
• request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

get_controller_service(id, **kwargs)

Gets a controller service If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_service(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• ui_only (bool) –

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

get_controller_service_references(id, **kwargs)

Gets a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_service_references(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)

Returns:

ControllerServiceReferencingComponentsEntity If the method is called asynchronously, returns the request thread.

get_controller_service_references_with_http_info(id, **kwargs)

Gets a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_service_references_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)

Returns:

ControllerServiceReferencingComponentsEntity If the method is called asynchronously, returns the request thread.

get_controller_service_with_http_info(id, **kwargs)

Gets a controller service If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_service_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• ui_only (bool) –

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor(id, property_name, **kwargs)

Gets a controller service property descriptor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor(id, property_name, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• property_name (str) – The property name to return the descriptor for. (required)
• sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor_with_http_info(id, property_name, **kwargs)

Gets a controller service property descriptor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor_with_http_info(id, property_name, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• property_name (str) – The property name to return the descriptor for. (required)
• sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_state(id, **kwargs)

Gets the state for a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_state_with_http_info(id, **kwargs)

Gets the state for a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_verification_request(id, request_id, **kwargs)

Returns the Verification Request with the given ID Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_verification_request(id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Controller Service (required)
• request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

get_verification_request_with_http_info(id, request_id, **kwargs)

Returns the Verification Request with the given ID Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_verification_request_with_http_info(id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Controller Service (required)
• request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

remove_controller_service(id, **kwargs)

Deletes a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_controller_service(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

remove_controller_service_with_http_info(id, **kwargs)

Deletes a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_controller_service_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

submit_config_verification_request(id, body, **kwargs)

Performs verification of the Controller Service’s configuration This will initiate the process of verifying a given Controller Service configuration. This may be a long-running task. As a result, this endpoint will immediately return a ControllerServiceConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /controller-services/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /controller-services/{serviceId}/verification-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_config_verification_request(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• body (VerifyConfigRequestEntity) – The controller service configuration verification request. (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

submit_config_verification_request_with_http_info(id, body, **kwargs)

Performs verification of the Controller Service’s configuration This will initiate the process of verifying a given Controller Service configuration. This may be a long-running task. As a result, this endpoint will immediately return a ControllerServiceConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /controller-services/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /controller-services/{serviceId}/verification-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_config_verification_request_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• body (VerifyConfigRequestEntity) – The controller service configuration verification request. (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

update_controller_service(id, body, **kwargs)

Updates a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_controller_service(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• body (ControllerServiceEntity) – The controller service configuration details. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

update_controller_service_references(id, body, **kwargs)

Updates a controller services references

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_controller_service_references(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• body (UpdateControllerServiceReferenceRequestEntity) – The controller service request update request. (required)

Returns:

ControllerServiceReferencingComponentsEntity If the method is called asynchronously, returns the request thread.

update_controller_service_references_with_http_info(id, body, **kwargs)

Updates a controller services references

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_controller_service_references_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• body (UpdateControllerServiceReferenceRequestEntity) – The controller service request update request. (required)

Returns:

ControllerServiceReferencingComponentsEntity If the method is called asynchronously, returns the request thread.

update_controller_service_with_http_info(id, body, **kwargs)

Updates a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_controller_service_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• body (ControllerServiceEntity) – The controller service configuration details. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

update_run_status(id, body, **kwargs)

Updates run status of a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• body (ControllerServiceRunStatusEntity) – The controller service run status. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

update_run_status_with_http_info(id, body, **kwargs)

Updates run status of a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The controller service id. (required)
• body (ControllerServiceRunStatusEntity) – The controller service run status. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.counters_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.counters_api.CountersApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

get_counters(**kwargs)

Gets the current counters for this NiFi Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_counters(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

CountersEntity If the method is called asynchronously, returns the request thread.

get_counters_with_http_info(**kwargs)

Gets the current counters for this NiFi Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_counters_with_http_info(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

CountersEntity If the method is called asynchronously, returns the request thread.

update_counter(id, **kwargs)

Updates the specified counter. This will reset the counter value to 0 Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_counter(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The id of the counter. (required)

Returns:

CounterEntity If the method is called asynchronously, returns the request thread.

update_counter_with_http_info(id, **kwargs)

Updates the specified counter. This will reset the counter value to 0 Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_counter_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The id of the counter. (required)

Returns:

CounterEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.data_transfer_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.data_transfer_api.DataTransferApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

commit_input_port_transaction(response_code, port_id, transaction_id, **kwargs)

Commit or cancel the specified transaction

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.commit_input_port_transaction(response_code, port_id, transaction_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• response_code (int) – The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required)
• port_id (str) – The input port id. (required)
• transaction_id (str) – The transaction id. (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

commit_input_port_transaction_with_http_info(response_code, port_id, transaction_id, **kwargs)

Commit or cancel the specified transaction

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.commit_input_port_transaction_with_http_info(response_code, port_id, transaction_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• response_code (int) – The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required)
• port_id (str) – The input port id. (required)
• transaction_id (str) – The transaction id. (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

commit_output_port_transaction(response_code, checksum, port_id, transaction_id, **kwargs)

Commit or cancel the specified transaction

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.commit_output_port_transaction(response_code, checksum, port_id, transaction_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• response_code (int) – The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required)
• checksum (str) – A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side. (required)
• port_id (str) – The output port id. (required)
• transaction_id (str) – The transaction id. (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

commit_output_port_transaction_with_http_info(response_code, checksum, port_id, transaction_id, **kwargs)

Commit or cancel the specified transaction

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.commit_output_port_transaction_with_http_info(response_code, checksum, port_id, transaction_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• response_code (int) – The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required)
• checksum (str) – A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side. (required)
• port_id (str) – The output port id. (required)
• transaction_id (str) – The transaction id. (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

create_port_transaction(port_type, port_id, **kwargs)

Create a transaction to the specified output port or input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_port_transaction(port_type, port_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• port_type (str) – The port type. (required)
• port_id (str) – (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

create_port_transaction_with_http_info(port_type, port_id, **kwargs)

Create a transaction to the specified output port or input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_port_transaction_with_http_info(port_type, port_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• port_type (str) – The port type. (required)
• port_id (str) – (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

extend_input_port_transaction_ttl(port_id, transaction_id, **kwargs)

Extend transaction TTL

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.extend_input_port_transaction_ttl(port_id, transaction_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• port_id (str) – (required)
• transaction_id (str) – (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

extend_input_port_transaction_ttl_with_http_info(port_id, transaction_id, **kwargs)

Extend transaction TTL

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.extend_input_port_transaction_ttl_with_http_info(port_id, transaction_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• port_id (str) – (required)
• transaction_id (str) – (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

extend_output_port_transaction_ttl(port_id, transaction_id, **kwargs)

Extend transaction TTL

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.extend_output_port_transaction_ttl(port_id, transaction_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• port_id (str) – (required)
• transaction_id (str) – (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

extend_output_port_transaction_ttl_with_http_info(port_id, transaction_id, **kwargs)

Extend transaction TTL

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.extend_output_port_transaction_ttl_with_http_info(port_id, transaction_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• port_id (str) – (required)
• transaction_id (str) – (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

receive_flow_files(port_id, transaction_id, **kwargs)

Transfer flow files to the input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.receive_flow_files(port_id, transaction_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• port_id (str) – The input port id. (required)
• transaction_id (str) – (required)

Returns:

str If the method is called asynchronously, returns the request thread.

receive_flow_files_with_http_info(port_id, transaction_id, **kwargs)

Transfer flow files to the input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.receive_flow_files_with_http_info(port_id, transaction_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• port_id (str) – The input port id. (required)
• transaction_id (str) – (required)

Returns:

str If the method is called asynchronously, returns the request thread.

transfer_flow_files(port_id, transaction_id, **kwargs)

Transfer flow files from the output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.transfer_flow_files(port_id, transaction_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• port_id (str) – The output port id. (required)
• transaction_id (str) – (required)

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

transfer_flow_files_with_http_info(port_id, transaction_id, **kwargs)

Transfer flow files from the output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.transfer_flow_files_with_http_info(port_id, transaction_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• port_id (str) – The output port id. (required)
• transaction_id (str) – (required)

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.flow_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.flow_api.FlowApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

activate_controller_services(id, body, **kwargs)

Enable or disable Controller Services in the specified Process Group.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.activate_controller_services(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ActivateControllerServicesEntity) – The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required)

Returns:

ActivateControllerServicesEntity If the method is called asynchronously, returns the request thread.

activate_controller_services_with_http_info(id, body, **kwargs)

Enable or disable Controller Services in the specified Process Group.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.activate_controller_services_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ActivateControllerServicesEntity) – The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required)

Returns:

ActivateControllerServicesEntity If the method is called asynchronously, returns the request thread.

generate_client_id(**kwargs)

Generates a client id.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.generate_client_id(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

generate_client_id_with_http_info(**kwargs)

Generates a client id.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.generate_client_id_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

get_about_info(**kwargs)

Retrieves details about this NiFi to put in the About dialog

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_about_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:AboutEntity If the method is called asynchronously, returns the request thread.

get_about_info_with_http_info(**kwargs)

Retrieves details about this NiFi to put in the About dialog

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_about_info_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:AboutEntity If the method is called asynchronously, returns the request thread.

get_action(id, **kwargs)

Gets an action Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_action(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The action id. (required)

Returns:

ActionEntity If the method is called asynchronously, returns the request thread.

get_action_with_http_info(id, **kwargs)

Gets an action Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_action_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The action id. (required)

Returns:

ActionEntity If the method is called asynchronously, returns the request thread.

get_banners(**kwargs)

Retrieves the banners for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_banners(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:BannerEntity If the method is called asynchronously, returns the request thread.

get_banners_with_http_info(**kwargs)

Retrieves the banners for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_banners_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:BannerEntity If the method is called asynchronously, returns the request thread.

get_buckets(id, **kwargs)

Gets the buckets from the specified registry for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_buckets(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The registry id. (required)

Returns:

BucketsEntity If the method is called asynchronously, returns the request thread.

get_buckets_with_http_info(id, **kwargs)

Gets the buckets from the specified registry for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_buckets_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The registry id. (required)

Returns:

BucketsEntity If the method is called asynchronously, returns the request thread.

get_bulletin_board(**kwargs)

Gets current bulletins

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_bulletin_board(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• after (str) – Includes bulletins with an id after this value.
• source_name (str) – Includes bulletins originating from this sources whose name match this regular expression.
• message (str) – Includes bulletins whose message that match this regular expression.
• source_id (str) – Includes bulletins originating from this sources whose id match this regular expression.
• group_id (str) – Includes bulletins originating from this sources whose group id match this regular expression.
• limit (str) – The number of bulletins to limit the response to.

Returns:

BulletinBoardEntity If the method is called asynchronously, returns the request thread.

get_bulletin_board_with_http_info(**kwargs)

Gets current bulletins

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_bulletin_board_with_http_info(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• after (str) – Includes bulletins with an id after this value.
• source_name (str) – Includes bulletins originating from this sources whose name match this regular expression.
• message (str) – Includes bulletins whose message that match this regular expression.
• source_id (str) – Includes bulletins originating from this sources whose id match this regular expression.
• group_id (str) – Includes bulletins originating from this sources whose group id match this regular expression.
• limit (str) – The number of bulletins to limit the response to.

Returns:

BulletinBoardEntity If the method is called asynchronously, returns the request thread.

get_bulletins(**kwargs)

Retrieves Controller level bulletins

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_bulletins(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ControllerBulletinsEntity If the method is called asynchronously, returns the request thread.

get_bulletins_with_http_info(**kwargs)

Retrieves Controller level bulletins

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_bulletins_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ControllerBulletinsEntity If the method is called asynchronously, returns the request thread.

get_cluster_summary(**kwargs)

The cluster summary for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_cluster_summary(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ClusteSummaryEntity If the method is called asynchronously, returns the request thread.

get_cluster_summary_with_http_info(**kwargs)

The cluster summary for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_cluster_summary_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ClusteSummaryEntity If the method is called asynchronously, returns the request thread.

get_component_history(component_id, **kwargs)

Gets configuration history for a component Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_component_history(component_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• component_id (str) – The component id. (required)

Returns:

ComponentHistoryEntity If the method is called asynchronously, returns the request thread.

get_component_history_with_http_info(component_id, **kwargs)

Gets configuration history for a component Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_component_history_with_http_info(component_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• component_id (str) – The component id. (required)

Returns:

ComponentHistoryEntity If the method is called asynchronously, returns the request thread.

get_connection_statistics(id, **kwargs)

Gets statistics for a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_statistics(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the statistics.

Returns:

ConnectionStatisticsEntity If the method is called asynchronously, returns the request thread.

get_connection_statistics_with_http_info(id, **kwargs)

Gets statistics for a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_statistics_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the statistics.

Returns:

ConnectionStatisticsEntity If the method is called asynchronously, returns the request thread.

get_connection_status(id, **kwargs)

Gets status for a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_status(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

ConnectionStatusEntity If the method is called asynchronously, returns the request thread.

get_connection_status_history(id, **kwargs)

Gets the status history for a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_status_history(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_connection_status_history_with_http_info(id, **kwargs)

Gets the status history for a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_status_history_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_connection_status_with_http_info(id, **kwargs)

Gets status for a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_status_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

ConnectionStatusEntity If the method is called asynchronously, returns the request thread.

get_controller_service_types(**kwargs)

Retrieves the types of controller services that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_service_types(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• service_type (str) – If specified, will only return controller services that are compatible with this type of service.
• service_bundle_group (str) – If serviceType specified, is the bundle group of the serviceType.
• service_bundle_artifact (str) – If serviceType specified, is the bundle artifact of the serviceType.
• service_bundle_version (str) – If serviceType specified, is the bundle version of the serviceType.
• bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
• bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
• type_filter (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ControllerServiceTypesEntity If the method is called asynchronously, returns the request thread.

get_controller_service_types_with_http_info(**kwargs)

Retrieves the types of controller services that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_service_types_with_http_info(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• service_type (str) – If specified, will only return controller services that are compatible with this type of service.
• service_bundle_group (str) – If serviceType specified, is the bundle group of the serviceType.
• service_bundle_artifact (str) – If serviceType specified, is the bundle artifact of the serviceType.
• service_bundle_version (str) – If serviceType specified, is the bundle version of the serviceType.
• bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
• bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
• type_filter (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ControllerServiceTypesEntity If the method is called asynchronously, returns the request thread.

get_controller_services_from_controller(**kwargs)

Gets controller services for reporting tasks If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_services_from_controller(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• ui_only (bool) –

Returns:

ControllerServicesEntity If the method is called asynchronously, returns the request thread.

get_controller_services_from_controller_with_http_info(**kwargs)

Gets controller services for reporting tasks If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_services_from_controller_with_http_info(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• ui_only (bool) –

Returns:

ControllerServicesEntity If the method is called asynchronously, returns the request thread.

get_controller_services_from_group(id, **kwargs)

Gets all controller services If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_services_from_group(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• include_ancestor_groups (bool) – Whether or not to include parent/ancestory process groups
• include_descendant_groups (bool) – Whether or not to include descendant process groups
• ui_only (bool) –

Returns:

ControllerServicesEntity If the method is called asynchronously, returns the request thread.

get_controller_services_from_group_with_http_info(id, **kwargs)

Gets all controller services If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_services_from_group_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• include_ancestor_groups (bool) – Whether or not to include parent/ancestory process groups
• include_descendant_groups (bool) – Whether or not to include descendant process groups
• ui_only (bool) –

Returns:

ControllerServicesEntity If the method is called asynchronously, returns the request thread.

get_controller_status(**kwargs)

Gets the current status of this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_status(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ControllerStatusEntity If the method is called asynchronously, returns the request thread.

get_controller_status_with_http_info(**kwargs)

Gets the current status of this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_status_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ControllerStatusEntity If the method is called asynchronously, returns the request thread.

get_current_user(**kwargs)

Retrieves the user identity of the user making the request

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_current_user(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:CurrentUserEntity If the method is called asynchronously, returns the request thread.

get_current_user_with_http_info(**kwargs)

Retrieves the user identity of the user making the request

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_current_user_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:CurrentUserEntity If the method is called asynchronously, returns the request thread.

get_flow(id, **kwargs)

Gets a process group If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• ui_only (bool) –

Returns:

ProcessGroupFlowEntity If the method is called asynchronously, returns the request thread.

get_flow_config(**kwargs)

Retrieves the configuration for this NiFi flow

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_config(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:FlowConfigurationEntity If the method is called asynchronously, returns the request thread.

get_flow_config_with_http_info(**kwargs)

Retrieves the configuration for this NiFi flow

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_config_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:FlowConfigurationEntity If the method is called asynchronously, returns the request thread.

get_flow_metrics(producer, **kwargs)

Gets all metrics for the flow from a particular node

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_metrics(producer, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• producer (str) – The producer for flow file metrics. Each producer may have its own output format. (required)
• included_registries (list[str]) – Set of included metrics registries
• sample_name (str) – Regular Expression Pattern to be applied against the sample name field
• sample_label_value (str) – Regular Expression Pattern to be applied against the sample label value field
• root_field_name (str) – Name of the first field of JSON object. Applicable for JSON producer only.

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

get_flow_metrics_with_http_info(producer, **kwargs)

Gets all metrics for the flow from a particular node

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_metrics_with_http_info(producer, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• producer (str) – The producer for flow file metrics. Each producer may have its own output format. (required)
• included_registries (list[str]) – Set of included metrics registries
• sample_name (str) – Regular Expression Pattern to be applied against the sample name field
• sample_label_value (str) – Regular Expression Pattern to be applied against the sample label value field
• root_field_name (str) – Name of the first field of JSON object. Applicable for JSON producer only.

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

get_flow_with_http_info(id, **kwargs)

Gets a process group If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• ui_only (bool) –

Returns:

ProcessGroupFlowEntity If the method is called asynchronously, returns the request thread.

get_flows(registry_id, bucket_id, **kwargs)

Gets the flows from the specified registry and bucket for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flows(registry_id, bucket_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• registry_id (str) – The registry id. (required)
• bucket_id (str) – The bucket id. (required)

Returns:

VersionedFlowsEntity If the method is called asynchronously, returns the request thread.

get_flows_with_http_info(registry_id, bucket_id, **kwargs)

Gets the flows from the specified registry and bucket for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flows_with_http_info(registry_id, bucket_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• registry_id (str) – The registry id. (required)
• bucket_id (str) – The bucket id. (required)

Returns:

VersionedFlowsEntity If the method is called asynchronously, returns the request thread.

get_input_port_status(id, **kwargs)

Gets status for an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_port_status(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The input port id. (required)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

PortStatusEntity If the method is called asynchronously, returns the request thread.

get_input_port_status_with_http_info(id, **kwargs)

Gets status for an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_port_status_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The input port id. (required)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

PortStatusEntity If the method is called asynchronously, returns the request thread.

get_output_port_status(id, **kwargs)

Gets status for an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_port_status(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The output port id. (required)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

PortStatusEntity If the method is called asynchronously, returns the request thread.

get_output_port_status_with_http_info(id, **kwargs)

Gets status for an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_port_status_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The output port id. (required)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

PortStatusEntity If the method is called asynchronously, returns the request thread.

get_parameter_contexts(**kwargs)

Gets all Parameter Contexts

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_contexts(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ParameterContextsEntity If the method is called asynchronously, returns the request thread.

get_parameter_contexts_with_http_info(**kwargs)

Gets all Parameter Contexts

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_contexts_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ParameterContextsEntity If the method is called asynchronously, returns the request thread.

get_prioritizers(**kwargs)

Retrieves the types of prioritizers that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_prioritizers(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:PrioritizerTypesEntity If the method is called asynchronously, returns the request thread.

get_prioritizers_with_http_info(**kwargs)

Retrieves the types of prioritizers that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_prioritizers_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:PrioritizerTypesEntity If the method is called asynchronously, returns the request thread.

get_process_group_status(id, **kwargs)

Gets the status for a process group The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_group_status(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• recursive (bool) – Whether all descendant groups and the status of their content will be included. Optional, defaults to false
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

ProcessGroupStatusEntity If the method is called asynchronously, returns the request thread.

get_process_group_status_history(id, **kwargs)

Gets status history for a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_group_status_history(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_process_group_status_history_with_http_info(id, **kwargs)

Gets status history for a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_group_status_history_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_process_group_status_with_http_info(id, **kwargs)

Gets the status for a process group The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_group_status_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• recursive (bool) – Whether all descendant groups and the status of their content will be included. Optional, defaults to false
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

ProcessGroupStatusEntity If the method is called asynchronously, returns the request thread.

get_processor_status(id, **kwargs)

Gets status for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_status(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

ProcessorStatusEntity If the method is called asynchronously, returns the request thread.

get_processor_status_history(id, **kwargs)

Gets status history for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_status_history(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_processor_status_history_with_http_info(id, **kwargs)

Gets status history for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_status_history_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_processor_status_with_http_info(id, **kwargs)

Gets status for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_status_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

ProcessorStatusEntity If the method is called asynchronously, returns the request thread.

get_processor_types(**kwargs)

Retrieves the types of processors that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_types(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
• bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
• type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ProcessorTypesEntity If the method is called asynchronously, returns the request thread.

get_processor_types_with_http_info(**kwargs)

Retrieves the types of processors that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_types_with_http_info(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
• bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
• type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ProcessorTypesEntity If the method is called asynchronously, returns the request thread.

get_registries(**kwargs)

Gets the listing of available registries

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_registries(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:RegistryClientsEntity If the method is called asynchronously, returns the request thread.

get_registries_with_http_info(**kwargs)

Gets the listing of available registries

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_registries_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:RegistryClientsEntity If the method is called asynchronously, returns the request thread.

get_remote_process_group_status(id, **kwargs)

Gets status for a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_group_status(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

RemoteProcessGroupStatusEntity If the method is called asynchronously, returns the request thread.

get_remote_process_group_status_history(id, **kwargs)

Gets the status history

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_group_status_history(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_remote_process_group_status_history_with_http_info(id, **kwargs)

Gets the status history

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_group_status_history_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_remote_process_group_status_with_http_info(id, **kwargs)

Gets status for a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_group_status_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

RemoteProcessGroupStatusEntity If the method is called asynchronously, returns the request thread.

get_reporting_task_types(**kwargs)

Retrieves the types of reporting tasks that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_reporting_task_types(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
• bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
• type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ReportingTaskTypesEntity If the method is called asynchronously, returns the request thread.

get_reporting_task_types_with_http_info(**kwargs)

Retrieves the types of reporting tasks that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_reporting_task_types_with_http_info(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
• bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
• type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ReportingTaskTypesEntity If the method is called asynchronously, returns the request thread.

get_reporting_tasks(**kwargs)

Gets all reporting tasks

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_reporting_tasks(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ReportingTasksEntity If the method is called asynchronously, returns the request thread.

get_reporting_tasks_with_http_info(**kwargs)

Gets all reporting tasks

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_reporting_tasks_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ReportingTasksEntity If the method is called asynchronously, returns the request thread.

get_runtime_manifest(**kwargs)

Retrieves the runtime manifest for this NiFi instance. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_runtime_manifest(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:RuntimeManifestEntity If the method is called asynchronously, returns the request thread.

get_runtime_manifest_with_http_info(**kwargs)

Retrieves the runtime manifest for this NiFi instance. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_runtime_manifest_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:RuntimeManifestEntity If the method is called asynchronously, returns the request thread.

get_templates(**kwargs)

Gets all templates

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_templates(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:TemplatesEntity If the method is called asynchronously, returns the request thread.

get_templates_with_http_info(**kwargs)

Gets all templates

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_templates_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:TemplatesEntity If the method is called asynchronously, returns the request thread.

get_versions(registry_id, bucket_id, flow_id, **kwargs)

Gets the flow versions from the specified registry and bucket for the specified flow for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_versions(registry_id, bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• registry_id (str) – The registry id. (required)
• bucket_id (str) – The bucket id. (required)
• flow_id (str) – The flow id. (required)

Returns:

VersionedFlowSnapshotMetadataSetEntity If the method is called asynchronously, returns the request thread.

get_versions_with_http_info(registry_id, bucket_id, flow_id, **kwargs)

Gets the flow versions from the specified registry and bucket for the specified flow for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_versions_with_http_info(registry_id, bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• registry_id (str) – The registry id. (required)
• bucket_id (str) – The bucket id. (required)
• flow_id (str) – The flow id. (required)

Returns:

VersionedFlowSnapshotMetadataSetEntity If the method is called asynchronously, returns the request thread.

query_history(offset, count, **kwargs)

Gets configuration history Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.query_history(offset, count, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• offset (str) – The offset into the result set. (required)
• count (str) – The number of actions to return. (required)
• sort_column (str) – The field to sort on.
• sort_order (str) – The direction to sort.
• start_date (str) – Include actions after this date.
• end_date (str) – Include actions before this date.
• user_identity (str) – Include actions performed by this user.
• source_id (str) – Include actions on this component.

Returns:

HistoryEntity If the method is called asynchronously, returns the request thread.

query_history_with_http_info(offset, count, **kwargs)

Gets configuration history Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.query_history_with_http_info(offset, count, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• offset (str) – The offset into the result set. (required)
• count (str) – The number of actions to return. (required)
• sort_column (str) – The field to sort on.
• sort_order (str) – The direction to sort.
• start_date (str) – Include actions after this date.
• end_date (str) – Include actions before this date.
• user_identity (str) – Include actions performed by this user.
• source_id (str) – Include actions on this component.

Returns:

HistoryEntity If the method is called asynchronously, returns the request thread.

schedule_components(id, body, **kwargs)

Schedule or unschedule components in the specified Process Group.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.schedule_components(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ScheduleComponentsEntity) – The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required)

Returns:

ScheduleComponentsEntity If the method is called asynchronously, returns the request thread.

schedule_components_with_http_info(id, body, **kwargs)

Schedule or unschedule components in the specified Process Group.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.schedule_components_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ScheduleComponentsEntity) – The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required)

Returns:

ScheduleComponentsEntity If the method is called asynchronously, returns the request thread.

search_cluster(q, **kwargs)

Searches the cluster for a node with the specified address Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.search_cluster(q, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• q (str) – Node address to search for. (required)

Returns:

ClusterSearchResultsEntity If the method is called asynchronously, returns the request thread.

search_cluster_with_http_info(q, **kwargs)

Searches the cluster for a node with the specified address Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.search_cluster_with_http_info(q, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• q (str) – Node address to search for. (required)

Returns:

ClusterSearchResultsEntity If the method is called asynchronously, returns the request thread.

search_flow(**kwargs)

Performs a search against this NiFi using the specified search term Only search results from authorized components will be returned. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.search_flow(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• q (str) –
• a (str) –

Returns:

SearchResultsEntity If the method is called asynchronously, returns the request thread.

search_flow_with_http_info(**kwargs)

Performs a search against this NiFi using the specified search term Only search results from authorized components will be returned. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.search_flow_with_http_info(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• q (str) –
• a (str) –

Returns:

SearchResultsEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.flowfile_queues_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.flowfile_queues_api.FlowfileQueuesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

create_drop_request(id, **kwargs)

Creates a request to drop the contents of the queue in this connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_drop_request(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

create_drop_request_with_http_info(id, **kwargs)

Creates a request to drop the contents of the queue in this connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_drop_request_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

create_flow_file_listing(id, **kwargs)

Lists the contents of the queue in this connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow_file_listing(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)

Returns:

ListingRequestEntity If the method is called asynchronously, returns the request thread.

create_flow_file_listing_with_http_info(id, **kwargs)

Lists the contents of the queue in this connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow_file_listing_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)

Returns:

ListingRequestEntity If the method is called asynchronously, returns the request thread.

delete_listing_request(id, listing_request_id, **kwargs)

Cancels and/or removes a request to list the contents of this connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_listing_request(id, listing_request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• listing_request_id (str) – The listing request id. (required)

Returns:

ListingRequestEntity If the method is called asynchronously, returns the request thread.

delete_listing_request_with_http_info(id, listing_request_id, **kwargs)

Cancels and/or removes a request to list the contents of this connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_listing_request_with_http_info(id, listing_request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• listing_request_id (str) – The listing request id. (required)

Returns:

ListingRequestEntity If the method is called asynchronously, returns the request thread.

download_flow_file_content(id, flowfile_uuid, **kwargs)

Gets the content for a FlowFile in a Connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.download_flow_file_content(id, flowfile_uuid, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• flowfile_uuid (str) – The flowfile uuid. (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• cluster_node_id (str) – The id of the node where the content exists if clustered.

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

download_flow_file_content_with_http_info(id, flowfile_uuid, **kwargs)

Gets the content for a FlowFile in a Connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.download_flow_file_content_with_http_info(id, flowfile_uuid, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• flowfile_uuid (str) – The flowfile uuid. (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• cluster_node_id (str) – The id of the node where the content exists if clustered.

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

get_drop_request(id, drop_request_id, **kwargs)

Gets the current status of a drop request for the specified connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_drop_request(id, drop_request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• drop_request_id (str) – The drop request id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

get_drop_request_with_http_info(id, drop_request_id, **kwargs)

Gets the current status of a drop request for the specified connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_drop_request_with_http_info(id, drop_request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• drop_request_id (str) – The drop request id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

get_flow_file(id, flowfile_uuid, **kwargs)

Gets a FlowFile from a Connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_file(id, flowfile_uuid, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• flowfile_uuid (str) – The flowfile uuid. (required)
• cluster_node_id (str) – The id of the node where the content exists if clustered.

Returns:

FlowFileEntity If the method is called asynchronously, returns the request thread.

get_flow_file_with_http_info(id, flowfile_uuid, **kwargs)

Gets a FlowFile from a Connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_file_with_http_info(id, flowfile_uuid, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• flowfile_uuid (str) – The flowfile uuid. (required)
• cluster_node_id (str) – The id of the node where the content exists if clustered.

Returns:

FlowFileEntity If the method is called asynchronously, returns the request thread.

get_listing_request(id, listing_request_id, **kwargs)

Gets the current status of a listing request for the specified connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_listing_request(id, listing_request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• listing_request_id (str) – The listing request id. (required)

Returns:

ListingRequestEntity If the method is called asynchronously, returns the request thread.

get_listing_request_with_http_info(id, listing_request_id, **kwargs)

Gets the current status of a listing request for the specified connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_listing_request_with_http_info(id, listing_request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• listing_request_id (str) – The listing request id. (required)

Returns:

ListingRequestEntity If the method is called asynchronously, returns the request thread.

remove_drop_request(id, drop_request_id, **kwargs)

Cancels and/or removes a request to drop the contents of this connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_drop_request(id, drop_request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• drop_request_id (str) – The drop request id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

remove_drop_request_with_http_info(id, drop_request_id, **kwargs)

Cancels and/or removes a request to drop the contents of this connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_drop_request_with_http_info(id, drop_request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The connection id. (required)
• drop_request_id (str) – The drop request id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.funnel_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.funnel_api.FunnelApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

get_funnel(id, **kwargs)

Gets a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_funnel(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The funnel id. (required)

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

get_funnel_with_http_info(id, **kwargs)

Gets a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_funnel_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The funnel id. (required)

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

remove_funnel(id, **kwargs)

Deletes a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_funnel(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The funnel id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

remove_funnel_with_http_info(id, **kwargs)

Deletes a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_funnel_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The funnel id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

update_funnel(id, body, **kwargs)

Updates a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_funnel(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The funnel id. (required)
• body (FunnelEntity) – The funnel configuration details. (required)

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

update_funnel_with_http_info(id, body, **kwargs)

Updates a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_funnel_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The funnel id. (required)
• body (FunnelEntity) – The funnel configuration details. (required)

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.input_ports_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.input_ports_api.InputPortsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

get_input_port(id, **kwargs)

Gets an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_port(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The input port id. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

get_input_port_with_http_info(id, **kwargs)

Gets an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_port_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The input port id. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

remove_input_port(id, **kwargs)

Deletes an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_input_port(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The input port id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

remove_input_port_with_http_info(id, **kwargs)

Deletes an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_input_port_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The input port id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

update_input_port(id, body, **kwargs)

Updates an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_input_port(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The input port id. (required)
• body (PortEntity) – The input port configuration details. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

update_input_port_with_http_info(id, body, **kwargs)

Updates an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_input_port_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The input port id. (required)
• body (PortEntity) – The input port configuration details. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

update_run_status(id, body, **kwargs)

Updates run status of an input-port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The port id. (required)
• body (PortRunStatusEntity) – The port run status. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

update_run_status_with_http_info(id, body, **kwargs)

Updates run status of an input-port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The port id. (required)
• body (PortRunStatusEntity) – The port run status. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.labels_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.labels_api.LabelsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

get_label(id, **kwargs)

Gets a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_label(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The label id. (required)

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

get_label_with_http_info(id, **kwargs)

Gets a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_label_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The label id. (required)

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

remove_label(id, **kwargs)

Deletes a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_label(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The label id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

remove_label_with_http_info(id, **kwargs)

Deletes a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_label_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The label id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

update_label(id, body, **kwargs)

Updates a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_label(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The label id. (required)
• body (LabelEntity) – The label configuration details. (required)

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

update_label_with_http_info(id, body, **kwargs)

Updates a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_label_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The label id. (required)
• body (LabelEntity) – The label configuration details. (required)

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.output_ports_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.output_ports_api.OutputPortsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

get_output_port(id, **kwargs)

Gets an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_port(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The output port id. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

get_output_port_with_http_info(id, **kwargs)

Gets an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_port_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The output port id. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

remove_output_port(id, **kwargs)

Deletes an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_output_port(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The output port id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

remove_output_port_with_http_info(id, **kwargs)

Deletes an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_output_port_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The output port id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

update_output_port(id, body, **kwargs)

Updates an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_output_port(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The output port id. (required)
• body (PortEntity) – The output port configuration details. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

update_output_port_with_http_info(id, body, **kwargs)

Updates an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_output_port_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The output port id. (required)
• body (PortEntity) – The output port configuration details. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

update_run_status(id, body, **kwargs)

Updates run status of an output-port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The port id. (required)
• body (PortRunStatusEntity) – The port run status. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

update_run_status_with_http_info(id, body, **kwargs)

Updates run status of an output-port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The port id. (required)
• body (PortRunStatusEntity) – The port run status. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.parameter_contexts_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.parameter_contexts_api.ParameterContextsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

create_parameter_context(body, **kwargs)

Create a Parameter Context

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_parameter_context(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (ParameterContextEntity) – The Parameter Context. (required)

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

create_parameter_context_with_http_info(body, **kwargs)

Create a Parameter Context

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_parameter_context_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (ParameterContextEntity) – The Parameter Context. (required)

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

delete_parameter_context(id, **kwargs)

Deletes the Parameter Context with the given ID Deletes the Parameter Context with the given ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_parameter_context(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The Parameter Context ID. (required)
• version (str) – The version is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

delete_parameter_context_with_http_info(id, **kwargs)

Deletes the Parameter Context with the given ID Deletes the Parameter Context with the given ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_parameter_context_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The Parameter Context ID. (required)
• version (str) – The version is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

delete_update_request(context_id, request_id, **kwargs)

Deletes the Update Request with the given ID Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE’ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_update_request(context_id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• context_id (str) – The ID of the ParameterContext (required)
• request_id (str) – The ID of the Update Request (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ParameterContextUpdateRequestEntity If the method is called asynchronously, returns the request thread.

delete_update_request_with_http_info(context_id, request_id, **kwargs)

Deletes the Update Request with the given ID Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE’ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_update_request_with_http_info(context_id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• context_id (str) – The ID of the ParameterContext (required)
• request_id (str) – The ID of the Update Request (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ParameterContextUpdateRequestEntity If the method is called asynchronously, returns the request thread.

delete_validation_request(context_id, id, **kwargs)

Deletes the Validation Request with the given ID Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE’ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_validation_request(context_id, id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• context_id (str) – The ID of the Parameter Context (required)
• id (str) – The ID of the Update Request (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ParameterContextValidationRequestEntity If the method is called asynchronously, returns the request thread.

delete_validation_request_with_http_info(context_id, id, **kwargs)

Deletes the Validation Request with the given ID Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE’ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_validation_request_with_http_info(context_id, id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• context_id (str) – The ID of the Parameter Context (required)
• id (str) – The ID of the Update Request (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ParameterContextValidationRequestEntity If the method is called asynchronously, returns the request thread.

get_parameter_context(id, **kwargs)

Returns the Parameter Context with the given ID Returns the Parameter Context with the given ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_context(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Parameter Context (required)
• include_inherited_parameters (bool) – Whether or not to include inherited parameters from other parameter contexts, and therefore also overridden values. If true, the result will be the ‘effective’ parameter context.

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

get_parameter_context_update(context_id, request_id, **kwargs)

Returns the Update Request with the given ID Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_context_update(context_id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• context_id (str) – The ID of the Parameter Context (required)
• request_id (str) – The ID of the Update Request (required)

Returns:

ParameterContextUpdateRequestEntity If the method is called asynchronously, returns the request thread.

get_parameter_context_update_with_http_info(context_id, request_id, **kwargs)

Returns the Update Request with the given ID Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_context_update_with_http_info(context_id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• context_id (str) – The ID of the Parameter Context (required)
• request_id (str) – The ID of the Update Request (required)

Returns:

ParameterContextUpdateRequestEntity If the method is called asynchronously, returns the request thread.

get_parameter_context_with_http_info(id, **kwargs)

Returns the Parameter Context with the given ID Returns the Parameter Context with the given ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_context_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Parameter Context (required)
• include_inherited_parameters (bool) – Whether or not to include inherited parameters from other parameter contexts, and therefore also overridden values. If true, the result will be the ‘effective’ parameter context.

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

get_validation_request(context_id, id, **kwargs)

Returns the Validation Request with the given ID Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_validation_request(context_id, id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• context_id (str) – The ID of the Parameter Context (required)
• id (str) – The ID of the Validation Request (required)

Returns:

ParameterContextValidationRequestEntity If the method is called asynchronously, returns the request thread.

get_validation_request_with_http_info(context_id, id, **kwargs)

Returns the Validation Request with the given ID Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_validation_request_with_http_info(context_id, id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• context_id (str) – The ID of the Parameter Context (required)
• id (str) – The ID of the Validation Request (required)

Returns:

ParameterContextValidationRequestEntity If the method is called asynchronously, returns the request thread.

submit_parameter_context_update(context_id, body, **kwargs)

Initiate the Update Request of a Parameter Context This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_parameter_context_update(context_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• context_id (str) – (required)
• body (ParameterContextEntity) – The updated version of the parameter context. (required)

Returns:

ParameterContextUpdateRequestEntity If the method is called asynchronously, returns the request thread.

submit_parameter_context_update_with_http_info(context_id, body, **kwargs)

Initiate the Update Request of a Parameter Context This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_parameter_context_update_with_http_info(context_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• context_id (str) – (required)
• body (ParameterContextEntity) – The updated version of the parameter context. (required)

Returns:

ParameterContextUpdateRequestEntity If the method is called asynchronously, returns the request thread.

submit_validation_request(context_id, body, **kwargs)

Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_validation_request(context_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• context_id (str) – (required)
• body (ParameterContextValidationRequestEntity) – The validation request (required)

Returns:

ParameterContextValidationRequestEntity If the method is called asynchronously, returns the request thread.

submit_validation_request_with_http_info(context_id, body, **kwargs)

Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_validation_request_with_http_info(context_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• context_id (str) – (required)
• body (ParameterContextValidationRequestEntity) – The validation request (required)

Returns:

ParameterContextValidationRequestEntity If the method is called asynchronously, returns the request thread.

update_parameter_context(id, body, **kwargs)

Modifies a Parameter Context This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_parameter_context(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – (required)
• body (ParameterContextEntity) – The updated Parameter Context (required)

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

update_parameter_context_with_http_info(id, body, **kwargs)

Modifies a Parameter Context This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_parameter_context_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – (required)
• body (ParameterContextEntity) – The updated Parameter Context (required)

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.policies_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.policies_api.PoliciesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

create_access_policy(body, **kwargs)

Creates an access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_policy(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (AccessPolicyEntity) – The access policy configuration details. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

create_access_policy_with_http_info(body, **kwargs)

Creates an access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_policy_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (AccessPolicyEntity) – The access policy configuration details. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

get_access_policy(id, **kwargs)

Gets an access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The access policy id. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

get_access_policy_for_resource(action, resource, **kwargs)

Gets an access policy for the specified action and resource Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy_for_resource(action, resource, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• action (str) – The request action. (required)
• resource (str) – The resource of the policy. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

get_access_policy_for_resource_with_http_info(action, resource, **kwargs)

Gets an access policy for the specified action and resource Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy_for_resource_with_http_info(action, resource, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• action (str) – The request action. (required)
• resource (str) – The resource of the policy. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

get_access_policy_with_http_info(id, **kwargs)

Gets an access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The access policy id. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

remove_access_policy(id, **kwargs)

Deletes an access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_access_policy(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The access policy id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

remove_access_policy_with_http_info(id, **kwargs)

Deletes an access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_access_policy_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The access policy id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

update_access_policy(id, body, **kwargs)

Updates a access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_access_policy(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The access policy id. (required)
• body (AccessPolicyEntity) – The access policy configuration details. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

update_access_policy_with_http_info(id, body, **kwargs)

Updates a access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_access_policy_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The access policy id. (required)
• body (AccessPolicyEntity) – The access policy configuration details. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.process_groups_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.process_groups_api.ProcessGroupsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

copy_snippet(id, body, **kwargs)

Copies a snippet and discards it.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.copy_snippet(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (CopySnippetRequestEntity) – The copy snippet request. (required)

Returns:

FlowEntity If the method is called asynchronously, returns the request thread.

copy_snippet_with_http_info(id, body, **kwargs)

Copies a snippet and discards it.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.copy_snippet_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (CopySnippetRequestEntity) – The copy snippet request. (required)

Returns:

FlowEntity If the method is called asynchronously, returns the request thread.

create_connection(id, body, **kwargs)

Creates a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_connection(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ConnectionEntity) – The connection configuration details. (required)

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

create_connection_with_http_info(id, body, **kwargs)

Creates a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_connection_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ConnectionEntity) – The connection configuration details. (required)

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

create_controller_service(id, body, **kwargs)

Creates a new controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_controller_service(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ControllerServiceEntity) – The controller service configuration details. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

create_controller_service_with_http_info(id, body, **kwargs)

Creates a new controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_controller_service_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ControllerServiceEntity) – The controller service configuration details. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

create_empty_all_connections_request(id, **kwargs)

Creates a request to drop all flowfiles of all connection queues in this process group.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_empty_all_connections_request(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

create_empty_all_connections_request_with_http_info(id, **kwargs)

Creates a request to drop all flowfiles of all connection queues in this process group.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_empty_all_connections_request_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

create_funnel(id, body, **kwargs)

Creates a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_funnel(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (FunnelEntity) – The funnel configuration details. (required)

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

create_funnel_with_http_info(id, body, **kwargs)

Creates a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_funnel_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (FunnelEntity) – The funnel configuration details. (required)

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

create_input_port(id, body, **kwargs)

Creates an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_input_port(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (PortEntity) – The input port configuration details. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

create_input_port_with_http_info(id, body, **kwargs)

Creates an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_input_port_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (PortEntity) – The input port configuration details. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

create_label(id, body, **kwargs)

Creates a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_label(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (LabelEntity) – The label configuration details. (required)

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

create_label_with_http_info(id, body, **kwargs)

Creates a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_label_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (LabelEntity) – The label configuration details. (required)

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

create_output_port(id, body, **kwargs)

Creates an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_output_port(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (PortEntity) – The output port configuration. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

create_output_port_with_http_info(id, body, **kwargs)

Creates an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_output_port_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (PortEntity) – The output port configuration. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

create_process_group(id, body, **kwargs)

Creates a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_process_group(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ProcessGroupEntity) – The process group configuration details. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

create_process_group_with_http_info(id, body, **kwargs)

Creates a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_process_group_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ProcessGroupEntity) – The process group configuration details. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

create_processor(id, body, **kwargs)

Creates a new processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_processor(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ProcessorEntity) – The processor configuration details. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

create_processor_with_http_info(id, body, **kwargs)

Creates a new processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_processor_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ProcessorEntity) – The processor configuration details. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

create_remote_process_group(id, body, **kwargs)

Creates a new process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_remote_process_group(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (RemoteProcessGroupEntity) – The remote process group configuration details. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

create_remote_process_group_with_http_info(id, body, **kwargs)

Creates a new process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_remote_process_group_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (RemoteProcessGroupEntity) – The remote process group configuration details. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

create_template(id, body, **kwargs)

Creates a template and discards the specified snippet.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_template(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (CreateTemplateRequestEntity) – The create template request. (required)

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

create_template_with_http_info(id, body, **kwargs)

Creates a template and discards the specified snippet.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_template_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (CreateTemplateRequestEntity) – The create template request. (required)

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

delete_replace_process_group_request(id, **kwargs)

Deletes the Replace Request with the given ID Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE’ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_replace_process_group_request(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Update Request (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessGroupReplaceRequestEntity If the method is called asynchronously, returns the request thread.

delete_replace_process_group_request_with_http_info(id, **kwargs)

Deletes the Replace Request with the given ID Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE’ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_replace_process_group_request_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Update Request (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessGroupReplaceRequestEntity If the method is called asynchronously, returns the request thread.

delete_variable_registry_update_request(group_id, update_id, **kwargs)

Deletes an update request for a process group’s variable registry. If the request is not yet complete, it will automatically be cancelled. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_variable_registry_update_request(group_id, update_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• group_id (str) – The process group id. (required)
• update_id (str) – The ID of the Variable Registry Update Request (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

VariableRegistryUpdateRequestEntity If the method is called asynchronously, returns the request thread.

delete_variable_registry_update_request_with_http_info(group_id, update_id, **kwargs)

Deletes an update request for a process group’s variable registry. If the request is not yet complete, it will automatically be cancelled. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_variable_registry_update_request_with_http_info(group_id, update_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• group_id (str) – The process group id. (required)
• update_id (str) – The ID of the Variable Registry Update Request (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

VariableRegistryUpdateRequestEntity If the method is called asynchronously, returns the request thread.

export_process_group(id, **kwargs)

Gets a process group for download

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.export_process_group(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• include_referenced_services (bool) – If referenced services from outside the target group should be included

Returns:

str If the method is called asynchronously, returns the request thread.

export_process_group_with_http_info(id, **kwargs)

Gets a process group for download

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.export_process_group_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• include_referenced_services (bool) – If referenced services from outside the target group should be included

Returns:

str If the method is called asynchronously, returns the request thread.

get_connections(id, **kwargs)

Gets all connections

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connections(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

ConnectionsEntity If the method is called asynchronously, returns the request thread.

get_connections_with_http_info(id, **kwargs)

Gets all connections

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connections_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

ConnectionsEntity If the method is called asynchronously, returns the request thread.

get_drop_all_flowfiles_request(id, drop_request_id, **kwargs)

Gets the current status of a drop all flowfiles request.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_drop_all_flowfiles_request(id, drop_request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• drop_request_id (str) – The drop request id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

get_drop_all_flowfiles_request_with_http_info(id, drop_request_id, **kwargs)

Gets the current status of a drop all flowfiles request.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_drop_all_flowfiles_request_with_http_info(id, drop_request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• drop_request_id (str) – The drop request id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

get_funnels(id, **kwargs)

Gets all funnels

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_funnels(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

FunnelsEntity If the method is called asynchronously, returns the request thread.

get_funnels_with_http_info(id, **kwargs)

Gets all funnels

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_funnels_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

FunnelsEntity If the method is called asynchronously, returns the request thread.

get_input_ports(id, **kwargs)

Gets all input ports

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_ports(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

InputPortsEntity If the method is called asynchronously, returns the request thread.

get_input_ports_with_http_info(id, **kwargs)

Gets all input ports

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_ports_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

InputPortsEntity If the method is called asynchronously, returns the request thread.

get_labels(id, **kwargs)

Gets all labels

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_labels(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

LabelsEntity If the method is called asynchronously, returns the request thread.

get_labels_with_http_info(id, **kwargs)

Gets all labels

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_labels_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

LabelsEntity If the method is called asynchronously, returns the request thread.

get_local_modifications(id, **kwargs)

Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_local_modifications(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

FlowComparisonEntity If the method is called asynchronously, returns the request thread.

get_local_modifications_with_http_info(id, **kwargs)

Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_local_modifications_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

FlowComparisonEntity If the method is called asynchronously, returns the request thread.

get_output_ports(id, **kwargs)

Gets all output ports

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_ports(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

OutputPortsEntity If the method is called asynchronously, returns the request thread.

get_output_ports_with_http_info(id, **kwargs)

Gets all output ports

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_ports_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

OutputPortsEntity If the method is called asynchronously, returns the request thread.

get_process_group(id, **kwargs)

Gets a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_group(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

get_process_group_with_http_info(id, **kwargs)

Gets a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_group_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

get_process_groups(id, **kwargs)

Gets all process groups

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_groups(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

ProcessGroupsEntity If the method is called asynchronously, returns the request thread.

get_process_groups_with_http_info(id, **kwargs)

Gets all process groups

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_groups_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

ProcessGroupsEntity If the method is called asynchronously, returns the request thread.

get_processors(id, **kwargs)

Gets all processors

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processors(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• include_descendant_groups (bool) – Whether or not to include processors from descendant process groups

Returns:

ProcessorsEntity If the method is called asynchronously, returns the request thread.

get_processors_with_http_info(id, **kwargs)

Gets all processors

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processors_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• include_descendant_groups (bool) – Whether or not to include processors from descendant process groups

Returns:

ProcessorsEntity If the method is called asynchronously, returns the request thread.

get_remote_process_groups(id, **kwargs)

Gets all remote process groups

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_groups(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

RemoteProcessGroupsEntity If the method is called asynchronously, returns the request thread.

get_remote_process_groups_with_http_info(id, **kwargs)

Gets all remote process groups

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_groups_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

RemoteProcessGroupsEntity If the method is called asynchronously, returns the request thread.

get_replace_process_group_request(id, **kwargs)

Returns the Replace Request with the given ID Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_replace_process_group_request(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Replace Request (required)

Returns:

ProcessGroupReplaceRequestEntity If the method is called asynchronously, returns the request thread.

get_replace_process_group_request_with_http_info(id, **kwargs)

Returns the Replace Request with the given ID Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_replace_process_group_request_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Replace Request (required)

Returns:

ProcessGroupReplaceRequestEntity If the method is called asynchronously, returns the request thread.

get_variable_registry(id, **kwargs)

Gets a process group’s variable registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_variable_registry(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• include_ancestor_groups (bool) – Whether or not to include ancestor groups

Returns:

VariableRegistryEntity If the method is called asynchronously, returns the request thread.

get_variable_registry_update_request(group_id, update_id, **kwargs)

Gets a process group’s variable registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_variable_registry_update_request(group_id, update_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• group_id (str) – The process group id. (required)
• update_id (str) – The ID of the Variable Registry Update Request (required)

Returns:

VariableRegistryUpdateRequestEntity If the method is called asynchronously, returns the request thread.

get_variable_registry_update_request_with_http_info(group_id, update_id, **kwargs)

Gets a process group’s variable registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_variable_registry_update_request_with_http_info(group_id, update_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• group_id (str) – The process group id. (required)
• update_id (str) – The ID of the Variable Registry Update Request (required)

Returns:

VariableRegistryUpdateRequestEntity If the method is called asynchronously, returns the request thread.

get_variable_registry_with_http_info(id, **kwargs)

Gets a process group’s variable registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_variable_registry_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• include_ancestor_groups (bool) – Whether or not to include ancestor groups

Returns:

VariableRegistryEntity If the method is called asynchronously, returns the request thread.

import_process_group(id, **kwargs)

Imports a specified process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.import_process_group(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

import_process_group_with_http_info(id, **kwargs)

Imports a specified process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.import_process_group_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

import_template(id, **kwargs)

Imports a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.import_template(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

import_template_with_http_info(id, **kwargs)

Imports a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.import_template_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

initiate_replace_process_group(id, body, **kwargs)

Initiate the Replace Request of a Process Group with the given ID This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.initiate_replace_process_group(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ProcessGroupImportEntity) – The process group replace request entity (required)

Returns:

ProcessGroupReplaceRequestEntity If the method is called asynchronously, returns the request thread.

initiate_replace_process_group_with_http_info(id, body, **kwargs)

Initiate the Replace Request of a Process Group with the given ID This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.initiate_replace_process_group_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ProcessGroupImportEntity) – The process group replace request entity (required)

Returns:

ProcessGroupReplaceRequestEntity If the method is called asynchronously, returns the request thread.

instantiate_template(id, body, **kwargs)

Instantiates a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.instantiate_template(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (InstantiateTemplateRequestEntity) – The instantiate template request. (required)

Returns:

FlowEntity If the method is called asynchronously, returns the request thread.

instantiate_template_with_http_info(id, body, **kwargs)

Instantiates a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.instantiate_template_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (InstantiateTemplateRequestEntity) – The instantiate template request. (required)

Returns:

FlowEntity If the method is called asynchronously, returns the request thread.

remove_drop_request(id, drop_request_id, **kwargs)

Cancels and/or removes a request to drop all flowfiles.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_drop_request(id, drop_request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• drop_request_id (str) – The drop request id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

remove_drop_request_with_http_info(id, drop_request_id, **kwargs)

Cancels and/or removes a request to drop all flowfiles.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_drop_request_with_http_info(id, drop_request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• drop_request_id (str) – The drop request id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

remove_process_group(id, **kwargs)

Deletes a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_process_group(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

remove_process_group_with_http_info(id, **kwargs)

Deletes a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_process_group_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

replace_process_group(id, body, **kwargs)

Replace Process Group contents with the given ID with the specified Process Group contents This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.replace_process_group(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ProcessGroupImportEntity) – The process group replace request entity. (required)

Returns:

ProcessGroupImportEntity If the method is called asynchronously, returns the request thread.

replace_process_group_with_http_info(id, body, **kwargs)

Replace Process Group contents with the given ID with the specified Process Group contents This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.replace_process_group_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ProcessGroupImportEntity) – The process group replace request entity. (required)

Returns:

ProcessGroupImportEntity If the method is called asynchronously, returns the request thread.

submit_update_variable_registry_request(id, body, **kwargs)

Submits a request to update a process group’s variable registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_update_variable_registry_request(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (VariableRegistryEntity) – The variable registry configuration details. (required)

Returns:

VariableRegistryUpdateRequestEntity If the method is called asynchronously, returns the request thread.

submit_update_variable_registry_request_with_http_info(id, body, **kwargs)

Submits a request to update a process group’s variable registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_update_variable_registry_request_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (VariableRegistryEntity) – The variable registry configuration details. (required)

Returns:

VariableRegistryUpdateRequestEntity If the method is called asynchronously, returns the request thread.

update_process_group(id, body, **kwargs)

Updates a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_process_group(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ProcessGroupEntity) – The process group configuration details. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_process_group_with_http_info(id, body, **kwargs)

Updates a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_process_group_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (ProcessGroupEntity) – The process group configuration details. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_variable_registry(id, body, **kwargs)

Updates the contents of a Process Group’s variable Registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_variable_registry(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (VariableRegistryEntity) – The variable registry configuration details. (required)

Returns:

VariableRegistryEntity If the method is called asynchronously, returns the request thread.

update_variable_registry_with_http_info(id, body, **kwargs)

Updates the contents of a Process Group’s variable Registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_variable_registry_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (VariableRegistryEntity) – The variable registry configuration details. (required)

Returns:

VariableRegistryEntity If the method is called asynchronously, returns the request thread.

upload_process_group(id, body, body2, body3, body4, **kwargs)

Uploads a versioned flow definition and creates a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.upload_process_group(id, body, body2, body3, body4, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (str) – The process group name. (required)
• body2 (float) – The process group X position. (required)
• body3 (float) – The process group Y position. (required)
• body4 (str) – The client id. (required)
• body5 (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

upload_process_group_with_http_info(id, body, body2, body3, body4, **kwargs)

Uploads a versioned flow definition and creates a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.upload_process_group_with_http_info(id, body, body2, body3, body4, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (str) – The process group name. (required)
• body2 (float) – The process group X position. (required)
• body3 (float) – The process group Y position. (required)
• body4 (str) – The client id. (required)
• body5 (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

upload_template(id, template, **kwargs)

Uploads a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.upload_template(id, template, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• template (file) – The binary content of the template file being uploaded. (required)
• body (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

upload_template_with_http_info(id, template, **kwargs)

Uploads a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.upload_template_with_http_info(id, template, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• template (file) – The binary content of the template file being uploaded. (required)
• body (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.processors_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.processors_api.ProcessorsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

analyze_configuration(id, body, **kwargs)

Performs analysis of the component’s configuration, providing information about which attributes are referenced.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.analyze_configuration(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• body (ConfigurationAnalysisEntity) – The processor configuration analysis request. (required)

Returns:

ConfigurationAnalysisEntity If the method is called asynchronously, returns the request thread.

analyze_configuration_with_http_info(id, body, **kwargs)

Performs analysis of the component’s configuration, providing information about which attributes are referenced.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.analyze_configuration_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• body (ConfigurationAnalysisEntity) – The processor configuration analysis request. (required)

Returns:

ConfigurationAnalysisEntity If the method is called asynchronously, returns the request thread.

clear_state(id, **kwargs)

Clears the state for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.clear_state(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

clear_state_with_http_info(id, **kwargs)

Clears the state for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.clear_state_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

delete_processor(id, **kwargs)

Deletes a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_processor(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

delete_processor_with_http_info(id, **kwargs)

Deletes a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_processor_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

delete_verification_request(id, request_id, **kwargs)

Deletes the Verification Request with the given ID Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_verification_request(id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Processor (required)
• request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

delete_verification_request_with_http_info(id, request_id, **kwargs)

Deletes the Verification Request with the given ID Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_verification_request_with_http_info(id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Processor (required)
• request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

get_processor(id, **kwargs)

Gets a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

get_processor_diagnostics(id, **kwargs)

Gets diagnostics information about a processor Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_diagnostics(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

get_processor_diagnostics_with_http_info(id, **kwargs)

Gets diagnostics information about a processor Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_diagnostics_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

get_processor_run_status_details(**kwargs)

Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_run_status_details(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (RunStatusDetailsRequestEntity) – The request for the processors that should be included in the results

Returns:

ProcessorsRunStatusDetailsEntity If the method is called asynchronously, returns the request thread.

get_processor_run_status_details_with_http_info(**kwargs)

Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_run_status_details_with_http_info(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (RunStatusDetailsRequestEntity) – The request for the processors that should be included in the results

Returns:

ProcessorsRunStatusDetailsEntity If the method is called asynchronously, returns the request thread.

get_processor_with_http_info(id, **kwargs)

Gets a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor(id, property_name, **kwargs)

Gets the descriptor for a processor property

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor(id, property_name, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• property_name (str) – The property name. (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor_with_http_info(id, property_name, **kwargs)

Gets the descriptor for a processor property

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor_with_http_info(id, property_name, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• property_name (str) – The property name. (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_state(id, **kwargs)

Gets the state for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_state_with_http_info(id, **kwargs)

Gets the state for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_verification_request(id, request_id, **kwargs)

Returns the Verification Request with the given ID Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_verification_request(id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Processor (required)
• request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

get_verification_request_with_http_info(id, request_id, **kwargs)

Returns the Verification Request with the given ID Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_verification_request_with_http_info(id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Processor (required)
• request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

submit_processor_verification_request(id, body, **kwargs)

Performs verification of the Processor’s configuration This will initiate the process of verifying a given Processor configuration. This may be a long-running task. As a result, this endpoint will immediately return a ProcessorConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /processors/{processorId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /processors/{processorId}/verification-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_processor_verification_request(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• body (VerifyConfigRequestEntity) – The processor configuration verification request. (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

submit_processor_verification_request_with_http_info(id, body, **kwargs)

Performs verification of the Processor’s configuration This will initiate the process of verifying a given Processor configuration. This may be a long-running task. As a result, this endpoint will immediately return a ProcessorConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /processors/{processorId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /processors/{processorId}/verification-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_processor_verification_request_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• body (VerifyConfigRequestEntity) – The processor configuration verification request. (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

terminate_processor(id, **kwargs)

Terminates a processor, essentially “deleting” its threads and any active tasks

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.terminate_processor(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

terminate_processor_with_http_info(id, **kwargs)

Terminates a processor, essentially “deleting” its threads and any active tasks

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.terminate_processor_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

update_processor(id, body, **kwargs)

Updates a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_processor(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• body (ProcessorEntity) – The processor configuration details. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

update_processor_with_http_info(id, body, **kwargs)

Updates a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_processor_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• body (ProcessorEntity) – The processor configuration details. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

update_run_status(id, body, **kwargs)

Updates run status of a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• body (ProcessorRunStatusEntity) – The processor run status. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

update_run_status_with_http_info(id, body, **kwargs)

Updates run status of a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)
• body (ProcessorRunStatusEntity) – The processor run status. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.provenance_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.provenance_api.ProvenanceApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

delete_lineage(id, **kwargs)

Deletes a lineage query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_lineage(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The id of the lineage query. (required)
• cluster_node_id (str) – The id of the node where this query exists if clustered.

Returns:

LineageEntity If the method is called asynchronously, returns the request thread.

delete_lineage_with_http_info(id, **kwargs)

Deletes a lineage query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_lineage_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The id of the lineage query. (required)
• cluster_node_id (str) – The id of the node where this query exists if clustered.

Returns:

LineageEntity If the method is called asynchronously, returns the request thread.

delete_provenance(id, **kwargs)

Deletes a provenance query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_provenance(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The id of the provenance query. (required)
• cluster_node_id (str) – The id of the node where this query exists if clustered.

Returns:

ProvenanceEntity If the method is called asynchronously, returns the request thread.

delete_provenance_with_http_info(id, **kwargs)

Deletes a provenance query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_provenance_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The id of the provenance query. (required)
• cluster_node_id (str) – The id of the node where this query exists if clustered.

Returns:

ProvenanceEntity If the method is called asynchronously, returns the request thread.

get_lineage(id, **kwargs)

Gets a lineage query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_lineage(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The id of the lineage query. (required)
• cluster_node_id (str) – The id of the node where this query exists if clustered.

Returns:

LineageEntity If the method is called asynchronously, returns the request thread.

get_lineage_with_http_info(id, **kwargs)

Gets a lineage query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_lineage_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The id of the lineage query. (required)
• cluster_node_id (str) – The id of the node where this query exists if clustered.

Returns:

LineageEntity If the method is called asynchronously, returns the request thread.

get_provenance(id, **kwargs)

Gets a provenance query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_provenance(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The id of the provenance query. (required)
• cluster_node_id (str) – The id of the node where this query exists if clustered.
• summarize (bool) – Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.
• incremental_results (bool) – Whether or not to summarize provenance events returned. This property is false by default.

Returns:

ProvenanceEntity If the method is called asynchronously, returns the request thread.

get_provenance_with_http_info(id, **kwargs)

Gets a provenance query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_provenance_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The id of the provenance query. (required)
• cluster_node_id (str) – The id of the node where this query exists if clustered.
• summarize (bool) – Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.
• incremental_results (bool) – Whether or not to summarize provenance events returned. This property is false by default.

Returns:

ProvenanceEntity If the method is called asynchronously, returns the request thread.

get_search_options(**kwargs)

Gets the searchable attributes for provenance events

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_search_options(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ProvenanceOptionsEntity If the method is called asynchronously, returns the request thread.

get_search_options_with_http_info(**kwargs)

Gets the searchable attributes for provenance events

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_search_options_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ProvenanceOptionsEntity If the method is called asynchronously, returns the request thread.

submit_lineage_request(body, **kwargs)

Submits a lineage query Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_lineage_request(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (LineageEntity) – The lineage query details. (required)

Returns:

LineageEntity If the method is called asynchronously, returns the request thread.

submit_lineage_request_with_http_info(body, **kwargs)

Submits a lineage query Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_lineage_request_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (LineageEntity) – The lineage query details. (required)

Returns:

LineageEntity If the method is called asynchronously, returns the request thread.

submit_provenance_request(body, **kwargs)

Submits a provenance query Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_provenance_request(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (ProvenanceEntity) – The provenance query details. (required)

Returns:

ProvenanceEntity If the method is called asynchronously, returns the request thread.

submit_provenance_request_with_http_info(body, **kwargs)

Submits a provenance query Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_provenance_request_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (ProvenanceEntity) – The provenance query details. (required)

Returns:

ProvenanceEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.provenance_events_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.provenance_events_api.ProvenanceEventsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

get_input_content(id, **kwargs)

Gets the input content for a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_content(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The provenance event id. (required)
• cluster_node_id (str) – The id of the node where the content exists if clustered.

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

get_input_content_with_http_info(id, **kwargs)

Gets the input content for a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_content_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The provenance event id. (required)
• cluster_node_id (str) – The id of the node where the content exists if clustered.

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

get_output_content(id, **kwargs)

Gets the output content for a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_content(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The provenance event id. (required)
• cluster_node_id (str) – The id of the node where the content exists if clustered.

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

get_output_content_with_http_info(id, **kwargs)

Gets the output content for a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_content_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The provenance event id. (required)
• cluster_node_id (str) – The id of the node where the content exists if clustered.

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

get_provenance_event(id, **kwargs)

Gets a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_provenance_event(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The provenance event id. (required)
• cluster_node_id (str) – The id of the node where this event exists if clustered.

Returns:

ProvenanceEventEntity If the method is called asynchronously, returns the request thread.

get_provenance_event_with_http_info(id, **kwargs)

Gets a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_provenance_event_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The provenance event id. (required)
• cluster_node_id (str) – The id of the node where this event exists if clustered.

Returns:

ProvenanceEventEntity If the method is called asynchronously, returns the request thread.

submit_replay(body, **kwargs)

Replays content from a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_replay(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (SubmitReplayRequestEntity) – The replay request. (required)

Returns:

ProvenanceEventEntity If the method is called asynchronously, returns the request thread.

submit_replay_with_http_info(body, **kwargs)

Replays content from a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_replay_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (SubmitReplayRequestEntity) – The replay request. (required)

Returns:

ProvenanceEventEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.remote_process_groups_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.remote_process_groups_api.RemoteProcessGroupsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

get_remote_process_group(id, **kwargs)

Gets a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_group(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

get_remote_process_group_with_http_info(id, **kwargs)

Gets a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_group_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

get_state(id, **kwargs)

Gets the state for a RemoteProcessGroup

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_state_with_http_info(id, **kwargs)

Gets the state for a RemoteProcessGroup

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The processor id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

remove_remote_process_group(id, **kwargs)

Deletes a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_remote_process_group(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

remove_remote_process_group_with_http_info(id, **kwargs)

Deletes a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_remote_process_group_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group(id, body, **kwargs)

Updates a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• body (RemoteProcessGroupEntity) – The remote process group. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_input_port(id, port_id, body, **kwargs)

Updates a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_input_port(id, port_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• port_id (str) – The remote process group port id. (required)
• body (RemoteProcessGroupPortEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_input_port_run_status(id, port_id, body, **kwargs)

Updates run status of a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_input_port_run_status(id, port_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• port_id (str) – The remote process group port id. (required)
• body (RemotePortRunStatusEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_input_port_run_status_with_http_info(id, port_id, body, **kwargs)

Updates run status of a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_input_port_run_status_with_http_info(id, port_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• port_id (str) – The remote process group port id. (required)
• body (RemotePortRunStatusEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_input_port_with_http_info(id, port_id, body, **kwargs)

Updates a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_input_port_with_http_info(id, port_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• port_id (str) – The remote process group port id. (required)
• body (RemoteProcessGroupPortEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_output_port(id, port_id, body, **kwargs)

Updates a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_output_port(id, port_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• port_id (str) – The remote process group port id. (required)
• body (RemoteProcessGroupPortEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_output_port_run_status(id, port_id, body, **kwargs)

Updates run status of a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_output_port_run_status(id, port_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• port_id (str) – The remote process group port id. (required)
• body (RemotePortRunStatusEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_output_port_run_status_with_http_info(id, port_id, body, **kwargs)

Updates run status of a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_output_port_run_status_with_http_info(id, port_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• port_id (str) – The remote process group port id. (required)
• body (RemotePortRunStatusEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_output_port_with_http_info(id, port_id, body, **kwargs)

Updates a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_output_port_with_http_info(id, port_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• port_id (str) – The remote process group port id. (required)
• body (RemoteProcessGroupPortEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_run_status(id, body, **kwargs)

Updates run status of a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_run_status(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• body (RemotePortRunStatusEntity) – The remote process group run status. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_run_status_with_http_info(id, body, **kwargs)

Updates run status of a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_run_status_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• body (RemotePortRunStatusEntity) – The remote process group run status. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_run_statuses(id, body, **kwargs)

Updates run status of all remote process groups in a process group (recursively)

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_run_statuses(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (RemotePortRunStatusEntity) – The remote process groups run status. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_run_statuses_with_http_info(id, body, **kwargs)

Updates run status of all remote process groups in a process group (recursively)

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_run_statuses_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (RemotePortRunStatusEntity) – The remote process groups run status. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_with_http_info(id, body, **kwargs)

Updates a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The remote process group id. (required)
• body (RemoteProcessGroupEntity) – The remote process group. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.reporting_tasks_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.reporting_tasks_api.ReportingTasksApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

analyze_configuration(id, body, **kwargs)

Performs analysis of the component’s configuration, providing information about which attributes are referenced.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.analyze_configuration(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)
• body (ConfigurationAnalysisEntity) – The configuration analysis request. (required)

Returns:

ConfigurationAnalysisEntity If the method is called asynchronously, returns the request thread.

analyze_configuration_with_http_info(id, body, **kwargs)

Performs analysis of the component’s configuration, providing information about which attributes are referenced.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.analyze_configuration_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)
• body (ConfigurationAnalysisEntity) – The configuration analysis request. (required)

Returns:

ConfigurationAnalysisEntity If the method is called asynchronously, returns the request thread.

clear_state(id, **kwargs)

Clears the state for a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.clear_state(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

clear_state_with_http_info(id, **kwargs)

Clears the state for a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.clear_state_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

delete_validation_request(id, request_id, **kwargs)

Deletes the Verification Request with the given ID Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_validation_request(id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Reporting Task (required)
• request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

delete_validation_request_with_http_info(id, request_id, **kwargs)

Deletes the Verification Request with the given ID Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_validation_request_with_http_info(id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Reporting Task (required)
• request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor(id, property_name, **kwargs)

Gets a reporting task property descriptor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor(id, property_name, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)
• property_name (str) – The property name. (required)
• sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor_with_http_info(id, property_name, **kwargs)

Gets a reporting task property descriptor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor_with_http_info(id, property_name, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)
• property_name (str) – The property name. (required)
• sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_reporting_task(id, **kwargs)

Gets a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_reporting_task(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

get_reporting_task_with_http_info(id, **kwargs)

Gets a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_reporting_task_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

get_state(id, **kwargs)

Gets the state for a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_state_with_http_info(id, **kwargs)

Gets the state for a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_verification_request(id, request_id, **kwargs)

Returns the Verification Request with the given ID Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_verification_request(id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Reporting Task (required)
• request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

get_verification_request_with_http_info(id, request_id, **kwargs)

Returns the Verification Request with the given ID Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_verification_request_with_http_info(id, request_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Reporting Task (required)
• request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

remove_reporting_task(id, **kwargs)

Deletes a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_reporting_task(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

remove_reporting_task_with_http_info(id, **kwargs)

Deletes a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_reporting_task_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

submit_config_verification_request(id, body, **kwargs)

Performs verification of the Reporting Task’s configuration This will initiate the process of verifying a given Reporting Task configuration. This may be a long-running task. As a result, this endpoint will immediately return a ReportingTaskConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /reporting-tasks/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /reporting-tasks/{serviceId}/verification-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_config_verification_request(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)
• body (VerifyConfigRequestEntity) – The reporting task configuration verification request. (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

submit_config_verification_request_with_http_info(id, body, **kwargs)

Performs verification of the Reporting Task’s configuration This will initiate the process of verifying a given Reporting Task configuration. This may be a long-running task. As a result, this endpoint will immediately return a ReportingTaskConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /reporting-tasks/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /reporting-tasks/{serviceId}/verification-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_config_verification_request_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)
• body (VerifyConfigRequestEntity) – The reporting task configuration verification request. (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

update_reporting_task(id, body, **kwargs)

Updates a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_reporting_task(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)
• body (ReportingTaskEntity) – The reporting task configuration details. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

update_reporting_task_with_http_info(id, body, **kwargs)

Updates a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_reporting_task_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)
• body (ReportingTaskEntity) – The reporting task configuration details. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

update_run_status(id, body, **kwargs)

Updates run status of a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)
• body (ReportingTaskRunStatusEntity) – The reporting task run status. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

update_run_status_with_http_info(id, body, **kwargs)

Updates run status of a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The reporting task id. (required)
• body (ReportingTaskRunStatusEntity) – The reporting task run status. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.resources_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.resources_api.ResourcesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

get_resources(**kwargs)

Gets the available resources that support access/authorization policies

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_resources(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ResourcesEntity If the method is called asynchronously, returns the request thread.

get_resources_with_http_info(**kwargs)

Gets the available resources that support access/authorization policies

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_resources_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ResourcesEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.site_to_site_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.site_to_site_api.SiteToSiteApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

get_peers(**kwargs)

Returns the available Peers and its status of this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_peers(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:PeersEntity If the method is called asynchronously, returns the request thread.

get_peers_with_http_info(**kwargs)

Returns the available Peers and its status of this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_peers_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:PeersEntity If the method is called asynchronously, returns the request thread.

get_site_to_site_details(**kwargs)

Returns the details about this NiFi necessary to communicate via site to site

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_site_to_site_details(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ControllerEntity If the method is called asynchronously, returns the request thread.

get_site_to_site_details_with_http_info(**kwargs)

Returns the details about this NiFi necessary to communicate via site to site

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_site_to_site_details_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:ControllerEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.snippets_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.snippets_api.SnippetsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

create_snippet(body, **kwargs)

Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_snippet(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (SnippetEntity) – The snippet configuration details. (required)

Returns:

SnippetEntity If the method is called asynchronously, returns the request thread.

create_snippet_with_http_info(body, **kwargs)

Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_snippet_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (SnippetEntity) – The snippet configuration details. (required)

Returns:

SnippetEntity If the method is called asynchronously, returns the request thread.

delete_snippet(id, **kwargs)

Deletes the components in a snippet and discards the snippet

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_snippet(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The snippet id. (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

SnippetEntity If the method is called asynchronously, returns the request thread.

delete_snippet_with_http_info(id, **kwargs)

Deletes the components in a snippet and discards the snippet

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_snippet_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The snippet id. (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

SnippetEntity If the method is called asynchronously, returns the request thread.

update_snippet(id, body, **kwargs)

Move’s the components in this Snippet into a new Process Group and discards the snippet

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_snippet(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The snippet id. (required)
• body (SnippetEntity) – The snippet configuration details. (required)

Returns:

SnippetEntity If the method is called asynchronously, returns the request thread.

update_snippet_with_http_info(id, body, **kwargs)

Move’s the components in this Snippet into a new Process Group and discards the snippet

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_snippet_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The snippet id. (required)
• body (SnippetEntity) – The snippet configuration details. (required)

Returns:

SnippetEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.system_diagnostics_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.system_diagnostics_api.SystemDiagnosticsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

get_system_diagnostics(**kwargs)

Gets the diagnostics for the system NiFi is running on

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_system_diagnostics(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

SystemDiagnosticsEntity If the method is called asynchronously, returns the request thread.

get_system_diagnostics_with_http_info(**kwargs)

Gets the diagnostics for the system NiFi is running on

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_system_diagnostics_with_http_info(callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
• cluster_node_id (str) – The id of the node where to get the status.

Returns:

SystemDiagnosticsEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.templates_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.templates_api.TemplatesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

export_template(id, **kwargs)

Exports a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.export_template(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The template id. (required)

Returns:

str If the method is called asynchronously, returns the request thread.

export_template_with_http_info(id, **kwargs)

Exports a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.export_template_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The template id. (required)

Returns:

str If the method is called asynchronously, returns the request thread.

remove_template(id, **kwargs)

Deletes a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_template(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The template id. (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

remove_template_with_http_info(id, **kwargs)

Deletes a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_template_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The template id. (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.tenants_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.tenants_api.TenantsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

create_user(body, **kwargs)

Creates a user Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_user(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (UserEntity) – The user configuration details. (required)

Returns:

UserEntity If the method is called asynchronously, returns the request thread.

create_user_group(body, **kwargs)

Creates a user group Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_user_group(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (UserGroupEntity) – The user group configuration details. (required)

Returns:

UserGroupEntity If the method is called asynchronously, returns the request thread.

create_user_group_with_http_info(body, **kwargs)

Creates a user group Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_user_group_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (UserGroupEntity) – The user group configuration details. (required)

Returns:

UserGroupEntity If the method is called asynchronously, returns the request thread.

create_user_with_http_info(body, **kwargs)

Creates a user Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_user_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (UserEntity) – The user configuration details. (required)

Returns:

UserEntity If the method is called asynchronously, returns the request thread.

get_user(id, **kwargs)

Gets a user Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user id. (required)

Returns:

UserEntity If the method is called asynchronously, returns the request thread.

get_user_group(id, **kwargs)

Gets a user group Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_group(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user group id. (required)

Returns:

UserGroupEntity If the method is called asynchronously, returns the request thread.

get_user_group_with_http_info(id, **kwargs)

Gets a user group Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_group_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user group id. (required)

Returns:

UserGroupEntity If the method is called asynchronously, returns the request thread.

get_user_groups(**kwargs)

Gets all user groups Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_groups(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:UserGroupsEntity If the method is called asynchronously, returns the request thread.

get_user_groups_with_http_info(**kwargs)

Gets all user groups Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_groups_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:UserGroupsEntity If the method is called asynchronously, returns the request thread.

get_user_with_http_info(id, **kwargs)

Gets a user Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user id. (required)

Returns:

UserEntity If the method is called asynchronously, returns the request thread.

get_users(**kwargs)

Gets all users Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_users(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:UsersEntity If the method is called asynchronously, returns the request thread.

get_users_with_http_info(**kwargs)

Gets all users Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_users_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:UsersEntity If the method is called asynchronously, returns the request thread.

remove_user(id, **kwargs)

Deletes a user Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_user(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

UserEntity If the method is called asynchronously, returns the request thread.

remove_user_group(id, **kwargs)

Deletes a user group Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_user_group(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user group id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

UserGroupEntity If the method is called asynchronously, returns the request thread.

remove_user_group_with_http_info(id, **kwargs)

Deletes a user group Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_user_group_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user group id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

UserGroupEntity If the method is called asynchronously, returns the request thread.

remove_user_with_http_info(id, **kwargs)

Deletes a user Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_user_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user id. (required)
• version (str) – The revision is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

UserEntity If the method is called asynchronously, returns the request thread.

search_tenants(q, **kwargs)

Searches for a tenant with the specified identity Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.search_tenants(q, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• q (str) – Identity to search for. (required)

Returns:

TenantsEntity If the method is called asynchronously, returns the request thread.

search_tenants_with_http_info(q, **kwargs)

Searches for a tenant with the specified identity Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.search_tenants_with_http_info(q, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• q (str) – Identity to search for. (required)

Returns:

TenantsEntity If the method is called asynchronously, returns the request thread.

update_user(id, body, **kwargs)

Updates a user Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_user(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user id. (required)
• body (UserEntity) – The user configuration details. (required)

Returns:

UserEntity If the method is called asynchronously, returns the request thread.

update_user_group(id, body, **kwargs)

Updates a user group Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_user_group(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user group id. (required)
• body (UserGroupEntity) – The user group configuration details. (required)

Returns:

UserGroupEntity If the method is called asynchronously, returns the request thread.

update_user_group_with_http_info(id, body, **kwargs)

Updates a user group Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_user_group_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user group id. (required)
• body (UserGroupEntity) – The user group configuration details. (required)

Returns:

UserGroupEntity If the method is called asynchronously, returns the request thread.

update_user_with_http_info(id, body, **kwargs)

Updates a user Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_user_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user id. (required)
• body (UserEntity) – The user configuration details. (required)

Returns:

UserEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.versions_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.versions_api.VersionsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

create_version_control_request(body, **kwargs)

Create a version control request Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_version_control_request(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (CreateActiveRequestEntity) – The versioned flow details. (required)

Returns:

str If the method is called asynchronously, returns the request thread.

create_version_control_request_with_http_info(body, **kwargs)

Create a version control request Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_version_control_request_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (CreateActiveRequestEntity) – The versioned flow details. (required)

Returns:

str If the method is called asynchronously, returns the request thread.

delete_revert_request(id, **kwargs)

Deletes the Revert Request with the given ID Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE’ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_revert_request(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Revert Request (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

VersionedFlowUpdateRequestEntity If the method is called asynchronously, returns the request thread.

delete_revert_request_with_http_info(id, **kwargs)

Deletes the Revert Request with the given ID Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE’ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_revert_request_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Revert Request (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

VersionedFlowUpdateRequestEntity If the method is called asynchronously, returns the request thread.

delete_update_request(id, **kwargs)

Deletes the Update Request with the given ID Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE’ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_update_request(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Update Request (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

VersionedFlowUpdateRequestEntity If the method is called asynchronously, returns the request thread.

delete_update_request_with_http_info(id, **kwargs)

Deletes the Update Request with the given ID Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE’ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_update_request_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Update Request (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

VersionedFlowUpdateRequestEntity If the method is called asynchronously, returns the request thread.

delete_version_control_request(id, **kwargs)

Deletes the version control request with the given ID Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_version_control_request(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The request ID. (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

None If the method is called asynchronously, returns the request thread.

delete_version_control_request_with_http_info(id, **kwargs)

Deletes the version control request with the given ID Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_version_control_request_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The request ID. (required)
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

None If the method is called asynchronously, returns the request thread.

export_flow_version(id, **kwargs)

Gets the latest version of a Process Group for download

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.export_flow_version(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

str If the method is called asynchronously, returns the request thread.

export_flow_version_with_http_info(id, **kwargs)

Gets the latest version of a Process Group for download

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.export_flow_version_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

str If the method is called asynchronously, returns the request thread.

get_revert_request(id, **kwargs)

Returns the Revert Request with the given ID Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_revert_request(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Revert Request (required)

Returns:

VersionedFlowUpdateRequestEntity If the method is called asynchronously, returns the request thread.

get_revert_request_with_http_info(id, **kwargs)

Returns the Revert Request with the given ID Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_revert_request_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Revert Request (required)

Returns:

VersionedFlowUpdateRequestEntity If the method is called asynchronously, returns the request thread.

get_update_request(id, **kwargs)

Returns the Update Request with the given ID Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_update_request(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Update Request (required)

Returns:

VersionedFlowUpdateRequestEntity If the method is called asynchronously, returns the request thread.

get_update_request_with_http_info(id, **kwargs)

Returns the Update Request with the given ID Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_update_request_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The ID of the Update Request (required)

Returns:

VersionedFlowUpdateRequestEntity If the method is called asynchronously, returns the request thread.

get_version_information(id, **kwargs)

Gets the Version Control information for a process group Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_version_information(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

VersionControlInformationEntity If the method is called asynchronously, returns the request thread.

get_version_information_with_http_info(id, **kwargs)

Gets the Version Control information for a process group Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_version_information_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)

Returns:

VersionControlInformationEntity If the method is called asynchronously, returns the request thread.

initiate_revert_flow_version(id, body, **kwargs)

Initiate the Revert Request of a Process Group with the given ID For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.initiate_revert_flow_version(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (VersionControlInformationEntity) – The controller service configuration details. (required)

Returns:

VersionedFlowUpdateRequestEntity If the method is called asynchronously, returns the request thread.

initiate_revert_flow_version_with_http_info(id, body, **kwargs)

Initiate the Revert Request of a Process Group with the given ID For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.initiate_revert_flow_version_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (VersionControlInformationEntity) – The controller service configuration details. (required)

Returns:

VersionedFlowUpdateRequestEntity If the method is called asynchronously, returns the request thread.

initiate_version_control_update(id, body, **kwargs)

Initiate the Update Request of a Process Group with the given ID For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.initiate_version_control_update(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (VersionControlInformationEntity) – The controller service configuration details. (required)

Returns:

VersionedFlowUpdateRequestEntity If the method is called asynchronously, returns the request thread.

initiate_version_control_update_with_http_info(id, body, **kwargs)

Initiate the Update Request of a Process Group with the given ID For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.initiate_version_control_update_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (VersionControlInformationEntity) – The controller service configuration details. (required)

Returns:

VersionedFlowUpdateRequestEntity If the method is called asynchronously, returns the request thread.

save_to_flow_registry(id, body, **kwargs)

Save the Process Group with the given ID Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.save_to_flow_registry(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (StartVersionControlRequestEntity) – The versioned flow details. (required)

Returns:

VersionControlInformationEntity If the method is called asynchronously, returns the request thread.

save_to_flow_registry_with_http_info(id, body, **kwargs)

Save the Process Group with the given ID Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.save_to_flow_registry_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (StartVersionControlRequestEntity) – The versioned flow details. (required)

Returns:

VersionControlInformationEntity If the method is called asynchronously, returns the request thread.

stop_version_control(id, **kwargs)

Stops version controlling the Process Group with the given ID Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.stop_version_control(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• version (str) – The version is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

VersionControlInformationEntity If the method is called asynchronously, returns the request thread.

stop_version_control_with_http_info(id, **kwargs)

Stops version controlling the Process Group with the given ID Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.stop_version_control_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• version (str) – The version is used to verify the client is working with the latest version of the flow.
• client_id (str) – If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
• disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

VersionControlInformationEntity If the method is called asynchronously, returns the request thread.

update_flow_version(id, body, **kwargs)

Update the version of a Process Group with the given ID For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_flow_version(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (VersionedFlowSnapshotEntity) – The controller service configuration details. (required)

Returns:

VersionControlInformationEntity If the method is called asynchronously, returns the request thread.

update_flow_version_with_http_info(id, body, **kwargs)

Update the version of a Process Group with the given ID For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_flow_version_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The process group id. (required)
• body (VersionedFlowSnapshotEntity) – The controller service configuration details. (required)

Returns:

VersionControlInformationEntity If the method is called asynchronously, returns the request thread.

update_version_control_request(id, body, **kwargs)

Updates the request with the given ID Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_version_control_request(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The request ID. (required)
• body (VersionControlComponentMappingEntity) – The version control component mapping. (required)

Returns:

VersionControlInformationEntity If the method is called asynchronously, returns the request thread.

update_version_control_request_with_http_info(id, body, **kwargs)

Updates the request with the given ID Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_version_control_request_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The request ID. (required)
• body (VersionControlComponentMappingEntity) – The version control component mapping. (required)

Returns:

VersionControlInformationEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.models package

Submodules

nipyapi.nifi.models.about_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.about_dto.AboutDTO(title=None, version=None, uri=None, content_viewer_url=None, timezone=None, build_tag=None, build_revision=None, build_branch=None, build_timestamp=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AboutDTO - a model defined in Swagger

attribute_map = {'build_branch': 'buildBranch', 'build_revision': 'buildRevision', 'build_tag': 'buildTag', 'build_timestamp': 'buildTimestamp', 'content_viewer_url': 'contentViewerUrl', 'timezone': 'timezone', 'title': 'title', 'uri': 'uri', 'version': 'version'}

build_branch

Gets the build_branch of this AboutDTO. Build branch

Returns:The build_branch of this AboutDTO. Return type:str

build_revision

Gets the build_revision of this AboutDTO. Build revision or commit hash

Returns:The build_revision of this AboutDTO. Return type:str

build_tag

Gets the build_tag of this AboutDTO. Build tag

Returns:The build_tag of this AboutDTO. Return type:str

build_timestamp

Gets the build_timestamp of this AboutDTO. Build timestamp

Returns:The build_timestamp of this AboutDTO. Return type:str

content_viewer_url

Gets the content_viewer_url of this AboutDTO. The URL for the content viewer if configured.

Returns:The content_viewer_url of this AboutDTO. Return type:str

swagger_types = {'build_branch': 'str', 'build_revision': 'str', 'build_tag': 'str', 'build_timestamp': 'str', 'content_viewer_url': 'str', 'timezone': 'str', 'title': 'str', 'uri': 'str', 'version': 'str'}

timezone

Gets the timezone of this AboutDTO. The timezone of the NiFi instance.

Returns:The timezone of this AboutDTO. Return type:str

title

Gets the title of this AboutDTO. The title to be used on the page and in the about dialog.

Returns:The title of this AboutDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this AboutDTO. The URI for the NiFi.

Returns:The uri of this AboutDTO. Return type:str

version

Gets the version of this AboutDTO. The version of this NiFi.

Returns:The version of this AboutDTO. Return type:str

nipyapi.nifi.models.about_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.about_entity.AboutEntity(about=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AboutEntity - a model defined in Swagger

about

Gets the about of this AboutEntity.

Returns:The about of this AboutEntity. Return type:AboutDTO

attribute_map = {'about': 'about'}

swagger_types = {'about': 'AboutDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.access_configuration_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.access_configuration_dto.AccessConfigurationDTO(supports_login=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessConfigurationDTO - a model defined in Swagger

attribute_map = {'supports_login': 'supportsLogin'}

supports_login

Gets the supports_login of this AccessConfigurationDTO. Indicates whether or not this NiFi supports user login.

Returns:The supports_login of this AccessConfigurationDTO. Return type:bool

swagger_types = {'supports_login': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.access_configuration_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.access_configuration_entity.AccessConfigurationEntity(config=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessConfigurationEntity - a model defined in Swagger

attribute_map = {'config': 'config'}

config

Gets the config of this AccessConfigurationEntity.

Returns:The config of this AccessConfigurationEntity. Return type:AccessConfigurationDTO

swagger_types = {'config': 'AccessConfigurationDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.access_policy_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.access_policy_dto.AccessPolicyDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, resource=None, action=None, component_reference=None, configurable=None, users=None, user_groups=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessPolicyDTO - a model defined in Swagger

action

Gets the action of this AccessPolicyDTO. The action associated with this access policy.

Returns:The action of this AccessPolicyDTO. Return type:str

attribute_map = {'action': 'action', 'component_reference': 'componentReference', 'configurable': 'configurable', 'id': 'id', 'parent_group_id': 'parentGroupId', 'position': 'position', 'resource': 'resource', 'user_groups': 'userGroups', 'users': 'users', 'versioned_component_id': 'versionedComponentId'}

component_reference

Gets the component_reference of this AccessPolicyDTO. Component this policy references if applicable.

Returns:The component_reference of this AccessPolicyDTO. Return type:ComponentReferenceEntity

configurable

Gets the configurable of this AccessPolicyDTO. Whether this policy is configurable.

Returns:The configurable of this AccessPolicyDTO. Return type:bool

id

Gets the id of this AccessPolicyDTO. The id of the component.

Returns:The id of this AccessPolicyDTO. Return type:str

parent_group_id

Gets the parent_group_id of this AccessPolicyDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this AccessPolicyDTO. Return type:str

position

Gets the position of this AccessPolicyDTO. The position of this component in the UI if applicable.

Returns:The position of this AccessPolicyDTO. Return type:PositionDTO

resource

Gets the resource of this AccessPolicyDTO. The resource for this access policy.

Returns:The resource of this AccessPolicyDTO. Return type:str

swagger_types = {'action': 'str', 'component_reference': 'ComponentReferenceEntity', 'configurable': 'bool', 'id': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'resource': 'str', 'user_groups': 'list[TenantEntity]', 'users': 'list[TenantEntity]', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

user_groups

Gets the user_groups of this AccessPolicyDTO. The set of user group IDs associated with this access policy.

Returns:The user_groups of this AccessPolicyDTO. Return type:list[TenantEntity]

users

Gets the users of this AccessPolicyDTO. The set of user IDs associated with this access policy.

Returns:The users of this AccessPolicyDTO. Return type:list[TenantEntity]

versioned_component_id

Gets the versioned_component_id of this AccessPolicyDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this AccessPolicyDTO. Return type:str

nipyapi.nifi.models.access_policy_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.access_policy_entity.AccessPolicyEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, generated=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessPolicyEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'generated': 'generated', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this AccessPolicyEntity. The bulletins for this component.

Returns:The bulletins of this AccessPolicyEntity. Return type:list[BulletinEntity]

component

Gets the component of this AccessPolicyEntity.

Returns:The component of this AccessPolicyEntity. Return type:AccessPolicyDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this AccessPolicyEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this AccessPolicyEntity. Return type:bool

generated

Gets the generated of this AccessPolicyEntity. When this content was generated.

Returns:The generated of this AccessPolicyEntity. Return type:str

id

Gets the id of this AccessPolicyEntity. The id of the component.

Returns:The id of this AccessPolicyEntity. Return type:str

permissions

Gets the permissions of this AccessPolicyEntity. The permissions for this component.

Returns:The permissions of this AccessPolicyEntity. Return type:PermissionsDTO

position

Gets the position of this AccessPolicyEntity. The position of this component in the UI if applicable.

Returns:The position of this AccessPolicyEntity. Return type:PositionDTO

revision

Gets the revision of this AccessPolicyEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this AccessPolicyEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'AccessPolicyDTO', 'disconnected_node_acknowledged': 'bool', 'generated': 'str', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this AccessPolicyEntity. The URI for futures requests to the component.

Returns:The uri of this AccessPolicyEntity. Return type:str

nipyapi.nifi.models.access_policy_summary_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.access_policy_summary_dto.AccessPolicySummaryDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, resource=None, action=None, component_reference=None, configurable=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessPolicySummaryDTO - a model defined in Swagger

action

Gets the action of this AccessPolicySummaryDTO. The action associated with this access policy.

Returns:The action of this AccessPolicySummaryDTO. Return type:str

attribute_map = {'action': 'action', 'component_reference': 'componentReference', 'configurable': 'configurable', 'id': 'id', 'parent_group_id': 'parentGroupId', 'position': 'position', 'resource': 'resource', 'versioned_component_id': 'versionedComponentId'}

component_reference

Gets the component_reference of this AccessPolicySummaryDTO. Component this policy references if applicable.

Returns:The component_reference of this AccessPolicySummaryDTO. Return type:ComponentReferenceEntity

configurable

Gets the configurable of this AccessPolicySummaryDTO. Whether this policy is configurable.

Returns:The configurable of this AccessPolicySummaryDTO. Return type:bool

id

Gets the id of this AccessPolicySummaryDTO. The id of the component.

Returns:The id of this AccessPolicySummaryDTO. Return type:str

parent_group_id

Gets the parent_group_id of this AccessPolicySummaryDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this AccessPolicySummaryDTO. Return type:str

position

Gets the position of this AccessPolicySummaryDTO. The position of this component in the UI if applicable.

Returns:The position of this AccessPolicySummaryDTO. Return type:PositionDTO

resource

Gets the resource of this AccessPolicySummaryDTO. The resource for this access policy.

Returns:The resource of this AccessPolicySummaryDTO. Return type:str

swagger_types = {'action': 'str', 'component_reference': 'ComponentReferenceEntity', 'configurable': 'bool', 'id': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'resource': 'str', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_component_id

Gets the versioned_component_id of this AccessPolicySummaryDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this AccessPolicySummaryDTO. Return type:str

nipyapi.nifi.models.access_policy_summary_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.access_policy_summary_entity.AccessPolicySummaryEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessPolicySummaryEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this AccessPolicySummaryEntity. The bulletins for this component.

Returns:The bulletins of this AccessPolicySummaryEntity. Return type:list[BulletinEntity]

component

Gets the component of this AccessPolicySummaryEntity.

Returns:The component of this AccessPolicySummaryEntity. Return type:AccessPolicySummaryDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this AccessPolicySummaryEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this AccessPolicySummaryEntity. Return type:bool

id

Gets the id of this AccessPolicySummaryEntity. The id of the component.

Returns:The id of this AccessPolicySummaryEntity. Return type:str

permissions

Gets the permissions of this AccessPolicySummaryEntity. The permissions for this component.

Returns:The permissions of this AccessPolicySummaryEntity. Return type:PermissionsDTO

position

Gets the position of this AccessPolicySummaryEntity. The position of this component in the UI if applicable.

Returns:The position of this AccessPolicySummaryEntity. Return type:PositionDTO

revision

Gets the revision of this AccessPolicySummaryEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this AccessPolicySummaryEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'AccessPolicySummaryDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this AccessPolicySummaryEntity. The URI for futures requests to the component.

Returns:The uri of this AccessPolicySummaryEntity. Return type:str

nipyapi.nifi.models.access_status_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.access_status_dto.AccessStatusDTO(identity=None, status=None, message=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessStatusDTO - a model defined in Swagger

attribute_map = {'identity': 'identity', 'message': 'message', 'status': 'status'}

identity

Gets the identity of this AccessStatusDTO. The user identity.

Returns:The identity of this AccessStatusDTO. Return type:str

message

Gets the message of this AccessStatusDTO. Additional details about the user access status.

Returns:The message of this AccessStatusDTO. Return type:str

status

Gets the status of this AccessStatusDTO. The user access status.

Returns:The status of this AccessStatusDTO. Return type:str

swagger_types = {'identity': 'str', 'message': 'str', 'status': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.access_status_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.access_status_entity.AccessStatusEntity(access_status=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessStatusEntity - a model defined in Swagger

access_status

Gets the access_status of this AccessStatusEntity.

Returns:The access_status of this AccessStatusEntity. Return type:AccessStatusDTO

attribute_map = {'access_status': 'accessStatus'}

swagger_types = {'access_status': 'AccessStatusDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.action_details_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.action_details_dto.ActionDetailsDTO

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ActionDetailsDTO - a model defined in Swagger

attribute_map = {}

swagger_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.action_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.action_dto.ActionDTO(id=None, user_identity=None, timestamp=None, source_id=None, source_name=None, source_type=None, component_details=None, operation=None, action_details=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ActionDTO - a model defined in Swagger

action_details

Gets the action_details of this ActionDTO. The details of the action.

Returns:The action_details of this ActionDTO. Return type:ActionDetailsDTO

attribute_map = {'action_details': 'actionDetails', 'component_details': 'componentDetails', 'id': 'id', 'operation': 'operation', 'source_id': 'sourceId', 'source_name': 'sourceName', 'source_type': 'sourceType', 'timestamp': 'timestamp', 'user_identity': 'userIdentity'}

component_details

Gets the component_details of this ActionDTO. The details of the source component.

Returns:The component_details of this ActionDTO. Return type:ComponentDetailsDTO

id

Gets the id of this ActionDTO. The action id.

Returns:The id of this ActionDTO. Return type:int

operation

Gets the operation of this ActionDTO. The operation that was performed.

Returns:The operation of this ActionDTO. Return type:str

source_id

Gets the source_id of this ActionDTO. The id of the source component.

Returns:The source_id of this ActionDTO. Return type:str

source_name

Gets the source_name of this ActionDTO. The name of the source component.

Returns:The source_name of this ActionDTO. Return type:str

source_type

Gets the source_type of this ActionDTO. The type of the source component.

Returns:The source_type of this ActionDTO. Return type:str

swagger_types = {'action_details': 'ActionDetailsDTO', 'component_details': 'ComponentDetailsDTO', 'id': 'int', 'operation': 'str', 'source_id': 'str', 'source_name': 'str', 'source_type': 'str', 'timestamp': 'str', 'user_identity': 'str'}

timestamp

Gets the timestamp of this ActionDTO. The timestamp of the action.

Returns:The timestamp of this ActionDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

user_identity

Gets the user_identity of this ActionDTO. The identity of the user that performed the action.

Returns:The user_identity of this ActionDTO. Return type:str

nipyapi.nifi.models.action_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.action_entity.ActionEntity(id=None, timestamp=None, source_id=None, can_read=None, action=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ActionEntity - a model defined in Swagger

action

Gets the action of this ActionEntity.

Returns:The action of this ActionEntity. Return type:ActionDTO

attribute_map = {'action': 'action', 'can_read': 'canRead', 'id': 'id', 'source_id': 'sourceId', 'timestamp': 'timestamp'}

can_read

Gets the can_read of this ActionEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this ActionEntity. Return type:bool

id

Gets the id of this ActionEntity.

Returns:The id of this ActionEntity. Return type:int

source_id

Gets the source_id of this ActionEntity.

Returns:The source_id of this ActionEntity. Return type:str

swagger_types = {'action': 'ActionDTO', 'can_read': 'bool', 'id': 'int', 'source_id': 'str', 'timestamp': 'str'}

timestamp

Gets the timestamp of this ActionEntity. The timestamp of the action.

Returns:The timestamp of this ActionEntity. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.activate_controller_services_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.activate_controller_services_entity.ActivateControllerServicesEntity(id=None, state=None, components=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ActivateControllerServicesEntity - a model defined in Swagger

attribute_map = {'components': 'components', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'state': 'state'}

components

Gets the components of this ActivateControllerServicesEntity. Optional services to schedule. If not specified, all authorized descendant controller services will be used.

Returns:The components of this ActivateControllerServicesEntity. Return type:dict(str, RevisionDTO)

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ActivateControllerServicesEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ActivateControllerServicesEntity. Return type:bool

id

Gets the id of this ActivateControllerServicesEntity. The id of the ProcessGroup

Returns:The id of this ActivateControllerServicesEntity. Return type:str

state

Gets the state of this ActivateControllerServicesEntity. The desired state of the descendant components

Returns:The state of this ActivateControllerServicesEntity. Return type:str

swagger_types = {'components': 'dict(str, RevisionDTO)', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'state': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.affected_component_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.affected_component_dto.AffectedComponentDTO(process_group_id=None, id=None, reference_type=None, name=None, state=None, active_thread_count=None, validation_errors=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AffectedComponentDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this AffectedComponentDTO. The number of active threads for the referencing component.

Returns:The active_thread_count of this AffectedComponentDTO. Return type:int

attribute_map = {'active_thread_count': 'activeThreadCount', 'id': 'id', 'name': 'name', 'process_group_id': 'processGroupId', 'reference_type': 'referenceType', 'state': 'state', 'validation_errors': 'validationErrors'}

id

Gets the id of this AffectedComponentDTO. The UUID of this component

Returns:The id of this AffectedComponentDTO. Return type:str

name

Gets the name of this AffectedComponentDTO. The name of this component.

Returns:The name of this AffectedComponentDTO. Return type:str

process_group_id

Gets the process_group_id of this AffectedComponentDTO. The UUID of the Process Group that this component is in

Returns:The process_group_id of this AffectedComponentDTO. Return type:str

reference_type

Gets the reference_type of this AffectedComponentDTO. The type of this component

Returns:The reference_type of this AffectedComponentDTO. Return type:str

state

Gets the state of this AffectedComponentDTO. The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state.

Returns:The state of this AffectedComponentDTO. Return type:str

swagger_types = {'active_thread_count': 'int', 'id': 'str', 'name': 'str', 'process_group_id': 'str', 'reference_type': 'str', 'state': 'str', 'validation_errors': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

validation_errors

Gets the validation_errors of this AffectedComponentDTO. The validation errors for the component.

Returns:The validation_errors of this AffectedComponentDTO. Return type:list[str]

nipyapi.nifi.models.affected_component_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.affected_component_entity.AffectedComponentEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, process_group=None, reference_type=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AffectedComponentEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'process_group': 'processGroup', 'reference_type': 'referenceType', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this AffectedComponentEntity. The bulletins for this component.

Returns:The bulletins of this AffectedComponentEntity. Return type:list[BulletinEntity]

component

Gets the component of this AffectedComponentEntity.

Returns:The component of this AffectedComponentEntity. Return type:AffectedComponentDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this AffectedComponentEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this AffectedComponentEntity. Return type:bool

id

Gets the id of this AffectedComponentEntity. The id of the component.

Returns:The id of this AffectedComponentEntity. Return type:str

permissions

Gets the permissions of this AffectedComponentEntity. The permissions for this component.

Returns:The permissions of this AffectedComponentEntity. Return type:PermissionsDTO

position

Gets the position of this AffectedComponentEntity. The position of this component in the UI if applicable.

Returns:The position of this AffectedComponentEntity. Return type:PositionDTO

process_group

Gets the process_group of this AffectedComponentEntity. The Process Group that the component belongs to

Returns:The process_group of this AffectedComponentEntity. Return type:ProcessGroupNameDTO

reference_type

Gets the reference_type of this AffectedComponentEntity. The type of component referenced

Returns:The reference_type of this AffectedComponentEntity. Return type:str

revision

Gets the revision of this AffectedComponentEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this AffectedComponentEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'AffectedComponentDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'process_group': 'ProcessGroupNameDTO', 'reference_type': 'str', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this AffectedComponentEntity. The URI for futures requests to the component.

Returns:The uri of this AffectedComponentEntity. Return type:str

nipyapi.nifi.models.allowable_value_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.allowable_value_dto.AllowableValueDTO(display_name=None, value=None, description=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AllowableValueDTO - a model defined in Swagger

attribute_map = {'description': 'description', 'display_name': 'displayName', 'value': 'value'}

description

Gets the description of this AllowableValueDTO. A description for this allowable value.

Returns:The description of this AllowableValueDTO. Return type:str

display_name

Gets the display_name of this AllowableValueDTO. A human readable value that is allowed for the property descriptor.

Returns:The display_name of this AllowableValueDTO. Return type:str

swagger_types = {'description': 'str', 'display_name': 'str', 'value': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

value

Gets the value of this AllowableValueDTO. A value that is allowed for the property descriptor.

Returns:The value of this AllowableValueDTO. Return type:str

nipyapi.nifi.models.allowable_value_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.allowable_value_entity.AllowableValueEntity(allowable_value=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AllowableValueEntity - a model defined in Swagger

allowable_value

Gets the allowable_value of this AllowableValueEntity.

Returns:The allowable_value of this AllowableValueEntity. Return type:AllowableValueDTO

attribute_map = {'allowable_value': 'allowableValue', 'can_read': 'canRead'}

can_read

Gets the can_read of this AllowableValueEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this AllowableValueEntity. Return type:bool

swagger_types = {'allowable_value': 'AllowableValueDTO', 'can_read': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.attribute_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.attribute_dto.AttributeDTO(name=None, value=None, previous_value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AttributeDTO - a model defined in Swagger

attribute_map = {'name': 'name', 'previous_value': 'previousValue', 'value': 'value'}

name

Gets the name of this AttributeDTO. The attribute name.

Returns:The name of this AttributeDTO. Return type:str

previous_value

Gets the previous_value of this AttributeDTO. The value of the attribute before the event took place.

Returns:The previous_value of this AttributeDTO. Return type:str

swagger_types = {'name': 'str', 'previous_value': 'str', 'value': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

value

Gets the value of this AttributeDTO. The attribute value.

Returns:The value of this AttributeDTO. Return type:str

nipyapi.nifi.models.banner_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.banner_dto.BannerDTO(header_text=None, footer_text=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BannerDTO - a model defined in Swagger

attribute_map = {'footer_text': 'footerText', 'header_text': 'headerText'}

footer_text

Gets the footer_text of this BannerDTO. The footer text.

Returns:The footer_text of this BannerDTO. Return type:str

header_text

Gets the header_text of this BannerDTO. The header text.

Returns:The header_text of this BannerDTO. Return type:str

swagger_types = {'footer_text': 'str', 'header_text': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.banner_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.banner_entity.BannerEntity(banners=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BannerEntity - a model defined in Swagger

attribute_map = {'banners': 'banners'}

banners

Gets the banners of this BannerEntity.

Returns:The banners of this BannerEntity. Return type:BannerDTO

swagger_types = {'banners': 'BannerDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.batch_settings_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.batch_settings_dto.BatchSettingsDTO(count=None, size=None, duration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BatchSettingsDTO - a model defined in Swagger

attribute_map = {'count': 'count', 'duration': 'duration', 'size': 'size'}

count

Gets the count of this BatchSettingsDTO. Preferred number of flow files to include in a transaction.

Returns:The count of this BatchSettingsDTO. Return type:int

duration

Gets the duration of this BatchSettingsDTO. Preferred amount of time that a transaction should span.

Returns:The duration of this BatchSettingsDTO. Return type:str

size

Gets the size of this BatchSettingsDTO. Preferred number of bytes to include in a transaction.

Returns:The size of this BatchSettingsDTO. Return type:str

swagger_types = {'count': 'int', 'duration': 'str', 'size': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.batch_size 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.batch_size.BatchSize(count=None, size=None, duration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BatchSize - a model defined in Swagger

attribute_map = {'count': 'count', 'duration': 'duration', 'size': 'size'}

count

Gets the count of this BatchSize. Preferred number of flow files to include in a transaction.

Returns:The count of this BatchSize. Return type:int

duration

Gets the duration of this BatchSize. Preferred amount of time that a transaction should span.

Returns:The duration of this BatchSize. Return type:str

size

Gets the size of this BatchSize. Preferred number of bytes to include in a transaction.

Returns:The size of this BatchSize. Return type:str

swagger_types = {'count': 'int', 'duration': 'str', 'size': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bucket 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.bucket.Bucket(link=None, identifier=None, name=None, created_timestamp=None, description=None, allow_bundle_redeploy=None, allow_public_read=None, permissions=None, revision=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

Bucket - a model defined in Swagger

allow_bundle_redeploy

Gets the allow_bundle_redeploy of this Bucket. Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false.

Returns:The allow_bundle_redeploy of this Bucket. Return type:bool

allow_public_read

Gets the allow_public_read of this Bucket. Indicates if this bucket allows read access to unauthenticated anonymous users

Returns:The allow_public_read of this Bucket. Return type:bool

attribute_map = {'allow_bundle_redeploy': 'allowBundleRedeploy', 'allow_public_read': 'allowPublicRead', 'created_timestamp': 'createdTimestamp', 'description': 'description', 'identifier': 'identifier', 'link': 'link', 'name': 'name', 'permissions': 'permissions', 'revision': 'revision'}

created_timestamp

Gets the created_timestamp of this Bucket. The timestamp of when the bucket was first created. This is set by the server at creation time.

Returns:The created_timestamp of this Bucket. Return type:int

description

Gets the description of this Bucket. A description of the bucket.

Returns:The description of this Bucket. Return type:str

identifier

Gets the identifier of this Bucket. An ID to uniquely identify this object.

Returns:The identifier of this Bucket. Return type:str

link

Gets the link of this Bucket. An WebLink to this entity.

Returns:The link of this Bucket. Return type:JaxbLink

name

Gets the name of this Bucket. The name of the bucket.

Returns:The name of this Bucket. Return type:str

permissions

Gets the permissions of this Bucket. The access that the current user has to this bucket.

Returns:The permissions of this Bucket. Return type:Permissions

revision

Gets the revision of this Bucket. The revision of this entity used for optimistic-locking during updates.

Returns:The revision of this Bucket. Return type:RevisionInfo

swagger_types = {'allow_bundle_redeploy': 'bool', 'allow_public_read': 'bool', 'created_timestamp': 'int', 'description': 'str', 'identifier': 'str', 'link': 'JaxbLink', 'name': 'str', 'permissions': 'Permissions', 'revision': 'RevisionInfo'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bucket_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.bucket_dto.BucketDTO(id=None, name=None, description=None, created=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BucketDTO - a model defined in Swagger

attribute_map = {'created': 'created', 'description': 'description', 'id': 'id', 'name': 'name'}

created

Gets the created of this BucketDTO. The created timestamp of this bucket

Returns:The created of this BucketDTO. Return type:int

description

Gets the description of this BucketDTO. The bucket description

Returns:The description of this BucketDTO. Return type:str

id

Gets the id of this BucketDTO. The bucket identifier

Returns:The id of this BucketDTO. Return type:str

name

Gets the name of this BucketDTO. The bucket name

Returns:The name of this BucketDTO. Return type:str

swagger_types = {'created': 'int', 'description': 'str', 'id': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bucket_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.bucket_entity.BucketEntity(id=None, bucket=None, permissions=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BucketEntity - a model defined in Swagger

attribute_map = {'bucket': 'bucket', 'id': 'id', 'permissions': 'permissions'}

bucket

Gets the bucket of this BucketEntity.

Returns:The bucket of this BucketEntity. Return type:BucketDTO

id

Gets the id of this BucketEntity.

Returns:The id of this BucketEntity. Return type:str

permissions

Gets the permissions of this BucketEntity.

Returns:The permissions of this BucketEntity. Return type:PermissionsDTO

swagger_types = {'bucket': 'BucketDTO', 'id': 'str', 'permissions': 'PermissionsDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.buckets_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.buckets_entity.BucketsEntity(buckets=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BucketsEntity - a model defined in Swagger

attribute_map = {'buckets': 'buckets'}

buckets

Gets the buckets of this BucketsEntity.

Returns:The buckets of this BucketsEntity. Return type:list[BucketEntity]

swagger_types = {'buckets': 'list[BucketEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bulletin_board_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.bulletin_board_dto.BulletinBoardDTO(bulletins=None, generated=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BulletinBoardDTO - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'generated': 'generated'}

bulletins

Gets the bulletins of this BulletinBoardDTO. The bulletins in the bulletin board, that matches the supplied request.

Returns:The bulletins of this BulletinBoardDTO. Return type:list[BulletinEntity]

generated

Gets the generated of this BulletinBoardDTO. The timestamp when this report was generated.

Returns:The generated of this BulletinBoardDTO. Return type:str

swagger_types = {'bulletins': 'list[BulletinEntity]', 'generated': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bulletin_board_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.bulletin_board_entity.BulletinBoardEntity(bulletin_board=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BulletinBoardEntity - a model defined in Swagger

attribute_map = {'bulletin_board': 'bulletinBoard'}

bulletin_board

Gets the bulletin_board of this BulletinBoardEntity.

Returns:The bulletin_board of this BulletinBoardEntity. Return type:BulletinBoardDTO

swagger_types = {'bulletin_board': 'BulletinBoardDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bulletin_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.bulletin_dto.BulletinDTO(id=None, node_address=None, category=None, group_id=None, source_id=None, source_name=None, level=None, message=None, timestamp=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BulletinDTO - a model defined in Swagger

attribute_map = {'category': 'category', 'group_id': 'groupId', 'id': 'id', 'level': 'level', 'message': 'message', 'node_address': 'nodeAddress', 'source_id': 'sourceId', 'source_name': 'sourceName', 'timestamp': 'timestamp'}

category

Gets the category of this BulletinDTO. The category of this bulletin.

Returns:The category of this BulletinDTO. Return type:str

group_id

Gets the group_id of this BulletinDTO. The group id of the source component.

Returns:The group_id of this BulletinDTO. Return type:str

id

Gets the id of this BulletinDTO. The id of the bulletin.

Returns:The id of this BulletinDTO. Return type:int

level

Gets the level of this BulletinDTO. The level of the bulletin.

Returns:The level of this BulletinDTO. Return type:str

message

Gets the message of this BulletinDTO. The bulletin message.

Returns:The message of this BulletinDTO. Return type:str

node_address

Gets the node_address of this BulletinDTO. If clustered, the address of the node from which the bulletin originated.

Returns:The node_address of this BulletinDTO. Return type:str

source_id

Gets the source_id of this BulletinDTO. The id of the source component.

Returns:The source_id of this BulletinDTO. Return type:str

source_name

Gets the source_name of this BulletinDTO. The name of the source component.

Returns:The source_name of this BulletinDTO. Return type:str

swagger_types = {'category': 'str', 'group_id': 'str', 'id': 'int', 'level': 'str', 'message': 'str', 'node_address': 'str', 'source_id': 'str', 'source_name': 'str', 'timestamp': 'str'}

timestamp

Gets the timestamp of this BulletinDTO. When this bulletin was generated.

Returns:The timestamp of this BulletinDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bulletin_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.bulletin_entity.BulletinEntity(id=None, group_id=None, source_id=None, timestamp=None, node_address=None, can_read=None, bulletin=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BulletinEntity - a model defined in Swagger

attribute_map = {'bulletin': 'bulletin', 'can_read': 'canRead', 'group_id': 'groupId', 'id': 'id', 'node_address': 'nodeAddress', 'source_id': 'sourceId', 'timestamp': 'timestamp'}

bulletin

Gets the bulletin of this BulletinEntity.

Returns:The bulletin of this BulletinEntity. Return type:BulletinDTO

can_read

Gets the can_read of this BulletinEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this BulletinEntity. Return type:bool

group_id

Gets the group_id of this BulletinEntity.

Returns:The group_id of this BulletinEntity. Return type:str

id

Gets the id of this BulletinEntity.

Returns:The id of this BulletinEntity. Return type:int

node_address

Gets the node_address of this BulletinEntity.

Returns:The node_address of this BulletinEntity. Return type:str

source_id

Gets the source_id of this BulletinEntity.

Returns:The source_id of this BulletinEntity. Return type:str

swagger_types = {'bulletin': 'BulletinDTO', 'can_read': 'bool', 'group_id': 'str', 'id': 'int', 'node_address': 'str', 'source_id': 'str', 'timestamp': 'str'}

timestamp

Gets the timestamp of this BulletinEntity. When this bulletin was generated.

Returns:The timestamp of this BulletinEntity. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bundle 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.bundle.Bundle(group=None, artifact=None, version=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

Bundle - a model defined in Swagger

artifact

Gets the artifact of this Bundle. The artifact of the bundle

Returns:The artifact of this Bundle. Return type:str

attribute_map = {'artifact': 'artifact', 'group': 'group', 'version': 'version'}

group

Gets the group of this Bundle. The group of the bundle

Returns:The group of this Bundle. Return type:str

swagger_types = {'artifact': 'str', 'group': 'str', 'version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version

Gets the version of this Bundle. The version of the bundle

Returns:The version of this Bundle. Return type:str

nipyapi.nifi.models.bundle_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.bundle_dto.BundleDTO(group=None, artifact=None, version=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BundleDTO - a model defined in Swagger

artifact

Gets the artifact of this BundleDTO. The artifact of the bundle.

Returns:The artifact of this BundleDTO. Return type:str

attribute_map = {'artifact': 'artifact', 'group': 'group', 'version': 'version'}

group

Gets the group of this BundleDTO. The group of the bundle.

Returns:The group of this BundleDTO. Return type:str

swagger_types = {'artifact': 'str', 'group': 'str', 'version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version

Gets the version of this BundleDTO. The version of the bundle.

Returns:The version of this BundleDTO. Return type:str

nipyapi.nifi.models.cluste_summary_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.cluste_summary_entity.ClusteSummaryEntity(cluster_summary=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ClusteSummaryEntity - a model defined in Swagger

attribute_map = {'cluster_summary': 'clusterSummary'}

cluster_summary

Gets the cluster_summary of this ClusteSummaryEntity.

Returns:The cluster_summary of this ClusteSummaryEntity. Return type:ClusterSummaryDTO

swagger_types = {'cluster_summary': 'ClusterSummaryDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.cluster_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.cluster_dto.ClusterDTO(nodes=None, generated=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ClusterDTO - a model defined in Swagger

attribute_map = {'generated': 'generated', 'nodes': 'nodes'}

generated

Gets the generated of this ClusterDTO. The timestamp the report was generated.

Returns:The generated of this ClusterDTO. Return type:str

nodes

Gets the nodes of this ClusterDTO. The collection of nodes that are part of the cluster.

Returns:The nodes of this ClusterDTO. Return type:list[NodeDTO]

swagger_types = {'generated': 'str', 'nodes': 'list[NodeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.cluster_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.cluster_entity.ClusterEntity(cluster=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ClusterEntity - a model defined in Swagger

attribute_map = {'cluster': 'cluster'}

cluster

Gets the cluster of this ClusterEntity.

Returns:The cluster of this ClusterEntity. Return type:ClusterDTO

swagger_types = {'cluster': 'ClusterDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.cluster_search_results_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.cluster_search_results_entity.ClusterSearchResultsEntity(node_results=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ClusterSearchResultsEntity - a model defined in Swagger

attribute_map = {'node_results': 'nodeResults'}

node_results

Gets the node_results of this ClusterSearchResultsEntity.

Returns:The node_results of this ClusterSearchResultsEntity. Return type:list[NodeSearchResultDTO]

swagger_types = {'node_results': 'list[NodeSearchResultDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.cluster_summary_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.cluster_summary_dto.ClusterSummaryDTO(connected_nodes=None, connected_node_count=None, total_node_count=None, clustered=None, connected_to_cluster=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ClusterSummaryDTO - a model defined in Swagger

attribute_map = {'clustered': 'clustered', 'connected_node_count': 'connectedNodeCount', 'connected_nodes': 'connectedNodes', 'connected_to_cluster': 'connectedToCluster', 'total_node_count': 'totalNodeCount'}

clustered

Gets the clustered of this ClusterSummaryDTO. Whether this NiFi instance is clustered.

Returns:The clustered of this ClusterSummaryDTO. Return type:bool

connected_node_count

Gets the connected_node_count of this ClusterSummaryDTO. The number of nodes that are currently connected to the cluster

Returns:The connected_node_count of this ClusterSummaryDTO. Return type:int

connected_nodes

Gets the connected_nodes of this ClusterSummaryDTO. When clustered, reports the number of nodes connected vs the number of nodes in the cluster.

Returns:The connected_nodes of this ClusterSummaryDTO. Return type:str

connected_to_cluster

Gets the connected_to_cluster of this ClusterSummaryDTO. Whether this NiFi instance is connected to a cluster.

Returns:The connected_to_cluster of this ClusterSummaryDTO. Return type:bool

swagger_types = {'clustered': 'bool', 'connected_node_count': 'int', 'connected_nodes': 'str', 'connected_to_cluster': 'bool', 'total_node_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

total_node_count

Gets the total_node_count of this ClusterSummaryDTO. The number of nodes in the cluster, regardless of whether or not they are connected

Returns:The total_node_count of this ClusterSummaryDTO. Return type:int

nipyapi.nifi.models.component_details_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.component_details_dto.ComponentDetailsDTO

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentDetailsDTO - a model defined in Swagger

attribute_map = {}

swagger_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.component_difference_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.component_difference_dto.ComponentDifferenceDTO(component_type=None, component_id=None, component_name=None, process_group_id=None, differences=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentDifferenceDTO - a model defined in Swagger

attribute_map = {'component_id': 'componentId', 'component_name': 'componentName', 'component_type': 'componentType', 'differences': 'differences', 'process_group_id': 'processGroupId'}

component_id

Gets the component_id of this ComponentDifferenceDTO. The ID of the component

Returns:The component_id of this ComponentDifferenceDTO. Return type:str

component_name

Gets the component_name of this ComponentDifferenceDTO. The name of the component

Returns:The component_name of this ComponentDifferenceDTO. Return type:str

component_type

Gets the component_type of this ComponentDifferenceDTO. The type of component

Returns:The component_type of this ComponentDifferenceDTO. Return type:str

differences

Gets the differences of this ComponentDifferenceDTO. The differences in the component between the two flows

Returns:The differences of this ComponentDifferenceDTO. Return type:list[DifferenceDTO]

process_group_id

Gets the process_group_id of this ComponentDifferenceDTO. The ID of the Process Group that the component belongs to

Returns:The process_group_id of this ComponentDifferenceDTO. Return type:str

swagger_types = {'component_id': 'str', 'component_name': 'str', 'component_type': 'str', 'differences': 'list[DifferenceDTO]', 'process_group_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.component_history_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.component_history_dto.ComponentHistoryDTO(component_id=None, property_history=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentHistoryDTO - a model defined in Swagger

attribute_map = {'component_id': 'componentId', 'property_history': 'propertyHistory'}

component_id

Gets the component_id of this ComponentHistoryDTO. The component id.

Returns:The component_id of this ComponentHistoryDTO. Return type:str

property_history

Gets the property_history of this ComponentHistoryDTO. The history for the properties of the component.

Returns:The property_history of this ComponentHistoryDTO. Return type:dict(str, PropertyHistoryDTO)

swagger_types = {'component_id': 'str', 'property_history': 'dict(str, PropertyHistoryDTO)'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.component_history_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.component_history_entity.ComponentHistoryEntity(component_history=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentHistoryEntity - a model defined in Swagger

attribute_map = {'component_history': 'componentHistory'}

component_history

Gets the component_history of this ComponentHistoryEntity.

Returns:The component_history of this ComponentHistoryEntity. Return type:ComponentHistoryDTO

swagger_types = {'component_history': 'ComponentHistoryDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.component_reference_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.component_reference_dto.ComponentReferenceDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentReferenceDTO - a model defined in Swagger

attribute_map = {'id': 'id', 'name': 'name', 'parent_group_id': 'parentGroupId', 'position': 'position', 'versioned_component_id': 'versionedComponentId'}

id

Gets the id of this ComponentReferenceDTO. The id of the component.

Returns:The id of this ComponentReferenceDTO. Return type:str

name

Gets the name of this ComponentReferenceDTO. The name of the component.

Returns:The name of this ComponentReferenceDTO. Return type:str

parent_group_id

Gets the parent_group_id of this ComponentReferenceDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this ComponentReferenceDTO. Return type:str

position

Gets the position of this ComponentReferenceDTO. The position of this component in the UI if applicable.

Returns:The position of this ComponentReferenceDTO. Return type:PositionDTO

swagger_types = {'id': 'str', 'name': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_component_id

Gets the versioned_component_id of this ComponentReferenceDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this ComponentReferenceDTO. Return type:str

nipyapi.nifi.models.component_reference_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.component_reference_entity.ComponentReferenceEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, parent_group_id=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentReferenceEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'parent_group_id': 'parentGroupId', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this ComponentReferenceEntity. The bulletins for this component.

Returns:The bulletins of this ComponentReferenceEntity. Return type:list[BulletinEntity]

component

Gets the component of this ComponentReferenceEntity.

Returns:The component of this ComponentReferenceEntity. Return type:ComponentReferenceDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ComponentReferenceEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ComponentReferenceEntity. Return type:bool

id

Gets the id of this ComponentReferenceEntity. The id of the component.

Returns:The id of this ComponentReferenceEntity. Return type:str

parent_group_id

Gets the parent_group_id of this ComponentReferenceEntity. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this ComponentReferenceEntity. Return type:str

permissions

Gets the permissions of this ComponentReferenceEntity. The permissions for this component.

Returns:The permissions of this ComponentReferenceEntity. Return type:PermissionsDTO

position

Gets the position of this ComponentReferenceEntity. The position of this component in the UI if applicable.

Returns:The position of this ComponentReferenceEntity. Return type:PositionDTO

revision

Gets the revision of this ComponentReferenceEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this ComponentReferenceEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'ComponentReferenceDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'parent_group_id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ComponentReferenceEntity. The URI for futures requests to the component.

Returns:The uri of this ComponentReferenceEntity. Return type:str

nipyapi.nifi.models.component_search_result_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.component_search_result_dto.ComponentSearchResultDTO(id=None, group_id=None, parent_group=None, versioned_group=None, name=None, matches=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentSearchResultDTO - a model defined in Swagger

attribute_map = {'group_id': 'groupId', 'id': 'id', 'matches': 'matches', 'name': 'name', 'parent_group': 'parentGroup', 'versioned_group': 'versionedGroup'}

group_id

Gets the group_id of this ComponentSearchResultDTO. The group id of the component that matched the search.

Returns:The group_id of this ComponentSearchResultDTO. Return type:str

id

Gets the id of this ComponentSearchResultDTO. The id of the component that matched the search.

Returns:The id of this ComponentSearchResultDTO. Return type:str

matches

Gets the matches of this ComponentSearchResultDTO. What matched the search from the component.

Returns:The matches of this ComponentSearchResultDTO. Return type:list[str]

name

Gets the name of this ComponentSearchResultDTO. The name of the component that matched the search.

Returns:The name of this ComponentSearchResultDTO. Return type:str

parent_group

Gets the parent_group of this ComponentSearchResultDTO. The parent group of the component that matched the search.

Returns:The parent_group of this ComponentSearchResultDTO. Return type:SearchResultGroupDTO

swagger_types = {'group_id': 'str', 'id': 'str', 'matches': 'list[str]', 'name': 'str', 'parent_group': 'SearchResultGroupDTO', 'versioned_group': 'SearchResultGroupDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_group

Gets the versioned_group of this ComponentSearchResultDTO. The nearest versioned ancestor group of the component that matched the search.

Returns:The versioned_group of this ComponentSearchResultDTO. Return type:SearchResultGroupDTO

nipyapi.nifi.models.component_state_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.component_state_dto.ComponentStateDTO(component_id=None, state_description=None, cluster_state=None, local_state=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentStateDTO - a model defined in Swagger

attribute_map = {'cluster_state': 'clusterState', 'component_id': 'componentId', 'local_state': 'localState', 'state_description': 'stateDescription'}

cluster_state

Gets the cluster_state of this ComponentStateDTO. The cluster state for this component, or null if this NiFi is a standalone instance.

Returns:The cluster_state of this ComponentStateDTO. Return type:StateMapDTO

component_id

Gets the component_id of this ComponentStateDTO. The component identifier.

Returns:The component_id of this ComponentStateDTO. Return type:str

local_state

Gets the local_state of this ComponentStateDTO. The local state for this component.

Returns:The local_state of this ComponentStateDTO. Return type:StateMapDTO

state_description

Gets the state_description of this ComponentStateDTO. Description of the state this component persists.

Returns:The state_description of this ComponentStateDTO. Return type:str

swagger_types = {'cluster_state': 'StateMapDTO', 'component_id': 'str', 'local_state': 'StateMapDTO', 'state_description': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.component_state_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.component_state_entity.ComponentStateEntity(component_state=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentStateEntity - a model defined in Swagger

attribute_map = {'component_state': 'componentState'}

component_state

Gets the component_state of this ComponentStateEntity. The component state.

Returns:The component_state of this ComponentStateEntity. Return type:ComponentStateDTO

swagger_types = {'component_state': 'ComponentStateDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.connectable_component 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.connectable_component.ConnectableComponent(id=None, type=None, group_id=None, name=None, comments=None, instance_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectableComponent - a model defined in Swagger

attribute_map = {'comments': 'comments', 'group_id': 'groupId', 'id': 'id', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'type': 'type'}

comments

Gets the comments of this ConnectableComponent. The comments for the connectable component.

Returns:The comments of this ConnectableComponent. Return type:str

group_id

Gets the group_id of this ConnectableComponent. The id of the group that the connectable component resides in

Returns:The group_id of this ConnectableComponent. Return type:str

id

Gets the id of this ConnectableComponent. The id of the connectable component.

Returns:The id of this ConnectableComponent. Return type:str

instance_identifier

Gets the instance_identifier of this ConnectableComponent. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this ConnectableComponent. Return type:str

name

Gets the name of this ConnectableComponent. The name of the connectable component

Returns:The name of this ConnectableComponent. Return type:str

swagger_types = {'comments': 'str', 'group_id': 'str', 'id': 'str', 'instance_identifier': 'str', 'name': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ConnectableComponent. The type of component the connectable is.

Returns:The type of this ConnectableComponent. Return type:str

nipyapi.nifi.models.connectable_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.connectable_dto.ConnectableDTO(id=None, versioned_component_id=None, type=None, group_id=None, name=None, running=None, transmitting=None, exists=None, comments=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectableDTO - a model defined in Swagger

attribute_map = {'comments': 'comments', 'exists': 'exists', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'running': 'running', 'transmitting': 'transmitting', 'type': 'type', 'versioned_component_id': 'versionedComponentId'}

comments

Gets the comments of this ConnectableDTO. The comments for the connectable component.

Returns:The comments of this ConnectableDTO. Return type:str

exists

Gets the exists of this ConnectableDTO. If the connectable component represents a remote port, indicates if the target exists.

Returns:The exists of this ConnectableDTO. Return type:bool

group_id

Gets the group_id of this ConnectableDTO. The id of the group that the connectable component resides in

Returns:The group_id of this ConnectableDTO. Return type:str

id

Gets the id of this ConnectableDTO. The id of the connectable component.

Returns:The id of this ConnectableDTO. Return type:str

name

Gets the name of this ConnectableDTO. The name of the connectable component

Returns:The name of this ConnectableDTO. Return type:str

running

Gets the running of this ConnectableDTO. Reflects the current state of the connectable component.

Returns:The running of this ConnectableDTO. Return type:bool

swagger_types = {'comments': 'str', 'exists': 'bool', 'group_id': 'str', 'id': 'str', 'name': 'str', 'running': 'bool', 'transmitting': 'bool', 'type': 'str', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transmitting

Gets the transmitting of this ConnectableDTO. If the connectable component represents a remote port, indicates if the target is configured to transmit.

Returns:The transmitting of this ConnectableDTO. Return type:bool

type

Gets the type of this ConnectableDTO. The type of component the connectable is.

Returns:The type of this ConnectableDTO. Return type:str

versioned_component_id

Gets the versioned_component_id of this ConnectableDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this ConnectableDTO. Return type:str

nipyapi.nifi.models.connection_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.connection_dto.ConnectionDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, source=None, destination=None, name=None, label_index=None, getz_index=None, selected_relationships=None, available_relationships=None, back_pressure_object_threshold=None, back_pressure_data_size_threshold=None, flow_file_expiration=None, prioritizers=None, bends=None, load_balance_strategy=None, load_balance_partition_attribute=None, load_balance_compression=None, load_balance_status=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionDTO - a model defined in Swagger

attribute_map = {'available_relationships': 'availableRelationships', 'back_pressure_data_size_threshold': 'backPressureDataSizeThreshold', 'back_pressure_object_threshold': 'backPressureObjectThreshold', 'bends': 'bends', 'destination': 'destination', 'flow_file_expiration': 'flowFileExpiration', 'getz_index': 'getzIndex', 'id': 'id', 'label_index': 'labelIndex', 'load_balance_compression': 'loadBalanceCompression', 'load_balance_partition_attribute': 'loadBalancePartitionAttribute', 'load_balance_status': 'loadBalanceStatus', 'load_balance_strategy': 'loadBalanceStrategy', 'name': 'name', 'parent_group_id': 'parentGroupId', 'position': 'position', 'prioritizers': 'prioritizers', 'selected_relationships': 'selectedRelationships', 'source': 'source', 'versioned_component_id': 'versionedComponentId'}

available_relationships

Gets the available_relationships of this ConnectionDTO. The relationships that the source of the connection currently supports.

Returns:The available_relationships of this ConnectionDTO. Return type:list[str]

back_pressure_data_size_threshold

Gets the back_pressure_data_size_threshold of this ConnectionDTO. The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won’t impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.

Returns:The back_pressure_data_size_threshold of this ConnectionDTO. Return type:str

back_pressure_object_threshold

Gets the back_pressure_object_threshold of this ConnectionDTO. The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won’t impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.

Returns:The back_pressure_object_threshold of this ConnectionDTO. Return type:int

bends

Gets the bends of this ConnectionDTO. The bend points on the connection.

Returns:The bends of this ConnectionDTO. Return type:list[PositionDTO]

destination

Gets the destination of this ConnectionDTO. The destination of the connection.

Returns:The destination of this ConnectionDTO. Return type:ConnectableDTO

flow_file_expiration

Gets the flow_file_expiration of this ConnectionDTO. The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it.

Returns:The flow_file_expiration of this ConnectionDTO. Return type:str

getz_index

Gets the getz_index of this ConnectionDTO. The z index of the connection.

Returns:The getz_index of this ConnectionDTO. Return type:int

id

Gets the id of this ConnectionDTO. The id of the component.

Returns:The id of this ConnectionDTO. Return type:str

label_index

Gets the label_index of this ConnectionDTO. The index of the bend point where to place the connection label.

Returns:The label_index of this ConnectionDTO. Return type:int

load_balance_compression

Gets the load_balance_compression of this ConnectionDTO. Whether or not data should be compressed when being transferred between nodes in the cluster.

Returns:The load_balance_compression of this ConnectionDTO. Return type:str

load_balance_partition_attribute

Gets the load_balance_partition_attribute of this ConnectionDTO. The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE

Returns:The load_balance_partition_attribute of this ConnectionDTO. Return type:str

load_balance_status

Gets the load_balance_status of this ConnectionDTO. The current status of the Connection’s Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.

Returns:The load_balance_status of this ConnectionDTO. Return type:str

load_balance_strategy

Gets the load_balance_strategy of this ConnectionDTO. How to load balance the data in this Connection across the nodes in the cluster.

Returns:The load_balance_strategy of this ConnectionDTO. Return type:str

name

Gets the name of this ConnectionDTO. The name of the connection.

Returns:The name of this ConnectionDTO. Return type:str

parent_group_id

Gets the parent_group_id of this ConnectionDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this ConnectionDTO. Return type:str

position

Gets the position of this ConnectionDTO. The position of this component in the UI if applicable.

Returns:The position of this ConnectionDTO. Return type:PositionDTO

prioritizers

Gets the prioritizers of this ConnectionDTO. The comparators used to prioritize the queue.

Returns:The prioritizers of this ConnectionDTO. Return type:list[str]

selected_relationships

Gets the selected_relationships of this ConnectionDTO. The selected relationship that comprise the connection.

Returns:The selected_relationships of this ConnectionDTO. Return type:list[str]

source

Gets the source of this ConnectionDTO. The source of the connection.

Returns:The source of this ConnectionDTO. Return type:ConnectableDTO

swagger_types = {'available_relationships': 'list[str]', 'back_pressure_data_size_threshold': 'str', 'back_pressure_object_threshold': 'int', 'bends': 'list[PositionDTO]', 'destination': 'ConnectableDTO', 'flow_file_expiration': 'str', 'getz_index': 'int', 'id': 'str', 'label_index': 'int', 'load_balance_compression': 'str', 'load_balance_partition_attribute': 'str', 'load_balance_status': 'str', 'load_balance_strategy': 'str', 'name': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'prioritizers': 'list[str]', 'selected_relationships': 'list[str]', 'source': 'ConnectableDTO', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_component_id

Gets the versioned_component_id of this ConnectionDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this ConnectionDTO. Return type:str

nipyapi.nifi.models.connection_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.connection_entity.ConnectionEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, bends=None, label_index=None, getz_index=None, source_id=None, source_group_id=None, source_type=None, destination_id=None, destination_group_id=None, destination_type=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionEntity - a model defined in Swagger

attribute_map = {'bends': 'bends', 'bulletins': 'bulletins', 'component': 'component', 'destination_group_id': 'destinationGroupId', 'destination_id': 'destinationId', 'destination_type': 'destinationType', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'getz_index': 'getzIndex', 'id': 'id', 'label_index': 'labelIndex', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'source_group_id': 'sourceGroupId', 'source_id': 'sourceId', 'source_type': 'sourceType', 'status': 'status', 'uri': 'uri'}

bends

Gets the bends of this ConnectionEntity. The bend points on the connection.

Returns:The bends of this ConnectionEntity. Return type:list[PositionDTO]

bulletins

Gets the bulletins of this ConnectionEntity. The bulletins for this component.

Returns:The bulletins of this ConnectionEntity. Return type:list[BulletinEntity]

component

Gets the component of this ConnectionEntity.

Returns:The component of this ConnectionEntity. Return type:ConnectionDTO

destination_group_id

Gets the destination_group_id of this ConnectionEntity. The identifier of the group of the destination of this connection.

Returns:The destination_group_id of this ConnectionEntity. Return type:str

destination_id

Gets the destination_id of this ConnectionEntity. The identifier of the destination of this connection.

Returns:The destination_id of this ConnectionEntity. Return type:str

destination_type

Gets the destination_type of this ConnectionEntity. The type of component the destination connectable is.

Returns:The destination_type of this ConnectionEntity. Return type:str

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ConnectionEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ConnectionEntity. Return type:bool

getz_index

Gets the getz_index of this ConnectionEntity. The z index of the connection.

Returns:The getz_index of this ConnectionEntity. Return type:int

id

Gets the id of this ConnectionEntity. The id of the component.

Returns:The id of this ConnectionEntity. Return type:str

label_index

Gets the label_index of this ConnectionEntity. The index of the bend point where to place the connection label.

Returns:The label_index of this ConnectionEntity. Return type:int

permissions

Gets the permissions of this ConnectionEntity. The permissions for this component.

Returns:The permissions of this ConnectionEntity. Return type:PermissionsDTO

position

Gets the position of this ConnectionEntity. The position of this component in the UI if applicable.

Returns:The position of this ConnectionEntity. Return type:PositionDTO

revision

Gets the revision of this ConnectionEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this ConnectionEntity. Return type:RevisionDTO

source_group_id

Gets the source_group_id of this ConnectionEntity. The identifier of the group of the source of this connection.

Returns:The source_group_id of this ConnectionEntity. Return type:str

source_id

Gets the source_id of this ConnectionEntity. The identifier of the source of this connection.

Returns:The source_id of this ConnectionEntity. Return type:str

source_type

Gets the source_type of this ConnectionEntity. The type of component the source connectable is.

Returns:The source_type of this ConnectionEntity. Return type:str

status

Gets the status of this ConnectionEntity. The status of the connection.

Returns:The status of this ConnectionEntity. Return type:ConnectionStatusDTO

swagger_types = {'bends': 'list[PositionDTO]', 'bulletins': 'list[BulletinEntity]', 'component': 'ConnectionDTO', 'destination_group_id': 'str', 'destination_id': 'str', 'destination_type': 'str', 'disconnected_node_acknowledged': 'bool', 'getz_index': 'int', 'id': 'str', 'label_index': 'int', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'source_group_id': 'str', 'source_id': 'str', 'source_type': 'str', 'status': 'ConnectionStatusDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ConnectionEntity. The URI for futures requests to the component.

Returns:The uri of this ConnectionEntity. Return type:str

nipyapi.nifi.models.connection_status_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.connection_status_dto.ConnectionStatusDTO(id=None, group_id=None, name=None, stats_last_refreshed=None, source_id=None, source_name=None, destination_id=None, destination_name=None, aggregate_snapshot=None, node_snapshots=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionStatusDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this ConnectionStatusDTO. The status snapshot that represents the aggregate stats of the cluster

Returns:The aggregate_snapshot of this ConnectionStatusDTO. Return type:ConnectionStatusSnapshotDTO

attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'destination_id': 'destinationId', 'destination_name': 'destinationName', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'node_snapshots': 'nodeSnapshots', 'source_id': 'sourceId', 'source_name': 'sourceName', 'stats_last_refreshed': 'statsLastRefreshed'}

destination_id

Gets the destination_id of this ConnectionStatusDTO. The ID of the destination component

Returns:The destination_id of this ConnectionStatusDTO. Return type:str

destination_name

Gets the destination_name of this ConnectionStatusDTO. The name of the destination component

Returns:The destination_name of this ConnectionStatusDTO. Return type:str

group_id

Gets the group_id of this ConnectionStatusDTO. The ID of the Process Group that the connection belongs to

Returns:The group_id of this ConnectionStatusDTO. Return type:str

id

Gets the id of this ConnectionStatusDTO. The ID of the connection

Returns:The id of this ConnectionStatusDTO. Return type:str

name

Gets the name of this ConnectionStatusDTO. The name of the connection

Returns:The name of this ConnectionStatusDTO. Return type:str

node_snapshots

Gets the node_snapshots of this ConnectionStatusDTO. A list of status snapshots for each node

Returns:The node_snapshots of this ConnectionStatusDTO. Return type:list[NodeConnectionStatusSnapshotDTO]

source_id

Gets the source_id of this ConnectionStatusDTO. The ID of the source component

Returns:The source_id of this ConnectionStatusDTO. Return type:str

source_name

Gets the source_name of this ConnectionStatusDTO. The name of the source component

Returns:The source_name of this ConnectionStatusDTO. Return type:str

stats_last_refreshed

Gets the stats_last_refreshed of this ConnectionStatusDTO. The timestamp of when the stats were last refreshed

Returns:The stats_last_refreshed of this ConnectionStatusDTO. Return type:str

swagger_types = {'aggregate_snapshot': 'ConnectionStatusSnapshotDTO', 'destination_id': 'str', 'destination_name': 'str', 'group_id': 'str', 'id': 'str', 'name': 'str', 'node_snapshots': 'list[NodeConnectionStatusSnapshotDTO]', 'source_id': 'str', 'source_name': 'str', 'stats_last_refreshed': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.connection_status_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.connection_status_entity.ConnectionStatusEntity(connection_status=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionStatusEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'connection_status': 'connectionStatus'}

can_read

Gets the can_read of this ConnectionStatusEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this ConnectionStatusEntity. Return type:bool

connection_status

Gets the connection_status of this ConnectionStatusEntity.

Returns:The connection_status of this ConnectionStatusEntity. Return type:ConnectionStatusDTO

swagger_types = {'can_read': 'bool', 'connection_status': 'ConnectionStatusDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.connection_status_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.connection_status_snapshot_dto.ConnectionStatusSnapshotDTO(id=None, group_id=None, name=None, source_id=None, source_name=None, destination_id=None, destination_name=None, predictions=None, flow_files_in=None, bytes_in=None, input=None, flow_files_out=None, bytes_out=None, output=None, flow_files_queued=None, bytes_queued=None, queued=None, queued_size=None, queued_count=None, percent_use_count=None, percent_use_bytes=None, flow_file_availability=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionStatusSnapshotDTO - a model defined in Swagger

attribute_map = {'bytes_in': 'bytesIn', 'bytes_out': 'bytesOut', 'bytes_queued': 'bytesQueued', 'destination_id': 'destinationId', 'destination_name': 'destinationName', 'flow_file_availability': 'flowFileAvailability', 'flow_files_in': 'flowFilesIn', 'flow_files_out': 'flowFilesOut', 'flow_files_queued': 'flowFilesQueued', 'group_id': 'groupId', 'id': 'id', 'input': 'input', 'name': 'name', 'output': 'output', 'percent_use_bytes': 'percentUseBytes', 'percent_use_count': 'percentUseCount', 'predictions': 'predictions', 'queued': 'queued', 'queued_count': 'queuedCount', 'queued_size': 'queuedSize', 'source_id': 'sourceId', 'source_name': 'sourceName'}

bytes_in

Gets the bytes_in of this ConnectionStatusSnapshotDTO. The size of the FlowFiles that have come into the connection in the last 5 minutes.

Returns:The bytes_in of this ConnectionStatusSnapshotDTO. Return type:int

bytes_out

Gets the bytes_out of this ConnectionStatusSnapshotDTO. The number of bytes that have left the connection in the last 5 minutes.

Returns:The bytes_out of this ConnectionStatusSnapshotDTO. Return type:int

bytes_queued

Gets the bytes_queued of this ConnectionStatusSnapshotDTO. The size of the FlowFiles that are currently queued in the connection.

Returns:The bytes_queued of this ConnectionStatusSnapshotDTO. Return type:int

destination_id

Gets the destination_id of this ConnectionStatusSnapshotDTO. The id of the destination of the connection.

Returns:The destination_id of this ConnectionStatusSnapshotDTO. Return type:str

destination_name

Gets the destination_name of this ConnectionStatusSnapshotDTO. The name of the destination of the connection.

Returns:The destination_name of this ConnectionStatusSnapshotDTO. Return type:str

flow_file_availability

Gets the flow_file_availability of this ConnectionStatusSnapshotDTO. The availability of FlowFiles in this connection

Returns:The flow_file_availability of this ConnectionStatusSnapshotDTO. Return type:str

flow_files_in

Gets the flow_files_in of this ConnectionStatusSnapshotDTO. The number of FlowFiles that have come into the connection in the last 5 minutes.

Returns:The flow_files_in of this ConnectionStatusSnapshotDTO. Return type:int

flow_files_out

Gets the flow_files_out of this ConnectionStatusSnapshotDTO. The number of FlowFiles that have left the connection in the last 5 minutes.

Returns:The flow_files_out of this ConnectionStatusSnapshotDTO. Return type:int

flow_files_queued

Gets the flow_files_queued of this ConnectionStatusSnapshotDTO. The number of FlowFiles that are currently queued in the connection.

Returns:The flow_files_queued of this ConnectionStatusSnapshotDTO. Return type:int

group_id

Gets the group_id of this ConnectionStatusSnapshotDTO. The id of the process group the connection belongs to.

Returns:The group_id of this ConnectionStatusSnapshotDTO. Return type:str

id

Gets the id of this ConnectionStatusSnapshotDTO. The id of the connection.

Returns:The id of this ConnectionStatusSnapshotDTO. Return type:str

input

Gets the input of this ConnectionStatusSnapshotDTO. The input count/size for the connection in the last 5 minutes, pretty printed.

Returns:The input of this ConnectionStatusSnapshotDTO. Return type:str

name

Gets the name of this ConnectionStatusSnapshotDTO. The name of the connection.

Returns:The name of this ConnectionStatusSnapshotDTO. Return type:str

output

Gets the output of this ConnectionStatusSnapshotDTO. The output count/sie for the connection in the last 5 minutes, pretty printed.

Returns:The output of this ConnectionStatusSnapshotDTO. Return type:str

percent_use_bytes

Gets the percent_use_bytes of this ConnectionStatusSnapshotDTO. Connection percent use regarding queued flow files size and backpressure threshold if configured.

Returns:The percent_use_bytes of this ConnectionStatusSnapshotDTO. Return type:int

percent_use_count

Gets the percent_use_count of this ConnectionStatusSnapshotDTO. Connection percent use regarding queued flow files count and backpressure threshold if configured.

Returns:The percent_use_count of this ConnectionStatusSnapshotDTO. Return type:int

predictions

Gets the predictions of this ConnectionStatusSnapshotDTO. Predictions, if available, for this connection (null if not available)

Returns:The predictions of this ConnectionStatusSnapshotDTO. Return type:ConnectionStatusPredictionsSnapshotDTO

queued

Gets the queued of this ConnectionStatusSnapshotDTO. The total count and size of queued flowfiles formatted.

Returns:The queued of this ConnectionStatusSnapshotDTO. Return type:str

queued_count

Gets the queued_count of this ConnectionStatusSnapshotDTO. The number of flowfiles that are queued, pretty printed.

Returns:The queued_count of this ConnectionStatusSnapshotDTO. Return type:str

queued_size

Gets the queued_size of this ConnectionStatusSnapshotDTO. The total size of flowfiles that are queued formatted.

Returns:The queued_size of this ConnectionStatusSnapshotDTO. Return type:str

source_id

Gets the source_id of this ConnectionStatusSnapshotDTO. The id of the source of the connection.

Returns:The source_id of this ConnectionStatusSnapshotDTO. Return type:str

source_name

Gets the source_name of this ConnectionStatusSnapshotDTO. The name of the source of the connection.

Returns:The source_name of this ConnectionStatusSnapshotDTO. Return type:str

swagger_types = {'bytes_in': 'int', 'bytes_out': 'int', 'bytes_queued': 'int', 'destination_id': 'str', 'destination_name': 'str', 'flow_file_availability': 'str', 'flow_files_in': 'int', 'flow_files_out': 'int', 'flow_files_queued': 'int', 'group_id': 'str', 'id': 'str', 'input': 'str', 'name': 'str', 'output': 'str', 'percent_use_bytes': 'int', 'percent_use_count': 'int', 'predictions': 'ConnectionStatusPredictionsSnapshotDTO', 'queued': 'str', 'queued_count': 'str', 'queued_size': 'str', 'source_id': 'str', 'source_name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.connection_status_snapshot_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.connection_status_snapshot_entity.ConnectionStatusSnapshotEntity(id=None, connection_status_snapshot=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionStatusSnapshotEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'connection_status_snapshot': 'connectionStatusSnapshot', 'id': 'id'}

can_read

Gets the can_read of this ConnectionStatusSnapshotEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this ConnectionStatusSnapshotEntity. Return type:bool

connection_status_snapshot

Gets the connection_status_snapshot of this ConnectionStatusSnapshotEntity.

Returns:The connection_status_snapshot of this ConnectionStatusSnapshotEntity. Return type:ConnectionStatusSnapshotDTO

id

Gets the id of this ConnectionStatusSnapshotEntity. The id of the connection.

Returns:The id of this ConnectionStatusSnapshotEntity. Return type:str

swagger_types = {'can_read': 'bool', 'connection_status_snapshot': 'ConnectionStatusSnapshotDTO', 'id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.connections_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.connections_entity.ConnectionsEntity(connections=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionsEntity - a model defined in Swagger

attribute_map = {'connections': 'connections'}

connections

Gets the connections of this ConnectionsEntity.

Returns:The connections of this ConnectionsEntity. Return type:list[ConnectionEntity]

swagger_types = {'connections': 'list[ConnectionEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_bulletins_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_bulletins_entity.ControllerBulletinsEntity(bulletins=None, controller_service_bulletins=None, reporting_task_bulletins=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerBulletinsEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'controller_service_bulletins': 'controllerServiceBulletins', 'reporting_task_bulletins': 'reportingTaskBulletins'}

bulletins

Gets the bulletins of this ControllerBulletinsEntity. System level bulletins to be reported to the user.

Returns:The bulletins of this ControllerBulletinsEntity. Return type:list[BulletinEntity]

controller_service_bulletins

Gets the controller_service_bulletins of this ControllerBulletinsEntity. Controller service bulletins to be reported to the user.

Returns:The controller_service_bulletins of this ControllerBulletinsEntity. Return type:list[BulletinEntity]

reporting_task_bulletins

Gets the reporting_task_bulletins of this ControllerBulletinsEntity. Reporting task bulletins to be reported to the user.

Returns:The reporting_task_bulletins of this ControllerBulletinsEntity. Return type:list[BulletinEntity]

swagger_types = {'bulletins': 'list[BulletinEntity]', 'controller_service_bulletins': 'list[BulletinEntity]', 'reporting_task_bulletins': 'list[BulletinEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_configuration_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_configuration_dto.ControllerConfigurationDTO(max_timer_driven_thread_count=None, max_event_driven_thread_count=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerConfigurationDTO - a model defined in Swagger

attribute_map = {'max_event_driven_thread_count': 'maxEventDrivenThreadCount', 'max_timer_driven_thread_count': 'maxTimerDrivenThreadCount'}

max_event_driven_thread_count

Gets the max_event_driven_thread_count of this ControllerConfigurationDTO. The maximum number of event driven threads the NiFi has available.

Returns:The max_event_driven_thread_count of this ControllerConfigurationDTO. Return type:int

max_timer_driven_thread_count

Gets the max_timer_driven_thread_count of this ControllerConfigurationDTO. The maximum number of timer driven threads the NiFi has available.

Returns:The max_timer_driven_thread_count of this ControllerConfigurationDTO. Return type:int

swagger_types = {'max_event_driven_thread_count': 'int', 'max_timer_driven_thread_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_configuration_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_configuration_entity.ControllerConfigurationEntity(revision=None, permissions=None, disconnected_node_acknowledged=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerConfigurationEntity - a model defined in Swagger

attribute_map = {'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'permissions': 'permissions', 'revision': 'revision'}

component

Gets the component of this ControllerConfigurationEntity. The controller configuration.

Returns:The component of this ControllerConfigurationEntity. Return type:ControllerConfigurationDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ControllerConfigurationEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ControllerConfigurationEntity. Return type:bool

permissions

Gets the permissions of this ControllerConfigurationEntity. The permissions for this component.

Returns:The permissions of this ControllerConfigurationEntity. Return type:PermissionsDTO

revision

Gets the revision of this ControllerConfigurationEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this ControllerConfigurationEntity. Return type:RevisionDTO

swagger_types = {'component': 'ControllerConfigurationDTO', 'disconnected_node_acknowledged': 'bool', 'permissions': 'PermissionsDTO', 'revision': 'RevisionDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_dto.ControllerDTO(id=None, name=None, comments=None, running_count=None, stopped_count=None, invalid_count=None, disabled_count=None, active_remote_port_count=None, inactive_remote_port_count=None, input_port_count=None, output_port_count=None, remote_site_listening_port=None, remote_site_http_listening_port=None, site_to_site_secure=None, instance_id=None, input_ports=None, output_ports=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerDTO - a model defined in Swagger

active_remote_port_count

Gets the active_remote_port_count of this ControllerDTO. The number of active remote ports contained in the NiFi.

Returns:The active_remote_port_count of this ControllerDTO. Return type:int

attribute_map = {'active_remote_port_count': 'activeRemotePortCount', 'comments': 'comments', 'disabled_count': 'disabledCount', 'id': 'id', 'inactive_remote_port_count': 'inactiveRemotePortCount', 'input_port_count': 'inputPortCount', 'input_ports': 'inputPorts', 'instance_id': 'instanceId', 'invalid_count': 'invalidCount', 'name': 'name', 'output_port_count': 'outputPortCount', 'output_ports': 'outputPorts', 'remote_site_http_listening_port': 'remoteSiteHttpListeningPort', 'remote_site_listening_port': 'remoteSiteListeningPort', 'running_count': 'runningCount', 'site_to_site_secure': 'siteToSiteSecure', 'stopped_count': 'stoppedCount'}

comments

Gets the comments of this ControllerDTO. The comments for the NiFi.

Returns:The comments of this ControllerDTO. Return type:str

disabled_count

Gets the disabled_count of this ControllerDTO. The number of disabled components in the NiFi.

Returns:The disabled_count of this ControllerDTO. Return type:int

id

Gets the id of this ControllerDTO. The id of the NiFi.

Returns:The id of this ControllerDTO. Return type:str

inactive_remote_port_count

Gets the inactive_remote_port_count of this ControllerDTO. The number of inactive remote ports contained in the NiFi.

Returns:The inactive_remote_port_count of this ControllerDTO. Return type:int

input_port_count

Gets the input_port_count of this ControllerDTO. The number of input ports contained in the NiFi.

Returns:The input_port_count of this ControllerDTO. Return type:int

input_ports

Gets the input_ports of this ControllerDTO. The input ports available to send data to for the NiFi.

Returns:The input_ports of this ControllerDTO. Return type:list[PortDTO]

instance_id

Gets the instance_id of this ControllerDTO. If clustered, the id of the Cluster Manager, otherwise the id of the NiFi.

Returns:The instance_id of this ControllerDTO. Return type:str

invalid_count

Gets the invalid_count of this ControllerDTO. The number of invalid components in the NiFi.

Returns:The invalid_count of this ControllerDTO. Return type:int

name

Gets the name of this ControllerDTO. The name of the NiFi.

Returns:The name of this ControllerDTO. Return type:str

output_port_count

Gets the output_port_count of this ControllerDTO. The number of output ports in the NiFi.

Returns:The output_port_count of this ControllerDTO. Return type:int

output_ports

Gets the output_ports of this ControllerDTO. The output ports available to received data from the NiFi.

Returns:The output_ports of this ControllerDTO. Return type:list[PortDTO]

remote_site_http_listening_port

Gets the remote_site_http_listening_port of this ControllerDTO. The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null.

Returns:The remote_site_http_listening_port of this ControllerDTO. Return type:int

remote_site_listening_port

Gets the remote_site_listening_port of this ControllerDTO. The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null.

Returns:The remote_site_listening_port of this ControllerDTO. Return type:int

running_count

Gets the running_count of this ControllerDTO. The number of running components in the NiFi.

Returns:The running_count of this ControllerDTO. Return type:int

site_to_site_secure

Gets the site_to_site_secure of this ControllerDTO. Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication).

Returns:The site_to_site_secure of this ControllerDTO. Return type:bool

stopped_count

Gets the stopped_count of this ControllerDTO. The number of stopped components in the NiFi.

Returns:The stopped_count of this ControllerDTO. Return type:int

swagger_types = {'active_remote_port_count': 'int', 'comments': 'str', 'disabled_count': 'int', 'id': 'str', 'inactive_remote_port_count': 'int', 'input_port_count': 'int', 'input_ports': 'list[PortDTO]', 'instance_id': 'str', 'invalid_count': 'int', 'name': 'str', 'output_port_count': 'int', 'output_ports': 'list[PortDTO]', 'remote_site_http_listening_port': 'int', 'remote_site_listening_port': 'int', 'running_count': 'int', 'site_to_site_secure': 'bool', 'stopped_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_entity.ControllerEntity(controller=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerEntity - a model defined in Swagger

attribute_map = {'controller': 'controller'}

controller

Gets the controller of this ControllerEntity.

Returns:The controller of this ControllerEntity. Return type:ControllerDTO

swagger_types = {'controller': 'ControllerDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_service_api 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_service_api.ControllerServiceAPI(type=None, bundle=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceAPI - a model defined in Swagger

attribute_map = {'bundle': 'bundle', 'type': 'type'}

bundle

Gets the bundle of this ControllerServiceAPI. The details of the artifact that bundled this service interface.

Returns:The bundle of this ControllerServiceAPI. Return type:Bundle

swagger_types = {'bundle': 'Bundle', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ControllerServiceAPI. The fully qualified name of the service interface.

Returns:The type of this ControllerServiceAPI. Return type:str

nipyapi.nifi.models.controller_service_api_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_service_api_dto.ControllerServiceApiDTO(type=None, bundle=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceApiDTO - a model defined in Swagger

attribute_map = {'bundle': 'bundle', 'type': 'type'}

bundle

Gets the bundle of this ControllerServiceApiDTO. The details of the artifact that bundled this service interface.

Returns:The bundle of this ControllerServiceApiDTO. Return type:BundleDTO

swagger_types = {'bundle': 'BundleDTO', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ControllerServiceApiDTO. The fully qualified name of the service interface.

Returns:The type of this ControllerServiceApiDTO. Return type:str

nipyapi.nifi.models.controller_service_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_service_dto.ControllerServiceDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, type=None, bundle=None, controller_service_apis=None, comments=None, state=None, persists_state=None, restricted=None, deprecated=None, multiple_versions_available=None, supports_sensitive_dynamic_properties=None, properties=None, descriptors=None, sensitive_dynamic_property_names=None, custom_ui_url=None, annotation_data=None, referencing_components=None, validation_errors=None, validation_status=None, bulletin_level=None, extension_missing=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceDTO - a model defined in Swagger

annotation_data

Gets the annotation_data of this ControllerServiceDTO. The annotation for the controller service. This is how the custom UI relays configuration to the controller service.

Returns:The annotation_data of this ControllerServiceDTO. Return type:str

attribute_map = {'annotation_data': 'annotationData', 'bulletin_level': 'bulletinLevel', 'bundle': 'bundle', 'comments': 'comments', 'controller_service_apis': 'controllerServiceApis', 'custom_ui_url': 'customUiUrl', 'deprecated': 'deprecated', 'descriptors': 'descriptors', 'extension_missing': 'extensionMissing', 'id': 'id', 'multiple_versions_available': 'multipleVersionsAvailable', 'name': 'name', 'parent_group_id': 'parentGroupId', 'persists_state': 'persistsState', 'position': 'position', 'properties': 'properties', 'referencing_components': 'referencingComponents', 'restricted': 'restricted', 'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', 'state': 'state', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'type': 'type', 'validation_errors': 'validationErrors', 'validation_status': 'validationStatus', 'versioned_component_id': 'versionedComponentId'}

bulletin_level

Gets the bulletin_level of this ControllerServiceDTO. The level at which the controller service will report bulletins.

Returns:The bulletin_level of this ControllerServiceDTO. Return type:str

bundle

Gets the bundle of this ControllerServiceDTO. The details of the artifact that bundled this processor type.

Returns:The bundle of this ControllerServiceDTO. Return type:BundleDTO

comments

Gets the comments of this ControllerServiceDTO. The comments for the controller service.

Returns:The comments of this ControllerServiceDTO. Return type:str

controller_service_apis

Gets the controller_service_apis of this ControllerServiceDTO. Lists the APIs this Controller Service implements.

Returns:The controller_service_apis of this ControllerServiceDTO. Return type:list[ControllerServiceApiDTO]

custom_ui_url

Gets the custom_ui_url of this ControllerServiceDTO. The URL for the controller services custom configuration UI if applicable.

Returns:The custom_ui_url of this ControllerServiceDTO. Return type:str

deprecated

Gets the deprecated of this ControllerServiceDTO. Whether the ontroller service has been deprecated.

Returns:The deprecated of this ControllerServiceDTO. Return type:bool

descriptors

Gets the descriptors of this ControllerServiceDTO. The descriptors for the controller service properties.

Returns:The descriptors of this ControllerServiceDTO. Return type:dict(str, PropertyDescriptorDTO)

extension_missing

Gets the extension_missing of this ControllerServiceDTO. Whether the underlying extension is missing.

Returns:The extension_missing of this ControllerServiceDTO. Return type:bool

id

Gets the id of this ControllerServiceDTO. The id of the component.

Returns:The id of this ControllerServiceDTO. Return type:str

multiple_versions_available

Gets the multiple_versions_available of this ControllerServiceDTO. Whether the controller service has multiple versions available.

Returns:The multiple_versions_available of this ControllerServiceDTO. Return type:bool

name

Gets the name of this ControllerServiceDTO. The name of the controller service.

Returns:The name of this ControllerServiceDTO. Return type:str

parent_group_id

Gets the parent_group_id of this ControllerServiceDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this ControllerServiceDTO. Return type:str

persists_state

Gets the persists_state of this ControllerServiceDTO. Whether the controller service persists state.

Returns:The persists_state of this ControllerServiceDTO. Return type:bool

position

Gets the position of this ControllerServiceDTO. The position of this component in the UI if applicable.

Returns:The position of this ControllerServiceDTO. Return type:PositionDTO

properties

Gets the properties of this ControllerServiceDTO. The properties of the controller service.

Returns:The properties of this ControllerServiceDTO. Return type:dict(str, str)

referencing_components

Gets the referencing_components of this ControllerServiceDTO. All components referencing this controller service.

Returns:The referencing_components of this ControllerServiceDTO. Return type:list[ControllerServiceReferencingComponentEntity]

restricted

Gets the restricted of this ControllerServiceDTO. Whether the controller service requires elevated privileges.

Returns:The restricted of this ControllerServiceDTO. Return type:bool

sensitive_dynamic_property_names

Gets the sensitive_dynamic_property_names of this ControllerServiceDTO. Set of sensitive dynamic property names

Returns:The sensitive_dynamic_property_names of this ControllerServiceDTO. Return type:list[str]

state

Gets the state of this ControllerServiceDTO. The state of the controller service.

Returns:The state of this ControllerServiceDTO. Return type:str

supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this ControllerServiceDTO. Whether the controller service supports sensitive dynamic properties.

Returns:The supports_sensitive_dynamic_properties of this ControllerServiceDTO. Return type:bool

swagger_types = {'annotation_data': 'str', 'bulletin_level': 'str', 'bundle': 'BundleDTO', 'comments': 'str', 'controller_service_apis': 'list[ControllerServiceApiDTO]', 'custom_ui_url': 'str', 'deprecated': 'bool', 'descriptors': 'dict(str, PropertyDescriptorDTO)', 'extension_missing': 'bool', 'id': 'str', 'multiple_versions_available': 'bool', 'name': 'str', 'parent_group_id': 'str', 'persists_state': 'bool', 'position': 'PositionDTO', 'properties': 'dict(str, str)', 'referencing_components': 'list[ControllerServiceReferencingComponentEntity]', 'restricted': 'bool', 'sensitive_dynamic_property_names': 'list[str]', 'state': 'str', 'supports_sensitive_dynamic_properties': 'bool', 'type': 'str', 'validation_errors': 'list[str]', 'validation_status': 'str', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ControllerServiceDTO. The type of the controller service.

Returns:The type of this ControllerServiceDTO. Return type:str

validation_errors

Gets the validation_errors of this ControllerServiceDTO. The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.

Returns:The validation_errors of this ControllerServiceDTO. Return type:list[str]

validation_status

Gets the validation_status of this ControllerServiceDTO. Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)

Returns:The validation_status of this ControllerServiceDTO. Return type:str

versioned_component_id

Gets the versioned_component_id of this ControllerServiceDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this ControllerServiceDTO. Return type:str

nipyapi.nifi.models.controller_service_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_service_entity.ControllerServiceEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, parent_group_id=None, component=None, operate_permissions=None, status=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'operate_permissions': 'operatePermissions', 'parent_group_id': 'parentGroupId', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'status': 'status', 'uri': 'uri'}

bulletins

Gets the bulletins of this ControllerServiceEntity. The bulletins for this component.

Returns:The bulletins of this ControllerServiceEntity. Return type:list[BulletinEntity]

component

Gets the component of this ControllerServiceEntity.

Returns:The component of this ControllerServiceEntity. Return type:ControllerServiceDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ControllerServiceEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ControllerServiceEntity. Return type:bool

id

Gets the id of this ControllerServiceEntity. The id of the component.

Returns:The id of this ControllerServiceEntity. Return type:str

operate_permissions

Gets the operate_permissions of this ControllerServiceEntity. The permissions for this component operations.

Returns:The operate_permissions of this ControllerServiceEntity. Return type:PermissionsDTO

parent_group_id

Gets the parent_group_id of this ControllerServiceEntity. The id of parent process group of this ControllerService.

Returns:The parent_group_id of this ControllerServiceEntity. Return type:str

permissions

Gets the permissions of this ControllerServiceEntity. The permissions for this component.

Returns:The permissions of this ControllerServiceEntity. Return type:PermissionsDTO

position

Gets the position of this ControllerServiceEntity. The position of this component in the UI if applicable.

Returns:The position of this ControllerServiceEntity. Return type:PositionDTO

revision

Gets the revision of this ControllerServiceEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this ControllerServiceEntity. Return type:RevisionDTO

status

Gets the status of this ControllerServiceEntity. The status for this ControllerService.

Returns:The status of this ControllerServiceEntity. Return type:ControllerServiceStatusDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'ControllerServiceDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'operate_permissions': 'PermissionsDTO', 'parent_group_id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'status': 'ControllerServiceStatusDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ControllerServiceEntity. The URI for futures requests to the component.

Returns:The uri of this ControllerServiceEntity. Return type:str

nipyapi.nifi.models.controller_service_referencing_component_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_service_referencing_component_dto.ControllerServiceReferencingComponentDTO(group_id=None, id=None, name=None, type=None, state=None, properties=None, descriptors=None, validation_errors=None, reference_type=None, active_thread_count=None, reference_cycle=None, referencing_components=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceReferencingComponentDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this ControllerServiceReferencingComponentDTO. The number of active threads for the referencing component.

Returns:The active_thread_count of this ControllerServiceReferencingComponentDTO. Return type:int

attribute_map = {'active_thread_count': 'activeThreadCount', 'descriptors': 'descriptors', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'properties': 'properties', 'reference_cycle': 'referenceCycle', 'reference_type': 'referenceType', 'referencing_components': 'referencingComponents', 'state': 'state', 'type': 'type', 'validation_errors': 'validationErrors'}

descriptors

Gets the descriptors of this ControllerServiceReferencingComponentDTO. The descriptors for the component properties.

Returns:The descriptors of this ControllerServiceReferencingComponentDTO. Return type:dict(str, PropertyDescriptorDTO)

group_id

Gets the group_id of this ControllerServiceReferencingComponentDTO. The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank.

Returns:The group_id of this ControllerServiceReferencingComponentDTO. Return type:str

id

Gets the id of this ControllerServiceReferencingComponentDTO. The id of the component referencing a controller service.

Returns:The id of this ControllerServiceReferencingComponentDTO. Return type:str

name

Gets the name of this ControllerServiceReferencingComponentDTO. The name of the component referencing a controller service.

Returns:The name of this ControllerServiceReferencingComponentDTO. Return type:str

properties

Gets the properties of this ControllerServiceReferencingComponentDTO. The properties for the component.

Returns:The properties of this ControllerServiceReferencingComponentDTO. Return type:dict(str, str)

reference_cycle

Gets the reference_cycle of this ControllerServiceReferencingComponentDTO. If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy.

Returns:The reference_cycle of this ControllerServiceReferencingComponentDTO. Return type:bool

reference_type

Gets the reference_type of this ControllerServiceReferencingComponentDTO. The type of reference this is.

Returns:The reference_type of this ControllerServiceReferencingComponentDTO. Return type:str

referencing_components

Gets the referencing_components of this ControllerServiceReferencingComponentDTO. If the referencing component represents a controller service, these are the components that reference it.

Returns:The referencing_components of this ControllerServiceReferencingComponentDTO. Return type:list[ControllerServiceReferencingComponentEntity]

state

Gets the state of this ControllerServiceReferencingComponentDTO. The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state.

Returns:The state of this ControllerServiceReferencingComponentDTO. Return type:str

swagger_types = {'active_thread_count': 'int', 'descriptors': 'dict(str, PropertyDescriptorDTO)', 'group_id': 'str', 'id': 'str', 'name': 'str', 'properties': 'dict(str, str)', 'reference_cycle': 'bool', 'reference_type': 'str', 'referencing_components': 'list[ControllerServiceReferencingComponentEntity]', 'state': 'str', 'type': 'str', 'validation_errors': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ControllerServiceReferencingComponentDTO. The type of the component referencing a controller service in simple Java class name format without package name.

Returns:The type of this ControllerServiceReferencingComponentDTO. Return type:str

validation_errors

Gets the validation_errors of this ControllerServiceReferencingComponentDTO. The validation errors for the component.

Returns:The validation_errors of this ControllerServiceReferencingComponentDTO. Return type:list[str]

nipyapi.nifi.models.controller_service_referencing_component_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_service_referencing_component_entity.ControllerServiceReferencingComponentEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, operate_permissions=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceReferencingComponentEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'operate_permissions': 'operatePermissions', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this ControllerServiceReferencingComponentEntity. The bulletins for this component.

Returns:The bulletins of this ControllerServiceReferencingComponentEntity. Return type:list[BulletinEntity]

component

Gets the component of this ControllerServiceReferencingComponentEntity.

Returns:The component of this ControllerServiceReferencingComponentEntity. Return type:ControllerServiceReferencingComponentDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ControllerServiceReferencingComponentEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ControllerServiceReferencingComponentEntity. Return type:bool

id

Gets the id of this ControllerServiceReferencingComponentEntity. The id of the component.

Returns:The id of this ControllerServiceReferencingComponentEntity. Return type:str

operate_permissions

Gets the operate_permissions of this ControllerServiceReferencingComponentEntity. The permissions for this component operations.

Returns:The operate_permissions of this ControllerServiceReferencingComponentEntity. Return type:PermissionsDTO

permissions

Gets the permissions of this ControllerServiceReferencingComponentEntity. The permissions for this component.

Returns:The permissions of this ControllerServiceReferencingComponentEntity. Return type:PermissionsDTO

position

Gets the position of this ControllerServiceReferencingComponentEntity. The position of this component in the UI if applicable.

Returns:The position of this ControllerServiceReferencingComponentEntity. Return type:PositionDTO

revision

Gets the revision of this ControllerServiceReferencingComponentEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this ControllerServiceReferencingComponentEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'ControllerServiceReferencingComponentDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'operate_permissions': 'PermissionsDTO', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ControllerServiceReferencingComponentEntity. The URI for futures requests to the component.

Returns:The uri of this ControllerServiceReferencingComponentEntity. Return type:str

nipyapi.nifi.models.controller_service_referencing_components_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_service_referencing_components_entity.ControllerServiceReferencingComponentsEntity(controller_service_referencing_components=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceReferencingComponentsEntity - a model defined in Swagger

attribute_map = {'controller_service_referencing_components': 'controllerServiceReferencingComponents'}

controller_service_referencing_components

Gets the controller_service_referencing_components of this ControllerServiceReferencingComponentsEntity.

Returns:The controller_service_referencing_components of this ControllerServiceReferencingComponentsEntity. Return type:list[ControllerServiceReferencingComponentEntity]

swagger_types = {'controller_service_referencing_components': 'list[ControllerServiceReferencingComponentEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_service_types_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_service_types_entity.ControllerServiceTypesEntity(controller_service_types=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceTypesEntity - a model defined in Swagger

attribute_map = {'controller_service_types': 'controllerServiceTypes'}

controller_service_types

Gets the controller_service_types of this ControllerServiceTypesEntity.

Returns:The controller_service_types of this ControllerServiceTypesEntity. Return type:list[DocumentedTypeDTO]

swagger_types = {'controller_service_types': 'list[DocumentedTypeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_services_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_services_entity.ControllerServicesEntity(current_time=None, controller_services=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServicesEntity - a model defined in Swagger

attribute_map = {'controller_services': 'controllerServices', 'current_time': 'currentTime'}

controller_services

Gets the controller_services of this ControllerServicesEntity.

Returns:The controller_services of this ControllerServicesEntity. Return type:list[ControllerServiceEntity]

current_time

Gets the current_time of this ControllerServicesEntity. The current time on the system.

Returns:The current_time of this ControllerServicesEntity. Return type:str

swagger_types = {'controller_services': 'list[ControllerServiceEntity]', 'current_time': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_status_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_status_dto.ControllerStatusDTO(active_thread_count=None, terminated_thread_count=None, queued=None, flow_files_queued=None, bytes_queued=None, running_count=None, stopped_count=None, invalid_count=None, disabled_count=None, active_remote_port_count=None, inactive_remote_port_count=None, up_to_date_count=None, locally_modified_count=None, stale_count=None, locally_modified_and_stale_count=None, sync_failure_count=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerStatusDTO - a model defined in Swagger

active_remote_port_count

Gets the active_remote_port_count of this ControllerStatusDTO. The number of active remote ports in the NiFi.

Returns:The active_remote_port_count of this ControllerStatusDTO. Return type:int

active_thread_count

Gets the active_thread_count of this ControllerStatusDTO. The number of active threads in the NiFi.

Returns:The active_thread_count of this ControllerStatusDTO. Return type:int

attribute_map = {'active_remote_port_count': 'activeRemotePortCount', 'active_thread_count': 'activeThreadCount', 'bytes_queued': 'bytesQueued', 'disabled_count': 'disabledCount', 'flow_files_queued': 'flowFilesQueued', 'inactive_remote_port_count': 'inactiveRemotePortCount', 'invalid_count': 'invalidCount', 'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', 'locally_modified_count': 'locallyModifiedCount', 'queued': 'queued', 'running_count': 'runningCount', 'stale_count': 'staleCount', 'stopped_count': 'stoppedCount', 'sync_failure_count': 'syncFailureCount', 'terminated_thread_count': 'terminatedThreadCount', 'up_to_date_count': 'upToDateCount'}

bytes_queued

Gets the bytes_queued of this ControllerStatusDTO. The size of the FlowFiles queued across the entire flow

Returns:The bytes_queued of this ControllerStatusDTO. Return type:int

disabled_count

Gets the disabled_count of this ControllerStatusDTO. The number of disabled components in the NiFi.

Returns:The disabled_count of this ControllerStatusDTO. Return type:int

flow_files_queued

Gets the flow_files_queued of this ControllerStatusDTO. The number of FlowFiles queued across the entire flow

Returns:The flow_files_queued of this ControllerStatusDTO. Return type:int

inactive_remote_port_count

Gets the inactive_remote_port_count of this ControllerStatusDTO. The number of inactive remote ports in the NiFi.

Returns:The inactive_remote_port_count of this ControllerStatusDTO. Return type:int

invalid_count

Gets the invalid_count of this ControllerStatusDTO. The number of invalid components in the NiFi.

Returns:The invalid_count of this ControllerStatusDTO. Return type:int

locally_modified_and_stale_count

Gets the locally_modified_and_stale_count of this ControllerStatusDTO. The number of locally modified and stale versioned process groups in the NiFi.

Returns:The locally_modified_and_stale_count of this ControllerStatusDTO. Return type:int

locally_modified_count

Gets the locally_modified_count of this ControllerStatusDTO. The number of locally modified versioned process groups in the NiFi.

Returns:The locally_modified_count of this ControllerStatusDTO. Return type:int

queued

Gets the queued of this ControllerStatusDTO. The number of flowfiles queued in the NiFi.

Returns:The queued of this ControllerStatusDTO. Return type:str

running_count

Gets the running_count of this ControllerStatusDTO. The number of running components in the NiFi.

Returns:The running_count of this ControllerStatusDTO. Return type:int

stale_count

Gets the stale_count of this ControllerStatusDTO. The number of stale versioned process groups in the NiFi.

Returns:The stale_count of this ControllerStatusDTO. Return type:int

stopped_count

Gets the stopped_count of this ControllerStatusDTO. The number of stopped components in the NiFi.

Returns:The stopped_count of this ControllerStatusDTO. Return type:int

swagger_types = {'active_remote_port_count': 'int', 'active_thread_count': 'int', 'bytes_queued': 'int', 'disabled_count': 'int', 'flow_files_queued': 'int', 'inactive_remote_port_count': 'int', 'invalid_count': 'int', 'locally_modified_and_stale_count': 'int', 'locally_modified_count': 'int', 'queued': 'str', 'running_count': 'int', 'stale_count': 'int', 'stopped_count': 'int', 'sync_failure_count': 'int', 'terminated_thread_count': 'int', 'up_to_date_count': 'int'}

sync_failure_count

Gets the sync_failure_count of this ControllerStatusDTO. The number of versioned process groups in the NiFi that are unable to sync to a registry.

Returns:The sync_failure_count of this ControllerStatusDTO. Return type:int

terminated_thread_count

Gets the terminated_thread_count of this ControllerStatusDTO. The number of terminated threads in the NiFi.

Returns:The terminated_thread_count of this ControllerStatusDTO. Return type:int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

up_to_date_count

Gets the up_to_date_count of this ControllerStatusDTO. The number of up to date versioned process groups in the NiFi.

Returns:The up_to_date_count of this ControllerStatusDTO. Return type:int

nipyapi.nifi.models.controller_status_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_status_entity.ControllerStatusEntity(controller_status=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerStatusEntity - a model defined in Swagger

attribute_map = {'controller_status': 'controllerStatus'}

controller_status

Gets the controller_status of this ControllerStatusEntity.

Returns:The controller_status of this ControllerStatusEntity. Return type:ControllerStatusDTO

swagger_types = {'controller_status': 'ControllerStatusDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.copy_snippet_request_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.copy_snippet_request_entity.CopySnippetRequestEntity(snippet_id=None, origin_x=None, origin_y=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CopySnippetRequestEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'origin_x': 'originX', 'origin_y': 'originY', 'snippet_id': 'snippetId'}

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this CopySnippetRequestEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this CopySnippetRequestEntity. Return type:bool

origin_x

Gets the origin_x of this CopySnippetRequestEntity. The x coordinate of the origin of the bounding box where the new components will be placed.

Returns:The origin_x of this CopySnippetRequestEntity. Return type:float

origin_y

Gets the origin_y of this CopySnippetRequestEntity. The y coordinate of the origin of the bounding box where the new components will be placed.

Returns:The origin_y of this CopySnippetRequestEntity. Return type:float

snippet_id

Gets the snippet_id of this CopySnippetRequestEntity. The identifier of the snippet.

Returns:The snippet_id of this CopySnippetRequestEntity. Return type:str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'origin_x': 'float', 'origin_y': 'float', 'snippet_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.counter_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.counter_dto.CounterDTO(id=None, context=None, name=None, value_count=None, value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CounterDTO - a model defined in Swagger

attribute_map = {'context': 'context', 'id': 'id', 'name': 'name', 'value': 'value', 'value_count': 'valueCount'}

context

Gets the context of this CounterDTO. The context of the counter.

Returns:The context of this CounterDTO. Return type:str

id

Gets the id of this CounterDTO. The id of the counter.

Returns:The id of this CounterDTO. Return type:str

name

Gets the name of this CounterDTO. The name of the counter.

Returns:The name of this CounterDTO. Return type:str

swagger_types = {'context': 'str', 'id': 'str', 'name': 'str', 'value': 'str', 'value_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

value

Gets the value of this CounterDTO. The value of the counter.

Returns:The value of this CounterDTO. Return type:str

value_count

Gets the value_count of this CounterDTO. The value count.

Returns:The value_count of this CounterDTO. Return type:int

nipyapi.nifi.models.counter_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.counter_entity.CounterEntity(counter=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CounterEntity - a model defined in Swagger

attribute_map = {'counter': 'counter'}

counter

Gets the counter of this CounterEntity.

Returns:The counter of this CounterEntity. Return type:CounterDTO

swagger_types = {'counter': 'CounterDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.counters_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.counters_dto.CountersDTO(aggregate_snapshot=None, node_snapshots=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CountersDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this CountersDTO. A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.

Returns:The aggregate_snapshot of this CountersDTO. Return type:CountersSnapshotDTO

attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'node_snapshots': 'nodeSnapshots'}

node_snapshots

Gets the node_snapshots of this CountersDTO. A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.

Returns:The node_snapshots of this CountersDTO. Return type:list[NodeCountersSnapshotDTO]

swagger_types = {'aggregate_snapshot': 'CountersSnapshotDTO', 'node_snapshots': 'list[NodeCountersSnapshotDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.counters_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.counters_entity.CountersEntity(counters=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CountersEntity - a model defined in Swagger

attribute_map = {'counters': 'counters'}

counters

Gets the counters of this CountersEntity.

Returns:The counters of this CountersEntity. Return type:CountersDTO

swagger_types = {'counters': 'CountersDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.counters_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.counters_snapshot_dto.CountersSnapshotDTO(generated=None, counters=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CountersSnapshotDTO - a model defined in Swagger

attribute_map = {'counters': 'counters', 'generated': 'generated'}

counters

Gets the counters of this CountersSnapshotDTO. All counters in the NiFi.

Returns:The counters of this CountersSnapshotDTO. Return type:list[CounterDTO]

generated

Gets the generated of this CountersSnapshotDTO. The timestamp when the report was generated.

Returns:The generated of this CountersSnapshotDTO. Return type:str

swagger_types = {'counters': 'list[CounterDTO]', 'generated': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.create_active_request_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.create_active_request_entity.CreateActiveRequestEntity(process_group_id=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CreateActiveRequestEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_id': 'processGroupId'}

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this CreateActiveRequestEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this CreateActiveRequestEntity. Return type:bool

process_group_id

Gets the process_group_id of this CreateActiveRequestEntity. The Process Group ID that this active request will update

Returns:The process_group_id of this CreateActiveRequestEntity. Return type:str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.create_template_request_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.create_template_request_entity.CreateTemplateRequestEntity(name=None, description=None, snippet_id=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CreateTemplateRequestEntity - a model defined in Swagger

attribute_map = {'description': 'description', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'name': 'name', 'snippet_id': 'snippetId'}

description

Gets the description of this CreateTemplateRequestEntity. The description of the template.

Returns:The description of this CreateTemplateRequestEntity. Return type:str

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this CreateTemplateRequestEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this CreateTemplateRequestEntity. Return type:bool

name

Gets the name of this CreateTemplateRequestEntity. The name of the template.

Returns:The name of this CreateTemplateRequestEntity. Return type:str

snippet_id

Gets the snippet_id of this CreateTemplateRequestEntity. The identifier of the snippet.

Returns:The snippet_id of this CreateTemplateRequestEntity. Return type:str

swagger_types = {'description': 'str', 'disconnected_node_acknowledged': 'bool', 'name': 'str', 'snippet_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.current_user_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.current_user_entity.CurrentUserEntity(identity=None, anonymous=None, provenance_permissions=None, counters_permissions=None, tenants_permissions=None, controller_permissions=None, policies_permissions=None, system_permissions=None, parameter_context_permissions=None, restricted_components_permissions=None, component_restriction_permissions=None, can_version_flows=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CurrentUserEntity - a model defined in Swagger

anonymous

Gets the anonymous of this CurrentUserEntity. Whether the current user is anonymous.

Returns:The anonymous of this CurrentUserEntity. Return type:bool

attribute_map = {'anonymous': 'anonymous', 'can_version_flows': 'canVersionFlows', 'component_restriction_permissions': 'componentRestrictionPermissions', 'controller_permissions': 'controllerPermissions', 'counters_permissions': 'countersPermissions', 'identity': 'identity', 'parameter_context_permissions': 'parameterContextPermissions', 'policies_permissions': 'policiesPermissions', 'provenance_permissions': 'provenancePermissions', 'restricted_components_permissions': 'restrictedComponentsPermissions', 'system_permissions': 'systemPermissions', 'tenants_permissions': 'tenantsPermissions'}

can_version_flows

Gets the can_version_flows of this CurrentUserEntity. Whether the current user can version flows.

Returns:The can_version_flows of this CurrentUserEntity. Return type:bool

component_restriction_permissions

Gets the component_restriction_permissions of this CurrentUserEntity. Permissions for specific component restrictions.

Returns:The component_restriction_permissions of this CurrentUserEntity. Return type:list[ComponentRestrictionPermissionDTO]

controller_permissions

Gets the controller_permissions of this CurrentUserEntity. Permissions for accessing the controller.

Returns:The controller_permissions of this CurrentUserEntity. Return type:PermissionsDTO

counters_permissions

Gets the counters_permissions of this CurrentUserEntity. Permissions for accessing counters.

Returns:The counters_permissions of this CurrentUserEntity. Return type:PermissionsDTO

identity

Gets the identity of this CurrentUserEntity. The user identity being serialized.

Returns:The identity of this CurrentUserEntity. Return type:str

parameter_context_permissions

Gets the parameter_context_permissions of this CurrentUserEntity. Permissions for accessing parameter contexts.

Returns:The parameter_context_permissions of this CurrentUserEntity. Return type:PermissionsDTO

policies_permissions

Gets the policies_permissions of this CurrentUserEntity. Permissions for accessing the policies.

Returns:The policies_permissions of this CurrentUserEntity. Return type:PermissionsDTO

provenance_permissions

Gets the provenance_permissions of this CurrentUserEntity. Permissions for querying provenance.

Returns:The provenance_permissions of this CurrentUserEntity. Return type:PermissionsDTO

restricted_components_permissions

Gets the restricted_components_permissions of this CurrentUserEntity. Permissions for accessing restricted components. Note: the read permission are not used and will always be false.

Returns:The restricted_components_permissions of this CurrentUserEntity. Return type:PermissionsDTO

swagger_types = {'anonymous': 'bool', 'can_version_flows': 'bool', 'component_restriction_permissions': 'list[ComponentRestrictionPermissionDTO]', 'controller_permissions': 'PermissionsDTO', 'counters_permissions': 'PermissionsDTO', 'identity': 'str', 'parameter_context_permissions': 'PermissionsDTO', 'policies_permissions': 'PermissionsDTO', 'provenance_permissions': 'PermissionsDTO', 'restricted_components_permissions': 'PermissionsDTO', 'system_permissions': 'PermissionsDTO', 'tenants_permissions': 'PermissionsDTO'}

system_permissions

Gets the system_permissions of this CurrentUserEntity. Permissions for accessing system.

Returns:The system_permissions of this CurrentUserEntity. Return type:PermissionsDTO

tenants_permissions

Gets the tenants_permissions of this CurrentUserEntity. Permissions for accessing tenants.

Returns:The tenants_permissions of this CurrentUserEntity. Return type:PermissionsDTO

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.difference_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.difference_dto.DifferenceDTO(difference_type=None, difference=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

DifferenceDTO - a model defined in Swagger

attribute_map = {'difference': 'difference', 'difference_type': 'differenceType'}

difference

Gets the difference of this DifferenceDTO. Description of the difference

Returns:The difference of this DifferenceDTO. Return type:str

difference_type

Gets the difference_type of this DifferenceDTO. The type of difference

Returns:The difference_type of this DifferenceDTO. Return type:str

swagger_types = {'difference': 'str', 'difference_type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.dimensions_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.dimensions_dto.DimensionsDTO(width=None, height=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

DimensionsDTO - a model defined in Swagger

attribute_map = {'height': 'height', 'width': 'width'}

height

Gets the height of this DimensionsDTO. The height of the label in pixels when at a 1:1 scale.

Returns:The height of this DimensionsDTO. Return type:float

swagger_types = {'height': 'float', 'width': 'float'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

width

Gets the width of this DimensionsDTO. The width of the label in pixels when at a 1:1 scale.

Returns:The width of this DimensionsDTO. Return type:float

nipyapi.nifi.models.documented_type_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.documented_type_dto.DocumentedTypeDTO(type=None, bundle=None, controller_service_apis=None, description=None, restricted=None, usage_restriction=None, explicit_restrictions=None, deprecation_reason=None, tags=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

DocumentedTypeDTO - a model defined in Swagger

attribute_map = {'bundle': 'bundle', 'controller_service_apis': 'controllerServiceApis', 'deprecation_reason': 'deprecationReason', 'description': 'description', 'explicit_restrictions': 'explicitRestrictions', 'restricted': 'restricted', 'tags': 'tags', 'type': 'type', 'usage_restriction': 'usageRestriction'}

bundle

Gets the bundle of this DocumentedTypeDTO. The details of the artifact that bundled this type.

Returns:The bundle of this DocumentedTypeDTO. Return type:BundleDTO

controller_service_apis

Gets the controller_service_apis of this DocumentedTypeDTO. If this type represents a ControllerService, this lists the APIs it implements.

Returns:The controller_service_apis of this DocumentedTypeDTO. Return type:list[ControllerServiceApiDTO]

deprecation_reason

Gets the deprecation_reason of this DocumentedTypeDTO. The description of why the usage of this component is restricted.

Returns:The deprecation_reason of this DocumentedTypeDTO. Return type:str

description

Gets the description of this DocumentedTypeDTO. The description of the type.

Returns:The description of this DocumentedTypeDTO. Return type:str

explicit_restrictions

Gets the explicit_restrictions of this DocumentedTypeDTO. An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.

Returns:The explicit_restrictions of this DocumentedTypeDTO. Return type:list[ExplicitRestrictionDTO]

restricted

Gets the restricted of this DocumentedTypeDTO. Whether this type is restricted.

Returns:The restricted of this DocumentedTypeDTO. Return type:bool

swagger_types = {'bundle': 'BundleDTO', 'controller_service_apis': 'list[ControllerServiceApiDTO]', 'deprecation_reason': 'str', 'description': 'str', 'explicit_restrictions': 'list[ExplicitRestrictionDTO]', 'restricted': 'bool', 'tags': 'list[str]', 'type': 'str', 'usage_restriction': 'str'}

tags

Gets the tags of this DocumentedTypeDTO. The tags associated with this type.

Returns:The tags of this DocumentedTypeDTO. Return type:list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this DocumentedTypeDTO. The fully qualified name of the type.

Returns:The type of this DocumentedTypeDTO. Return type:str

usage_restriction

Gets the usage_restriction of this DocumentedTypeDTO. The optional description of why the usage of this component is restricted.

Returns:The usage_restriction of this DocumentedTypeDTO. Return type:str

nipyapi.nifi.models.drop_request_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.drop_request_dto.DropRequestDTO(id=None, uri=None, submission_time=None, last_updated=None, percent_completed=None, finished=None, failure_reason=None, current_count=None, current_size=None, current=None, original_count=None, original_size=None, original=None, dropped_count=None, dropped_size=None, dropped=None, state=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

DropRequestDTO - a model defined in Swagger

attribute_map = {'current': 'current', 'current_count': 'currentCount', 'current_size': 'currentSize', 'dropped': 'dropped', 'dropped_count': 'droppedCount', 'dropped_size': 'droppedSize', 'failure_reason': 'failureReason', 'finished': 'finished', 'id': 'id', 'last_updated': 'lastUpdated', 'original': 'original', 'original_count': 'originalCount', 'original_size': 'originalSize', 'percent_completed': 'percentCompleted', 'state': 'state', 'submission_time': 'submissionTime', 'uri': 'uri'}

current

Gets the current of this DropRequestDTO. The count and size of flow files currently queued.

Returns:The current of this DropRequestDTO. Return type:str

current_count

Gets the current_count of this DropRequestDTO. The number of flow files currently queued.

Returns:The current_count of this DropRequestDTO. Return type:int

current_size

Gets the current_size of this DropRequestDTO. The size of flow files currently queued in bytes.

Returns:The current_size of this DropRequestDTO. Return type:int

dropped

Gets the dropped of this DropRequestDTO. The count and size of flow files that have been dropped thus far.

Returns:The dropped of this DropRequestDTO. Return type:str

dropped_count

Gets the dropped_count of this DropRequestDTO. The number of flow files that have been dropped thus far.

Returns:The dropped_count of this DropRequestDTO. Return type:int

dropped_size

Gets the dropped_size of this DropRequestDTO. The size of flow files that have been dropped thus far in bytes.

Returns:The dropped_size of this DropRequestDTO. Return type:int

failure_reason

Gets the failure_reason of this DropRequestDTO. The reason, if any, that this drop request failed.

Returns:The failure_reason of this DropRequestDTO. Return type:str

finished

Gets the finished of this DropRequestDTO. Whether the query has finished.

Returns:The finished of this DropRequestDTO. Return type:bool

id

Gets the id of this DropRequestDTO. The id for this drop request.

Returns:The id of this DropRequestDTO. Return type:str

last_updated

Gets the last_updated of this DropRequestDTO. The last time this drop request was updated.

Returns:The last_updated of this DropRequestDTO. Return type:str

original

Gets the original of this DropRequestDTO. The count and size of flow files to be dropped as a result of this request.

Returns:The original of this DropRequestDTO. Return type:str

original_count

Gets the original_count of this DropRequestDTO. The number of flow files to be dropped as a result of this request.

Returns:The original_count of this DropRequestDTO. Return type:int

original_size

Gets the original_size of this DropRequestDTO. The size of flow files to be dropped as a result of this request in bytes.

Returns:The original_size of this DropRequestDTO. Return type:int

percent_completed

Gets the percent_completed of this DropRequestDTO. The current percent complete.

Returns:The percent_completed of this DropRequestDTO. Return type:int

state

Gets the state of this DropRequestDTO. The current state of the drop request.

Returns:The state of this DropRequestDTO. Return type:str

submission_time

Gets the submission_time of this DropRequestDTO. The timestamp when the query was submitted.

Returns:The submission_time of this DropRequestDTO. Return type:str

swagger_types = {'current': 'str', 'current_count': 'int', 'current_size': 'int', 'dropped': 'str', 'dropped_count': 'int', 'dropped_size': 'int', 'failure_reason': 'str', 'finished': 'bool', 'id': 'str', 'last_updated': 'str', 'original': 'str', 'original_count': 'int', 'original_size': 'int', 'percent_completed': 'int', 'state': 'str', 'submission_time': 'str', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this DropRequestDTO. The URI for future requests to this drop request.

Returns:The uri of this DropRequestDTO. Return type:str

nipyapi.nifi.models.drop_request_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.drop_request_entity.DropRequestEntity(drop_request=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

DropRequestEntity - a model defined in Swagger

attribute_map = {'drop_request': 'dropRequest'}

drop_request

Gets the drop_request of this DropRequestEntity.

Returns:The drop_request of this DropRequestEntity. Return type:DropRequestDTO

swagger_types = {'drop_request': 'DropRequestDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_breadcrumb_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.flow_breadcrumb_dto.FlowBreadcrumbDTO(id=None, name=None, version_control_information=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowBreadcrumbDTO - a model defined in Swagger

attribute_map = {'id': 'id', 'name': 'name', 'version_control_information': 'versionControlInformation'}

id

Gets the id of this FlowBreadcrumbDTO. The id of the group.

Returns:The id of this FlowBreadcrumbDTO. Return type:str

name

Gets the name of this FlowBreadcrumbDTO. The id of the group.

Returns:The name of this FlowBreadcrumbDTO. Return type:str

swagger_types = {'id': 'str', 'name': 'str', 'version_control_information': 'VersionControlInformationDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version_control_information

Gets the version_control_information of this FlowBreadcrumbDTO. The process group version control information or null if not version controlled.

Returns:The version_control_information of this FlowBreadcrumbDTO. Return type:VersionControlInformationDTO

nipyapi.nifi.models.flow_breadcrumb_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.flow_breadcrumb_entity.FlowBreadcrumbEntity(id=None, permissions=None, versioned_flow_state=None, breadcrumb=None, parent_breadcrumb=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowBreadcrumbEntity - a model defined in Swagger

attribute_map = {'breadcrumb': 'breadcrumb', 'id': 'id', 'parent_breadcrumb': 'parentBreadcrumb', 'permissions': 'permissions', 'versioned_flow_state': 'versionedFlowState'}

breadcrumb

Gets the breadcrumb of this FlowBreadcrumbEntity. This breadcrumb.

Returns:The breadcrumb of this FlowBreadcrumbEntity. Return type:FlowBreadcrumbDTO

id

Gets the id of this FlowBreadcrumbEntity. The id of this ancestor ProcessGroup.

Returns:The id of this FlowBreadcrumbEntity. Return type:str

parent_breadcrumb

Gets the parent_breadcrumb of this FlowBreadcrumbEntity. The parent breadcrumb for this breadcrumb.

Returns:The parent_breadcrumb of this FlowBreadcrumbEntity. Return type:FlowBreadcrumbEntity

permissions

Gets the permissions of this FlowBreadcrumbEntity. The permissions for this ancestor ProcessGroup.

Returns:The permissions of this FlowBreadcrumbEntity. Return type:PermissionsDTO

swagger_types = {'breadcrumb': 'FlowBreadcrumbDTO', 'id': 'str', 'parent_breadcrumb': 'FlowBreadcrumbEntity', 'permissions': 'PermissionsDTO', 'versioned_flow_state': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_flow_state

Gets the versioned_flow_state of this FlowBreadcrumbEntity. The current state of the Process Group, as it relates to the Versioned Flow

Returns:The versioned_flow_state of this FlowBreadcrumbEntity. Return type:str

nipyapi.nifi.models.flow_comparison_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.flow_comparison_entity.FlowComparisonEntity(component_differences=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowComparisonEntity - a model defined in Swagger

attribute_map = {'component_differences': 'componentDifferences'}

component_differences

Gets the component_differences of this FlowComparisonEntity. The list of differences for each component in the flow that is not the same between the two flows

Returns:The component_differences of this FlowComparisonEntity. Return type:list[ComponentDifferenceDTO]

swagger_types = {'component_differences': 'list[ComponentDifferenceDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_configuration_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.flow_configuration_dto.FlowConfigurationDTO(supports_managed_authorizer=None, supports_configurable_authorizer=None, supports_configurable_users_and_groups=None, auto_refresh_interval_seconds=None, current_time=None, time_offset=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowConfigurationDTO - a model defined in Swagger

attribute_map = {'auto_refresh_interval_seconds': 'autoRefreshIntervalSeconds', 'current_time': 'currentTime', 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', 'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', 'supports_configurable_authorizer': 'supportsConfigurableAuthorizer', 'supports_configurable_users_and_groups': 'supportsConfigurableUsersAndGroups', 'supports_managed_authorizer': 'supportsManagedAuthorizer', 'time_offset': 'timeOffset'}

auto_refresh_interval_seconds

Gets the auto_refresh_interval_seconds of this FlowConfigurationDTO. The interval in seconds between the automatic NiFi refresh requests.

Returns:The auto_refresh_interval_seconds of this FlowConfigurationDTO. Return type:int

current_time

Gets the current_time of this FlowConfigurationDTO. The current time on the system.

Returns:The current_time of this FlowConfigurationDTO. Return type:str

default_back_pressure_data_size_threshold

Gets the default_back_pressure_data_size_threshold of this FlowConfigurationDTO. The default back pressure data size threshold.

Returns:The default_back_pressure_data_size_threshold of this FlowConfigurationDTO. Return type:str

default_back_pressure_object_threshold

Gets the default_back_pressure_object_threshold of this FlowConfigurationDTO. The default back pressure object threshold.

Returns:The default_back_pressure_object_threshold of this FlowConfigurationDTO. Return type:int

supports_configurable_authorizer

Gets the supports_configurable_authorizer of this FlowConfigurationDTO. Whether this NiFi supports a configurable authorizer.

Returns:The supports_configurable_authorizer of this FlowConfigurationDTO. Return type:bool

supports_configurable_users_and_groups

Gets the supports_configurable_users_and_groups of this FlowConfigurationDTO. Whether this NiFi supports configurable users and groups.

Returns:The supports_configurable_users_and_groups of this FlowConfigurationDTO. Return type:bool

supports_managed_authorizer

Gets the supports_managed_authorizer of this FlowConfigurationDTO. Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.

Returns:The supports_managed_authorizer of this FlowConfigurationDTO. Return type:bool

swagger_types = {'auto_refresh_interval_seconds': 'int', 'current_time': 'str', 'default_back_pressure_data_size_threshold': 'str', 'default_back_pressure_object_threshold': 'int', 'supports_configurable_authorizer': 'bool', 'supports_configurable_users_and_groups': 'bool', 'supports_managed_authorizer': 'bool', 'time_offset': 'int'}

time_offset

Gets the time_offset of this FlowConfigurationDTO. The time offset of the system.

Returns:The time_offset of this FlowConfigurationDTO. Return type:int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_configuration_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.flow_configuration_entity.FlowConfigurationEntity(flow_configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowConfigurationEntity - a model defined in Swagger

attribute_map = {'flow_configuration': 'flowConfiguration'}

flow_configuration

Gets the flow_configuration of this FlowConfigurationEntity. The controller configuration.

Returns:The flow_configuration of this FlowConfigurationEntity. Return type:FlowConfigurationDTO

swagger_types = {'flow_configuration': 'FlowConfigurationDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.flow_dto.FlowDTO(process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowDTO - a model defined in Swagger

attribute_map = {'connections': 'connections', 'funnels': 'funnels', 'input_ports': 'inputPorts', 'labels': 'labels', 'output_ports': 'outputPorts', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups'}

connections

Gets the connections of this FlowDTO. The connections in this flow.

Returns:The connections of this FlowDTO. Return type:list[ConnectionEntity]

funnels

Gets the funnels of this FlowDTO. The funnels in this flow.

Returns:The funnels of this FlowDTO. Return type:list[FunnelEntity]

input_ports

Gets the input_ports of this FlowDTO. The input ports in this flow.

Returns:The input_ports of this FlowDTO. Return type:list[PortEntity]

labels

Gets the labels of this FlowDTO. The labels in this flow.

Returns:The labels of this FlowDTO. Return type:list[LabelEntity]

output_ports

Gets the output_ports of this FlowDTO. The output ports in this flow.

Returns:The output_ports of this FlowDTO. Return type:list[PortEntity]

process_groups

Gets the process_groups of this FlowDTO. The process groups in this flow.

Returns:The process_groups of this FlowDTO. Return type:list[ProcessGroupEntity]

processors

Gets the processors of this FlowDTO. The processors in this flow.

Returns:The processors of this FlowDTO. Return type:list[ProcessorEntity]

remote_process_groups

Gets the remote_process_groups of this FlowDTO. The remote process groups in this flow.

Returns:The remote_process_groups of this FlowDTO. Return type:list[RemoteProcessGroupEntity]

swagger_types = {'connections': 'list[ConnectionEntity]', 'funnels': 'list[FunnelEntity]', 'input_ports': 'list[PortEntity]', 'labels': 'list[LabelEntity]', 'output_ports': 'list[PortEntity]', 'process_groups': 'list[ProcessGroupEntity]', 'processors': 'list[ProcessorEntity]', 'remote_process_groups': 'list[RemoteProcessGroupEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.flow_entity.FlowEntity(flow=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowEntity - a model defined in Swagger

attribute_map = {'flow': 'flow'}

flow

Gets the flow of this FlowEntity.

Returns:The flow of this FlowEntity. Return type:FlowDTO

swagger_types = {'flow': 'FlowDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_file_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.flow_file_dto.FlowFileDTO(uri=None, uuid=None, filename=None, position=None, size=None, queued_duration=None, lineage_duration=None, penalty_expires_in=None, cluster_node_id=None, cluster_node_address=None, attributes=None, content_claim_section=None, content_claim_container=None, content_claim_identifier=None, content_claim_offset=None, content_claim_file_size=None, content_claim_file_size_bytes=None, penalized=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowFileDTO - a model defined in Swagger

attribute_map = {'attributes': 'attributes', 'cluster_node_address': 'clusterNodeAddress', 'cluster_node_id': 'clusterNodeId', 'content_claim_container': 'contentClaimContainer', 'content_claim_file_size': 'contentClaimFileSize', 'content_claim_file_size_bytes': 'contentClaimFileSizeBytes', 'content_claim_identifier': 'contentClaimIdentifier', 'content_claim_offset': 'contentClaimOffset', 'content_claim_section': 'contentClaimSection', 'filename': 'filename', 'lineage_duration': 'lineageDuration', 'penalized': 'penalized', 'penalty_expires_in': 'penaltyExpiresIn', 'position': 'position', 'queued_duration': 'queuedDuration', 'size': 'size', 'uri': 'uri', 'uuid': 'uuid'}

attributes

Gets the attributes of this FlowFileDTO. The FlowFile attributes.

Returns:The attributes of this FlowFileDTO. Return type:dict(str, str)

cluster_node_address

Gets the cluster_node_address of this FlowFileDTO. The label for the node where this FlowFile resides.

Returns:The cluster_node_address of this FlowFileDTO. Return type:str

cluster_node_id

Gets the cluster_node_id of this FlowFileDTO. The id of the node where this FlowFile resides.

Returns:The cluster_node_id of this FlowFileDTO. Return type:str

content_claim_container

Gets the content_claim_container of this FlowFileDTO. The container in which the content claim lives.

Returns:The content_claim_container of this FlowFileDTO. Return type:str

content_claim_file_size

Gets the content_claim_file_size of this FlowFileDTO. The file size of the content claim formatted.

Returns:The content_claim_file_size of this FlowFileDTO. Return type:str

content_claim_file_size_bytes

Gets the content_claim_file_size_bytes of this FlowFileDTO. The file size of the content claim in bytes.

Returns:The content_claim_file_size_bytes of this FlowFileDTO. Return type:int

content_claim_identifier

Gets the content_claim_identifier of this FlowFileDTO. The identifier of the content claim.

Returns:The content_claim_identifier of this FlowFileDTO. Return type:str

content_claim_offset

Gets the content_claim_offset of this FlowFileDTO. The offset into the content claim where the flowfile’s content begins.

Returns:The content_claim_offset of this FlowFileDTO. Return type:int

content_claim_section

Gets the content_claim_section of this FlowFileDTO. The section in which the content claim lives.

Returns:The content_claim_section of this FlowFileDTO. Return type:str

filename

Gets the filename of this FlowFileDTO. The FlowFile filename.

Returns:The filename of this FlowFileDTO. Return type:str

lineage_duration

Gets the lineage_duration of this FlowFileDTO. Duration since the FlowFile’s greatest ancestor entered the flow.

Returns:The lineage_duration of this FlowFileDTO. Return type:int

penalized

Gets the penalized of this FlowFileDTO. If the FlowFile is penalized.

Returns:The penalized of this FlowFileDTO. Return type:bool

penalty_expires_in

Gets the penalty_expires_in of this FlowFileDTO. How long in milliseconds until the FlowFile penalty expires.

Returns:The penalty_expires_in of this FlowFileDTO. Return type:int

position

Gets the position of this FlowFileDTO. The FlowFile’s position in the queue.

Returns:The position of this FlowFileDTO. Return type:int

queued_duration

Gets the queued_duration of this FlowFileDTO. How long this FlowFile has been enqueued.

Returns:The queued_duration of this FlowFileDTO. Return type:int

size

Gets the size of this FlowFileDTO. The FlowFile file size.

Returns:The size of this FlowFileDTO. Return type:int

swagger_types = {'attributes': 'dict(str, str)', 'cluster_node_address': 'str', 'cluster_node_id': 'str', 'content_claim_container': 'str', 'content_claim_file_size': 'str', 'content_claim_file_size_bytes': 'int', 'content_claim_identifier': 'str', 'content_claim_offset': 'int', 'content_claim_section': 'str', 'filename': 'str', 'lineage_duration': 'int', 'penalized': 'bool', 'penalty_expires_in': 'int', 'position': 'int', 'queued_duration': 'int', 'size': 'int', 'uri': 'str', 'uuid': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this FlowFileDTO. The URI that can be used to access this FlowFile.

Returns:The uri of this FlowFileDTO. Return type:str

uuid

Gets the uuid of this FlowFileDTO. The FlowFile UUID.

Returns:The uuid of this FlowFileDTO. Return type:str

nipyapi.nifi.models.flow_file_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.flow_file_entity.FlowFileEntity(flow_file=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowFileEntity - a model defined in Swagger

attribute_map = {'flow_file': 'flowFile'}

flow_file

Gets the flow_file of this FlowFileEntity.

Returns:The flow_file of this FlowFileEntity. Return type:FlowFileDTO

swagger_types = {'flow_file': 'FlowFileDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_file_summary_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.flow_file_summary_dto.FlowFileSummaryDTO(uri=None, uuid=None, filename=None, position=None, size=None, queued_duration=None, lineage_duration=None, penalty_expires_in=None, cluster_node_id=None, cluster_node_address=None, penalized=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowFileSummaryDTO - a model defined in Swagger

attribute_map = {'cluster_node_address': 'clusterNodeAddress', 'cluster_node_id': 'clusterNodeId', 'filename': 'filename', 'lineage_duration': 'lineageDuration', 'penalized': 'penalized', 'penalty_expires_in': 'penaltyExpiresIn', 'position': 'position', 'queued_duration': 'queuedDuration', 'size': 'size', 'uri': 'uri', 'uuid': 'uuid'}

cluster_node_address

Gets the cluster_node_address of this FlowFileSummaryDTO. The label for the node where this FlowFile resides.

Returns:The cluster_node_address of this FlowFileSummaryDTO. Return type:str

cluster_node_id

Gets the cluster_node_id of this FlowFileSummaryDTO. The id of the node where this FlowFile resides.

Returns:The cluster_node_id of this FlowFileSummaryDTO. Return type:str

filename

Gets the filename of this FlowFileSummaryDTO. The FlowFile filename.

Returns:The filename of this FlowFileSummaryDTO. Return type:str

lineage_duration

Gets the lineage_duration of this FlowFileSummaryDTO. Duration since the FlowFile’s greatest ancestor entered the flow.

Returns:The lineage_duration of this FlowFileSummaryDTO. Return type:int

penalized

Gets the penalized of this FlowFileSummaryDTO. If the FlowFile is penalized.

Returns:The penalized of this FlowFileSummaryDTO. Return type:bool

penalty_expires_in

Gets the penalty_expires_in of this FlowFileSummaryDTO. How long in milliseconds until the FlowFile penalty expires.

Returns:The penalty_expires_in of this FlowFileSummaryDTO. Return type:int

position

Gets the position of this FlowFileSummaryDTO. The FlowFile’s position in the queue.

Returns:The position of this FlowFileSummaryDTO. Return type:int

queued_duration

Gets the queued_duration of this FlowFileSummaryDTO. How long this FlowFile has been enqueued.

Returns:The queued_duration of this FlowFileSummaryDTO. Return type:int

size

Gets the size of this FlowFileSummaryDTO. The FlowFile file size.

Returns:The size of this FlowFileSummaryDTO. Return type:int

swagger_types = {'cluster_node_address': 'str', 'cluster_node_id': 'str', 'filename': 'str', 'lineage_duration': 'int', 'penalized': 'bool', 'penalty_expires_in': 'int', 'position': 'int', 'queued_duration': 'int', 'size': 'int', 'uri': 'str', 'uuid': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this FlowFileSummaryDTO. The URI that can be used to access this FlowFile.

Returns:The uri of this FlowFileSummaryDTO. Return type:str

uuid

Gets the uuid of this FlowFileSummaryDTO. The FlowFile UUID.

Returns:The uuid of this FlowFileSummaryDTO. Return type:str

nipyapi.nifi.models.flow_snippet_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.flow_snippet_dto.FlowSnippetDTO(process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None, controller_services=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowSnippetDTO - a model defined in Swagger

attribute_map = {'connections': 'connections', 'controller_services': 'controllerServices', 'funnels': 'funnels', 'input_ports': 'inputPorts', 'labels': 'labels', 'output_ports': 'outputPorts', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups'}

connections

Gets the connections of this FlowSnippetDTO. The connections in this flow snippet.

Returns:The connections of this FlowSnippetDTO. Return type:list[ConnectionDTO]

controller_services

Gets the controller_services of this FlowSnippetDTO. The controller services in this flow snippet.

Returns:The controller_services of this FlowSnippetDTO. Return type:list[ControllerServiceDTO]

funnels

Gets the funnels of this FlowSnippetDTO. The funnels in this flow snippet.

Returns:The funnels of this FlowSnippetDTO. Return type:list[FunnelDTO]

input_ports

Gets the input_ports of this FlowSnippetDTO. The input ports in this flow snippet.

Returns:The input_ports of this FlowSnippetDTO. Return type:list[PortDTO]

labels

Gets the labels of this FlowSnippetDTO. The labels in this flow snippet.

Returns:The labels of this FlowSnippetDTO. Return type:list[LabelDTO]

output_ports

Gets the output_ports of this FlowSnippetDTO. The output ports in this flow snippet.

Returns:The output_ports of this FlowSnippetDTO. Return type:list[PortDTO]

process_groups

Gets the process_groups of this FlowSnippetDTO. The process groups in this flow snippet.

Returns:The process_groups of this FlowSnippetDTO. Return type:list[ProcessGroupDTO]

processors

Gets the processors of this FlowSnippetDTO. The processors in this flow snippet.

Returns:The processors of this FlowSnippetDTO. Return type:list[ProcessorDTO]

remote_process_groups

Gets the remote_process_groups of this FlowSnippetDTO. The remote process groups in this flow snippet.

Returns:The remote_process_groups of this FlowSnippetDTO. Return type:list[RemoteProcessGroupDTO]

swagger_types = {'connections': 'list[ConnectionDTO]', 'controller_services': 'list[ControllerServiceDTO]', 'funnels': 'list[FunnelDTO]', 'input_ports': 'list[PortDTO]', 'labels': 'list[LabelDTO]', 'output_ports': 'list[PortDTO]', 'process_groups': 'list[ProcessGroupDTO]', 'processors': 'list[ProcessorDTO]', 'remote_process_groups': 'list[RemoteProcessGroupDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.funnel_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.funnel_dto.FunnelDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FunnelDTO - a model defined in Swagger

attribute_map = {'id': 'id', 'parent_group_id': 'parentGroupId', 'position': 'position', 'versioned_component_id': 'versionedComponentId'}

id

Gets the id of this FunnelDTO. The id of the component.

Returns:The id of this FunnelDTO. Return type:str

parent_group_id

Gets the parent_group_id of this FunnelDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this FunnelDTO. Return type:str

position

Gets the position of this FunnelDTO. The position of this component in the UI if applicable.

Returns:The position of this FunnelDTO. Return type:PositionDTO

swagger_types = {'id': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_component_id

Gets the versioned_component_id of this FunnelDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this FunnelDTO. Return type:str

nipyapi.nifi.models.funnel_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.funnel_entity.FunnelEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FunnelEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this FunnelEntity. The bulletins for this component.

Returns:The bulletins of this FunnelEntity. Return type:list[BulletinEntity]

component

Gets the component of this FunnelEntity.

Returns:The component of this FunnelEntity. Return type:FunnelDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this FunnelEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this FunnelEntity. Return type:bool

id

Gets the id of this FunnelEntity. The id of the component.

Returns:The id of this FunnelEntity. Return type:str

permissions

Gets the permissions of this FunnelEntity. The permissions for this component.

Returns:The permissions of this FunnelEntity. Return type:PermissionsDTO

position

Gets the position of this FunnelEntity. The position of this component in the UI if applicable.

Returns:The position of this FunnelEntity. Return type:PositionDTO

revision

Gets the revision of this FunnelEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this FunnelEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'FunnelDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this FunnelEntity. The URI for futures requests to the component.

Returns:The uri of this FunnelEntity. Return type:str

nipyapi.nifi.models.funnels_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.funnels_entity.FunnelsEntity(funnels=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FunnelsEntity - a model defined in Swagger

attribute_map = {'funnels': 'funnels'}

funnels

Gets the funnels of this FunnelsEntity.

Returns:The funnels of this FunnelsEntity. Return type:list[FunnelEntity]

swagger_types = {'funnels': 'list[FunnelEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.garbage_collection_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.garbage_collection_dto.GarbageCollectionDTO(name=None, collection_count=None, collection_time=None, collection_millis=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

GarbageCollectionDTO - a model defined in Swagger

attribute_map = {'collection_count': 'collectionCount', 'collection_millis': 'collectionMillis', 'collection_time': 'collectionTime', 'name': 'name'}

collection_count

Gets the collection_count of this GarbageCollectionDTO. The number of times garbage collection has run.

Returns:The collection_count of this GarbageCollectionDTO. Return type:int

collection_millis

Gets the collection_millis of this GarbageCollectionDTO. The total number of milliseconds spent garbage collecting.

Returns:The collection_millis of this GarbageCollectionDTO. Return type:int

collection_time

Gets the collection_time of this GarbageCollectionDTO. The total amount of time spent garbage collecting.

Returns:The collection_time of this GarbageCollectionDTO. Return type:str

name

Gets the name of this GarbageCollectionDTO. The name of the garbage collector.

Returns:The name of this GarbageCollectionDTO. Return type:str

swagger_types = {'collection_count': 'int', 'collection_millis': 'int', 'collection_time': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.history_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.history_dto.HistoryDTO(total=None, last_refreshed=None, actions=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

HistoryDTO - a model defined in Swagger

actions

Gets the actions of this HistoryDTO. The actions.

Returns:The actions of this HistoryDTO. Return type:list[ActionEntity]

attribute_map = {'actions': 'actions', 'last_refreshed': 'lastRefreshed', 'total': 'total'}

last_refreshed

Gets the last_refreshed of this HistoryDTO. The timestamp when the report was generated.

Returns:The last_refreshed of this HistoryDTO. Return type:str

swagger_types = {'actions': 'list[ActionEntity]', 'last_refreshed': 'str', 'total': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

total

Gets the total of this HistoryDTO. The number of number of actions that matched the search criteria..

Returns:The total of this HistoryDTO. Return type:int

nipyapi.nifi.models.history_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.history_entity.HistoryEntity(history=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

HistoryEntity - a model defined in Swagger

attribute_map = {'history': 'history'}

history

Gets the history of this HistoryEntity.

Returns:The history of this HistoryEntity. Return type:HistoryDTO

swagger_types = {'history': 'HistoryDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.input_ports_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.input_ports_entity.InputPortsEntity(input_ports=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

InputPortsEntity - a model defined in Swagger

attribute_map = {'input_ports': 'inputPorts'}

input_ports

Gets the input_ports of this InputPortsEntity.

Returns:The input_ports of this InputPortsEntity. Return type:list[PortEntity]

swagger_types = {'input_ports': 'list[PortEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.instantiate_template_request_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.instantiate_template_request_entity.InstantiateTemplateRequestEntity(origin_x=None, origin_y=None, template_id=None, encoding_version=None, snippet=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

InstantiateTemplateRequestEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'encoding_version': 'encodingVersion', 'origin_x': 'originX', 'origin_y': 'originY', 'snippet': 'snippet', 'template_id': 'templateId'}

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this InstantiateTemplateRequestEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this InstantiateTemplateRequestEntity. Return type:bool

encoding_version

Gets the encoding_version of this InstantiateTemplateRequestEntity. The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency.

Returns:The encoding_version of this InstantiateTemplateRequestEntity. Return type:str

origin_x

Gets the origin_x of this InstantiateTemplateRequestEntity. The x coordinate of the origin of the bounding box where the new components will be placed.

Returns:The origin_x of this InstantiateTemplateRequestEntity. Return type:float

origin_y

Gets the origin_y of this InstantiateTemplateRequestEntity. The y coordinate of the origin of the bounding box where the new components will be placed.

Returns:The origin_y of this InstantiateTemplateRequestEntity. Return type:float

snippet

Gets the snippet of this InstantiateTemplateRequestEntity. A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.

Returns:The snippet of this InstantiateTemplateRequestEntity. Return type:FlowSnippetDTO

swagger_types = {'disconnected_node_acknowledged': 'bool', 'encoding_version': 'str', 'origin_x': 'float', 'origin_y': 'float', 'snippet': 'FlowSnippetDTO', 'template_id': 'str'}

template_id

Gets the template_id of this InstantiateTemplateRequestEntity. The identifier of the template.

Returns:The template_id of this InstantiateTemplateRequestEntity. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.label_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.label_dto.LabelDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, label=None, width=None, height=None, getz_index=None, style=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LabelDTO - a model defined in Swagger

attribute_map = {'getz_index': 'getzIndex', 'height': 'height', 'id': 'id', 'label': 'label', 'parent_group_id': 'parentGroupId', 'position': 'position', 'style': 'style', 'versioned_component_id': 'versionedComponentId', 'width': 'width'}

getz_index

Gets the getz_index of this LabelDTO. The z index of the label.

Returns:The getz_index of this LabelDTO. Return type:int

height

Gets the height of this LabelDTO. The height of the label in pixels when at a 1:1 scale.

Returns:The height of this LabelDTO. Return type:float

id

Gets the id of this LabelDTO. The id of the component.

Returns:The id of this LabelDTO. Return type:str

label

Gets the label of this LabelDTO. The text that appears in the label.

Returns:The label of this LabelDTO. Return type:str

parent_group_id

Gets the parent_group_id of this LabelDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this LabelDTO. Return type:str

position

Gets the position of this LabelDTO. The position of this component in the UI if applicable.

Returns:The position of this LabelDTO. Return type:PositionDTO

style

Gets the style of this LabelDTO. The styles for this label (font-size : 12px, background-color : #eee, etc).

Returns:The style of this LabelDTO. Return type:dict(str, str)

swagger_types = {'getz_index': 'int', 'height': 'float', 'id': 'str', 'label': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'style': 'dict(str, str)', 'versioned_component_id': 'str', 'width': 'float'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_component_id

Gets the versioned_component_id of this LabelDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this LabelDTO. Return type:str

width

Gets the width of this LabelDTO. The width of the label in pixels when at a 1:1 scale.

Returns:The width of this LabelDTO. Return type:float

nipyapi.nifi.models.label_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.label_entity.LabelEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, dimensions=None, getz_index=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LabelEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'dimensions': 'dimensions', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'getz_index': 'getzIndex', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this LabelEntity. The bulletins for this component.

Returns:The bulletins of this LabelEntity. Return type:list[BulletinEntity]

component

Gets the component of this LabelEntity.

Returns:The component of this LabelEntity. Return type:LabelDTO

dimensions

Gets the dimensions of this LabelEntity.

Returns:The dimensions of this LabelEntity. Return type:DimensionsDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this LabelEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this LabelEntity. Return type:bool

getz_index

Gets the getz_index of this LabelEntity. The z index of the label.

Returns:The getz_index of this LabelEntity. Return type:int

id

Gets the id of this LabelEntity. The id of the component.

Returns:The id of this LabelEntity. Return type:str

permissions

Gets the permissions of this LabelEntity. The permissions for this component.

Returns:The permissions of this LabelEntity. Return type:PermissionsDTO

position

Gets the position of this LabelEntity. The position of this component in the UI if applicable.

Returns:The position of this LabelEntity. Return type:PositionDTO

revision

Gets the revision of this LabelEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this LabelEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'LabelDTO', 'dimensions': 'DimensionsDTO', 'disconnected_node_acknowledged': 'bool', 'getz_index': 'int', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this LabelEntity. The URI for futures requests to the component.

Returns:The uri of this LabelEntity. Return type:str

nipyapi.nifi.models.labels_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.labels_entity.LabelsEntity(labels=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LabelsEntity - a model defined in Swagger

attribute_map = {'labels': 'labels'}

labels

Gets the labels of this LabelsEntity.

Returns:The labels of this LabelsEntity. Return type:list[LabelEntity]

swagger_types = {'labels': 'list[LabelEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.lineage_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.lineage_dto.LineageDTO(id=None, uri=None, submission_time=None, expiration=None, percent_completed=None, finished=None, request=None, results=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LineageDTO - a model defined in Swagger

attribute_map = {'expiration': 'expiration', 'finished': 'finished', 'id': 'id', 'percent_completed': 'percentCompleted', 'request': 'request', 'results': 'results', 'submission_time': 'submissionTime', 'uri': 'uri'}

expiration

Gets the expiration of this LineageDTO. When the lineage query will expire.

Returns:The expiration of this LineageDTO. Return type:str

finished

Gets the finished of this LineageDTO. Whether the lineage query has finished.

Returns:The finished of this LineageDTO. Return type:bool

id

Gets the id of this LineageDTO. The id of this lineage query.

Returns:The id of this LineageDTO. Return type:str

percent_completed

Gets the percent_completed of this LineageDTO. The percent complete for the lineage query.

Returns:The percent_completed of this LineageDTO. Return type:int

request

Gets the request of this LineageDTO. The initial lineage result.

Returns:The request of this LineageDTO. Return type:LineageRequestDTO

results

Gets the results of this LineageDTO. The results of the lineage query.

Returns:The results of this LineageDTO. Return type:LineageResultsDTO

submission_time

Gets the submission_time of this LineageDTO. When the lineage query was submitted.

Returns:The submission_time of this LineageDTO. Return type:str

swagger_types = {'expiration': 'str', 'finished': 'bool', 'id': 'str', 'percent_completed': 'int', 'request': 'LineageRequestDTO', 'results': 'LineageResultsDTO', 'submission_time': 'str', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this LineageDTO. The URI for this lineage query for later retrieval and deletion.

Returns:The uri of this LineageDTO. Return type:str

nipyapi.nifi.models.lineage_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.lineage_entity.LineageEntity(lineage=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LineageEntity - a model defined in Swagger

attribute_map = {'lineage': 'lineage'}

lineage

Gets the lineage of this LineageEntity.

Returns:The lineage of this LineageEntity. Return type:LineageDTO

swagger_types = {'lineage': 'LineageDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.lineage_request_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.lineage_request_dto.LineageRequestDTO(event_id=None, lineage_request_type=None, uuid=None, cluster_node_id=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LineageRequestDTO - a model defined in Swagger

attribute_map = {'cluster_node_id': 'clusterNodeId', 'event_id': 'eventId', 'lineage_request_type': 'lineageRequestType', 'uuid': 'uuid'}

cluster_node_id

Gets the cluster_node_id of this LineageRequestDTO. The id of the node where this lineage originated if clustered.

Returns:The cluster_node_id of this LineageRequestDTO. Return type:str

event_id

Gets the event_id of this LineageRequestDTO. The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored.

Returns:The event_id of this LineageRequestDTO. Return type:int

lineage_request_type

Gets the lineage_request_type of this LineageRequestDTO. The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.

Returns:The lineage_request_type of this LineageRequestDTO. Return type:str

swagger_types = {'cluster_node_id': 'str', 'event_id': 'int', 'lineage_request_type': 'str', 'uuid': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uuid

Gets the uuid of this LineageRequestDTO. The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id.

Returns:The uuid of this LineageRequestDTO. Return type:str

nipyapi.nifi.models.lineage_results_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.lineage_results_dto.LineageResultsDTO(errors=None, nodes=None, links=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LineageResultsDTO - a model defined in Swagger

attribute_map = {'errors': 'errors', 'links': 'links', 'nodes': 'nodes'}

errors

Gets the errors of this LineageResultsDTO. Any errors that occurred while generating the lineage.

Returns:The errors of this LineageResultsDTO. Return type:list[str]

links

Gets the links of this LineageResultsDTO. The links between the nodes in the lineage.

Returns:The links of this LineageResultsDTO. Return type:list[ProvenanceLinkDTO]

nodes

Gets the nodes of this LineageResultsDTO. The nodes in the lineage.

Returns:The nodes of this LineageResultsDTO. Return type:list[ProvenanceNodeDTO]

swagger_types = {'errors': 'list[str]', 'links': 'list[ProvenanceLinkDTO]', 'nodes': 'list[ProvenanceNodeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.listing_request_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.listing_request_dto.ListingRequestDTO(id=None, uri=None, submission_time=None, last_updated=None, percent_completed=None, finished=None, failure_reason=None, max_results=None, state=None, queue_size=None, flow_file_summaries=None, source_running=None, destination_running=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ListingRequestDTO - a model defined in Swagger

attribute_map = {'destination_running': 'destinationRunning', 'failure_reason': 'failureReason', 'finished': 'finished', 'flow_file_summaries': 'flowFileSummaries', 'id': 'id', 'last_updated': 'lastUpdated', 'max_results': 'maxResults', 'percent_completed': 'percentCompleted', 'queue_size': 'queueSize', 'source_running': 'sourceRunning', 'state': 'state', 'submission_time': 'submissionTime', 'uri': 'uri'}

destination_running

Gets the destination_running of this ListingRequestDTO. Whether the destination of the connection is running

Returns:The destination_running of this ListingRequestDTO. Return type:bool

failure_reason

Gets the failure_reason of this ListingRequestDTO. The reason, if any, that this listing request failed.

Returns:The failure_reason of this ListingRequestDTO. Return type:str

finished

Gets the finished of this ListingRequestDTO. Whether the query has finished.

Returns:The finished of this ListingRequestDTO. Return type:bool

flow_file_summaries

Gets the flow_file_summaries of this ListingRequestDTO. The FlowFile summaries. The summaries will be populated once the request has completed.

Returns:The flow_file_summaries of this ListingRequestDTO. Return type:list[FlowFileSummaryDTO]

id

Gets the id of this ListingRequestDTO. The id for this listing request.

Returns:The id of this ListingRequestDTO. Return type:str

last_updated

Gets the last_updated of this ListingRequestDTO. The last time this listing request was updated.

Returns:The last_updated of this ListingRequestDTO. Return type:str

max_results

Gets the max_results of this ListingRequestDTO. The maximum number of FlowFileSummary objects to return

Returns:The max_results of this ListingRequestDTO. Return type:int

percent_completed

Gets the percent_completed of this ListingRequestDTO. The current percent complete.

Returns:The percent_completed of this ListingRequestDTO. Return type:int

queue_size

Gets the queue_size of this ListingRequestDTO. The size of the queue

Returns:The queue_size of this ListingRequestDTO. Return type:QueueSizeDTO

source_running

Gets the source_running of this ListingRequestDTO. Whether the source of the connection is running

Returns:The source_running of this ListingRequestDTO. Return type:bool

state

Gets the state of this ListingRequestDTO. The current state of the listing request.

Returns:The state of this ListingRequestDTO. Return type:str

submission_time

Gets the submission_time of this ListingRequestDTO. The timestamp when the query was submitted.

Returns:The submission_time of this ListingRequestDTO. Return type:str

swagger_types = {'destination_running': 'bool', 'failure_reason': 'str', 'finished': 'bool', 'flow_file_summaries': 'list[FlowFileSummaryDTO]', 'id': 'str', 'last_updated': 'str', 'max_results': 'int', 'percent_completed': 'int', 'queue_size': 'QueueSizeDTO', 'source_running': 'bool', 'state': 'str', 'submission_time': 'str', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ListingRequestDTO. The URI for future requests to this listing request.

Returns:The uri of this ListingRequestDTO. Return type:str

nipyapi.nifi.models.listing_request_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.listing_request_entity.ListingRequestEntity(listing_request=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ListingRequestEntity - a model defined in Swagger

attribute_map = {'listing_request': 'listingRequest'}

listing_request

Gets the listing_request of this ListingRequestEntity.

Returns:The listing_request of this ListingRequestEntity. Return type:ListingRequestDTO

swagger_types = {'listing_request': 'ListingRequestDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_connection_status_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_connection_status_snapshot_dto.NodeConnectionStatusSnapshotDTO(node_id=None, address=None, api_port=None, status_snapshot=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

NodeConnectionStatusSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodeConnectionStatusSnapshotDTO. The API address of the node

Returns:The address of this NodeConnectionStatusSnapshotDTO. Return type:str

api_port

Gets the api_port of this NodeConnectionStatusSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodeConnectionStatusSnapshotDTO. Return type:int

attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'status_snapshot': 'statusSnapshot'}

node_id

Gets the node_id of this NodeConnectionStatusSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodeConnectionStatusSnapshotDTO. Return type:str

status_snapshot

Gets the status_snapshot of this NodeConnectionStatusSnapshotDTO. The connection status snapshot from the node.

Returns:The status_snapshot of this NodeConnectionStatusSnapshotDTO. Return type:ConnectionStatusSnapshotDTO

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'status_snapshot': 'ConnectionStatusSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_counters_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_counters_snapshot_dto.NodeCountersSnapshotDTO(node_id=None, address=None, api_port=None, snapshot=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

NodeCountersSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodeCountersSnapshotDTO. The API address of the node

Returns:The address of this NodeCountersSnapshotDTO. Return type:str

api_port

Gets the api_port of this NodeCountersSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodeCountersSnapshotDTO. Return type:int

attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'snapshot': 'snapshot'}

node_id

Gets the node_id of this NodeCountersSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodeCountersSnapshotDTO. Return type:str

snapshot

Gets the snapshot of this NodeCountersSnapshotDTO. The counters from the node.

Returns:The snapshot of this NodeCountersSnapshotDTO. Return type:CountersSnapshotDTO

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'snapshot': 'CountersSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_dto.NodeDTO(node_id=None, address=None, api_port=None, status=None, heartbeat=None, connection_requested=None, roles=None, active_thread_count=None, queued=None, events=None, node_start_time=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

NodeDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this NodeDTO. The active threads for the NiFi on the node.

Returns:The active_thread_count of this NodeDTO. Return type:int

address

Gets the address of this NodeDTO. The node’s host/ip address.

Returns:The address of this NodeDTO. Return type:str

api_port

Gets the api_port of this NodeDTO. The port the node is listening for API requests.

Returns:The api_port of this NodeDTO. Return type:int

attribute_map = {'active_thread_count': 'activeThreadCount', 'address': 'address', 'api_port': 'apiPort', 'connection_requested': 'connectionRequested', 'events': 'events', 'heartbeat': 'heartbeat', 'node_id': 'nodeId', 'node_start_time': 'nodeStartTime', 'queued': 'queued', 'roles': 'roles', 'status': 'status'}

connection_requested

Gets the connection_requested of this NodeDTO. The time of the node’s last connection request.

Returns:The connection_requested of this NodeDTO. Return type:str

events

Gets the events of this NodeDTO. The node’s events.

Returns:The events of this NodeDTO. Return type:list[NodeEventDTO]

heartbeat

Gets the heartbeat of this NodeDTO. the time of the nodes’s last heartbeat.

Returns:The heartbeat of this NodeDTO. Return type:str

node_id

Gets the node_id of this NodeDTO. The id of the node.

Returns:The node_id of this NodeDTO. Return type:str

node_start_time

Gets the node_start_time of this NodeDTO. The time at which this Node was last refreshed.

Returns:The node_start_time of this NodeDTO. Return type:str

queued

Gets the queued of this NodeDTO. The queue the NiFi on the node.

Returns:The queued of this NodeDTO. Return type:str

roles

Gets the roles of this NodeDTO. The roles of this node.

Returns:The roles of this NodeDTO. Return type:list[str]

status

Gets the status of this NodeDTO. The node’s status.

Returns:The status of this NodeDTO. Return type:str

swagger_types = {'active_thread_count': 'int', 'address': 'str', 'api_port': 'int', 'connection_requested': 'str', 'events': 'list[NodeEventDTO]', 'heartbeat': 'str', 'node_id': 'str', 'node_start_time': 'str', 'queued': 'str', 'roles': 'list[str]', 'status': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_entity.NodeEntity(node=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

NodeEntity - a model defined in Swagger

attribute_map = {'node': 'node'}

node

Gets the node of this NodeEntity.

Returns:The node of this NodeEntity. Return type:NodeDTO

swagger_types = {'node': 'NodeDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_event_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_event_dto.NodeEventDTO(timestamp=None, category=None, message=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

NodeEventDTO - a model defined in Swagger

attribute_map = {'category': 'category', 'message': 'message', 'timestamp': 'timestamp'}

category

Gets the category of this NodeEventDTO. The category of the node event.

Returns:The category of this NodeEventDTO. Return type:str

message

Gets the message of this NodeEventDTO. The message in the node event.

Returns:The message of this NodeEventDTO. Return type:str

swagger_types = {'category': 'str', 'message': 'str', 'timestamp': 'str'}

timestamp

Gets the timestamp of this NodeEventDTO. The timestamp of the node event.

Returns:The timestamp of this NodeEventDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_port_status_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_port_status_snapshot_dto.NodePortStatusSnapshotDTO(node_id=None, address=None, api_port=None, status_snapshot=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

NodePortStatusSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodePortStatusSnapshotDTO. The API address of the node

Returns:The address of this NodePortStatusSnapshotDTO. Return type:str

api_port

Gets the api_port of this NodePortStatusSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodePortStatusSnapshotDTO. Return type:int

attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'status_snapshot': 'statusSnapshot'}

node_id

Gets the node_id of this NodePortStatusSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodePortStatusSnapshotDTO. Return type:str

status_snapshot

Gets the status_snapshot of this NodePortStatusSnapshotDTO. The port status snapshot from the node.

Returns:The status_snapshot of this NodePortStatusSnapshotDTO. Return type:PortStatusSnapshotDTO

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'status_snapshot': 'PortStatusSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_process_group_status_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_process_group_status_snapshot_dto.NodeProcessGroupStatusSnapshotDTO(node_id=None, address=None, api_port=None, status_snapshot=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

NodeProcessGroupStatusSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodeProcessGroupStatusSnapshotDTO. The API address of the node

Returns:The address of this NodeProcessGroupStatusSnapshotDTO. Return type:str

api_port

Gets the api_port of this NodeProcessGroupStatusSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodeProcessGroupStatusSnapshotDTO. Return type:int

attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'status_snapshot': 'statusSnapshot'}

node_id

Gets the node_id of this NodeProcessGroupStatusSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodeProcessGroupStatusSnapshotDTO. Return type:str

status_snapshot

Gets the status_snapshot of this NodeProcessGroupStatusSnapshotDTO. The process group status snapshot from the node.

Returns:The status_snapshot of this NodeProcessGroupStatusSnapshotDTO. Return type:ProcessGroupStatusSnapshotDTO

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'status_snapshot': 'ProcessGroupStatusSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_processor_status_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_processor_status_snapshot_dto.NodeProcessorStatusSnapshotDTO(node_id=None, address=None, api_port=None, status_snapshot=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

NodeProcessorStatusSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodeProcessorStatusSnapshotDTO. The API address of the node

Returns:The address of this NodeProcessorStatusSnapshotDTO. Return type:str

api_port

Gets the api_port of this NodeProcessorStatusSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodeProcessorStatusSnapshotDTO. Return type:int

attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'status_snapshot': 'statusSnapshot'}

node_id

Gets the node_id of this NodeProcessorStatusSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodeProcessorStatusSnapshotDTO. Return type:str

status_snapshot

Gets the status_snapshot of this NodeProcessorStatusSnapshotDTO. The processor status snapshot from the node.

Returns:The status_snapshot of this NodeProcessorStatusSnapshotDTO. Return type:ProcessorStatusSnapshotDTO

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'status_snapshot': 'ProcessorStatusSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_remote_process_group_status_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_remote_process_group_status_snapshot_dto.NodeRemoteProcessGroupStatusSnapshotDTO(node_id=None, address=None, api_port=None, status_snapshot=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

NodeRemoteProcessGroupStatusSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodeRemoteProcessGroupStatusSnapshotDTO. The API address of the node

Returns:The address of this NodeRemoteProcessGroupStatusSnapshotDTO. Return type:str

api_port

Gets the api_port of this NodeRemoteProcessGroupStatusSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodeRemoteProcessGroupStatusSnapshotDTO. Return type:int

attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'status_snapshot': 'statusSnapshot'}

node_id

Gets the node_id of this NodeRemoteProcessGroupStatusSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodeRemoteProcessGroupStatusSnapshotDTO. Return type:str

status_snapshot

Gets the status_snapshot of this NodeRemoteProcessGroupStatusSnapshotDTO. The remote process group status snapshot from the node.

Returns:The status_snapshot of this NodeRemoteProcessGroupStatusSnapshotDTO. Return type:RemoteProcessGroupStatusSnapshotDTO

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'status_snapshot': 'RemoteProcessGroupStatusSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_search_result_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_search_result_dto.NodeSearchResultDTO(id=None, address=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

NodeSearchResultDTO - a model defined in Swagger

address

Gets the address of this NodeSearchResultDTO. The address of the node that matched the search.

Returns:The address of this NodeSearchResultDTO. Return type:str

attribute_map = {'address': 'address', 'id': 'id'}

id

Gets the id of this NodeSearchResultDTO. The id of the node that matched the search.

Returns:The id of this NodeSearchResultDTO. Return type:str

swagger_types = {'address': 'str', 'id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_status_snapshots_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_status_snapshots_dto.NodeStatusSnapshotsDTO(node_id=None, address=None, api_port=None, status_snapshots=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

NodeStatusSnapshotsDTO - a model defined in Swagger

address

Gets the address of this NodeStatusSnapshotsDTO. The node’s host/ip address.

Returns:The address of this NodeStatusSnapshotsDTO. Return type:str

api_port

Gets the api_port of this NodeStatusSnapshotsDTO. The port the node is listening for API requests.

Returns:The api_port of this NodeStatusSnapshotsDTO. Return type:int

attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'status_snapshots': 'statusSnapshots'}

node_id

Gets the node_id of this NodeStatusSnapshotsDTO. The id of the node.

Returns:The node_id of this NodeStatusSnapshotsDTO. Return type:str

status_snapshots

Gets the status_snapshots of this NodeStatusSnapshotsDTO. A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.

Returns:The status_snapshots of this NodeStatusSnapshotsDTO. Return type:list[StatusSnapshotDTO]

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'status_snapshots': 'list[StatusSnapshotDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_system_diagnostics_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_system_diagnostics_snapshot_dto.NodeSystemDiagnosticsSnapshotDTO(node_id=None, address=None, api_port=None, snapshot=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

NodeSystemDiagnosticsSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodeSystemDiagnosticsSnapshotDTO. The API address of the node

Returns:The address of this NodeSystemDiagnosticsSnapshotDTO. Return type:str

api_port

Gets the api_port of this NodeSystemDiagnosticsSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodeSystemDiagnosticsSnapshotDTO. Return type:int

attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'snapshot': 'snapshot'}

node_id

Gets the node_id of this NodeSystemDiagnosticsSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodeSystemDiagnosticsSnapshotDTO. Return type:str

snapshot

Gets the snapshot of this NodeSystemDiagnosticsSnapshotDTO. The System Diagnostics snapshot from the node.

Returns:The snapshot of this NodeSystemDiagnosticsSnapshotDTO. Return type:SystemDiagnosticsSnapshotDTO

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'snapshot': 'SystemDiagnosticsSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.output_ports_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.output_ports_entity.OutputPortsEntity(output_ports=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

OutputPortsEntity - a model defined in Swagger

attribute_map = {'output_ports': 'outputPorts'}

output_ports

Gets the output_ports of this OutputPortsEntity.

Returns:The output_ports of this OutputPortsEntity. Return type:list[PortEntity]

swagger_types = {'output_ports': 'list[PortEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.peer_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.peer_dto.PeerDTO(hostname=None, port=None, secure=None, flow_file_count=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PeerDTO - a model defined in Swagger

attribute_map = {'flow_file_count': 'flowFileCount', 'hostname': 'hostname', 'port': 'port', 'secure': 'secure'}

flow_file_count

Gets the flow_file_count of this PeerDTO. The number of flowFiles this peer holds.

Returns:The flow_file_count of this PeerDTO. Return type:int

hostname

Gets the hostname of this PeerDTO. The hostname of this peer.

Returns:The hostname of this PeerDTO. Return type:str

port

Gets the port of this PeerDTO. The port number of this peer.

Returns:The port of this PeerDTO. Return type:int

secure

Gets the secure of this PeerDTO. Returns if this peer connection is secure.

Returns:The secure of this PeerDTO. Return type:bool

swagger_types = {'flow_file_count': 'int', 'hostname': 'str', 'port': 'int', 'secure': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.peers_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.peers_entity.PeersEntity(peers=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PeersEntity - a model defined in Swagger

attribute_map = {'peers': 'peers'}

peers

Gets the peers of this PeersEntity.

Returns:The peers of this PeersEntity. Return type:list[PeerDTO]

swagger_types = {'peers': 'list[PeerDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.permissions 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.permissions.Permissions(can_read=None, can_write=None, can_delete=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

Permissions - a model defined in Swagger

attribute_map = {'can_delete': 'canDelete', 'can_read': 'canRead', 'can_write': 'canWrite'}

can_delete

Gets the can_delete of this Permissions. Indicates whether the user can delete a given resource.

Returns:The can_delete of this Permissions. Return type:bool

can_read

Gets the can_read of this Permissions. Indicates whether the user can read a given resource.

Returns:The can_read of this Permissions. Return type:bool

can_write

Gets the can_write of this Permissions. Indicates whether the user can write a given resource.

Returns:The can_write of this Permissions. Return type:bool

swagger_types = {'can_delete': 'bool', 'can_read': 'bool', 'can_write': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.permissions_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.permissions_dto.PermissionsDTO(can_read=None, can_write=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PermissionsDTO - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'can_write': 'canWrite'}

can_read

Gets the can_read of this PermissionsDTO. Indicates whether the user can read a given resource.

Returns:The can_read of this PermissionsDTO. Return type:bool

can_write

Gets the can_write of this PermissionsDTO. Indicates whether the user can write a given resource.

Returns:The can_write of this PermissionsDTO. Return type:bool

swagger_types = {'can_read': 'bool', 'can_write': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.port_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.port_dto.PortDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, comments=None, state=None, type=None, transmitting=None, concurrently_schedulable_task_count=None, user_access_control=None, group_access_control=None, allow_remote_access=None, validation_errors=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PortDTO - a model defined in Swagger

allow_remote_access

Gets the allow_remote_access of this PortDTO. Whether this port can be accessed remotely via Site-to-Site protocol.

Returns:The allow_remote_access of this PortDTO. Return type:bool

attribute_map = {'allow_remote_access': 'allowRemoteAccess', 'comments': 'comments', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'group_access_control': 'groupAccessControl', 'id': 'id', 'name': 'name', 'parent_group_id': 'parentGroupId', 'position': 'position', 'state': 'state', 'transmitting': 'transmitting', 'type': 'type', 'user_access_control': 'userAccessControl', 'validation_errors': 'validationErrors', 'versioned_component_id': 'versionedComponentId'}

comments

Gets the comments of this PortDTO. The comments for the port.

Returns:The comments of this PortDTO. Return type:str

concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this PortDTO. The number of tasks that should be concurrently scheduled for the port.

Returns:The concurrently_schedulable_task_count of this PortDTO. Return type:int

group_access_control

Gets the group_access_control of this PortDTO. The user groups that are allowed to access the port.

Returns:The group_access_control of this PortDTO. Return type:list[str]

id

Gets the id of this PortDTO. The id of the component.

Returns:The id of this PortDTO. Return type:str

name

Gets the name of this PortDTO. The name of the port.

Returns:The name of this PortDTO. Return type:str

parent_group_id

Gets the parent_group_id of this PortDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this PortDTO. Return type:str

position

Gets the position of this PortDTO. The position of this component in the UI if applicable.

Returns:The position of this PortDTO. Return type:PositionDTO

state

Gets the state of this PortDTO. The state of the port.

Returns:The state of this PortDTO. Return type:str

swagger_types = {'allow_remote_access': 'bool', 'comments': 'str', 'concurrently_schedulable_task_count': 'int', 'group_access_control': 'list[str]', 'id': 'str', 'name': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'state': 'str', 'transmitting': 'bool', 'type': 'str', 'user_access_control': 'list[str]', 'validation_errors': 'list[str]', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transmitting

Gets the transmitting of this PortDTO. Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely.

Returns:The transmitting of this PortDTO. Return type:bool

type

Gets the type of this PortDTO. The type of port.

Returns:The type of this PortDTO. Return type:str

user_access_control

Gets the user_access_control of this PortDTO. The users that are allowed to access the port.

Returns:The user_access_control of this PortDTO. Return type:list[str]

validation_errors

Gets the validation_errors of this PortDTO. Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.

Returns:The validation_errors of this PortDTO. Return type:list[str]

versioned_component_id

Gets the versioned_component_id of this PortDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this PortDTO. Return type:str

nipyapi.nifi.models.port_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.port_entity.PortEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, port_type=None, operate_permissions=None, allow_remote_access=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PortEntity - a model defined in Swagger

allow_remote_access

Gets the allow_remote_access of this PortEntity. Whether this port can be accessed remotely via Site-to-Site protocol.

Returns:The allow_remote_access of this PortEntity. Return type:bool

attribute_map = {'allow_remote_access': 'allowRemoteAccess', 'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'operate_permissions': 'operatePermissions', 'permissions': 'permissions', 'port_type': 'portType', 'position': 'position', 'revision': 'revision', 'status': 'status', 'uri': 'uri'}

bulletins

Gets the bulletins of this PortEntity. The bulletins for this component.

Returns:The bulletins of this PortEntity. Return type:list[BulletinEntity]

component

Gets the component of this PortEntity.

Returns:The component of this PortEntity. Return type:PortDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this PortEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this PortEntity. Return type:bool

id

Gets the id of this PortEntity. The id of the component.

Returns:The id of this PortEntity. Return type:str

operate_permissions

Gets the operate_permissions of this PortEntity. The permissions for this component operations.

Returns:The operate_permissions of this PortEntity. Return type:PermissionsDTO

permissions

Gets the permissions of this PortEntity. The permissions for this component.

Returns:The permissions of this PortEntity. Return type:PermissionsDTO

port_type

Gets the port_type of this PortEntity.

Returns:The port_type of this PortEntity. Return type:str

position

Gets the position of this PortEntity. The position of this component in the UI if applicable.

Returns:The position of this PortEntity. Return type:PositionDTO

revision

Gets the revision of this PortEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this PortEntity. Return type:RevisionDTO

status

Gets the status of this PortEntity. The status of the port.

Returns:The status of this PortEntity. Return type:PortStatusDTO

swagger_types = {'allow_remote_access': 'bool', 'bulletins': 'list[BulletinEntity]', 'component': 'PortDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'operate_permissions': 'PermissionsDTO', 'permissions': 'PermissionsDTO', 'port_type': 'str', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'status': 'PortStatusDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this PortEntity. The URI for futures requests to the component.

Returns:The uri of this PortEntity. Return type:str

nipyapi.nifi.models.port_status_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.port_status_dto.PortStatusDTO(id=None, group_id=None, name=None, transmitting=None, run_status=None, stats_last_refreshed=None, aggregate_snapshot=None, node_snapshots=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PortStatusDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this PortStatusDTO. A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.

Returns:The aggregate_snapshot of this PortStatusDTO. Return type:PortStatusSnapshotDTO

attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'node_snapshots': 'nodeSnapshots', 'run_status': 'runStatus', 'stats_last_refreshed': 'statsLastRefreshed', 'transmitting': 'transmitting'}

group_id

Gets the group_id of this PortStatusDTO. The id of the parent process group of the port.

Returns:The group_id of this PortStatusDTO. Return type:str

id

Gets the id of this PortStatusDTO. The id of the port.

Returns:The id of this PortStatusDTO. Return type:str

name

Gets the name of this PortStatusDTO. The name of the port.

Returns:The name of this PortStatusDTO. Return type:str

node_snapshots

Gets the node_snapshots of this PortStatusDTO. A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.

Returns:The node_snapshots of this PortStatusDTO. Return type:list[NodePortStatusSnapshotDTO]

run_status

Gets the run_status of this PortStatusDTO. The run status of the port.

Returns:The run_status of this PortStatusDTO. Return type:str

stats_last_refreshed

Gets the stats_last_refreshed of this PortStatusDTO. The time the status for the process group was last refreshed.

Returns:The stats_last_refreshed of this PortStatusDTO. Return type:str

swagger_types = {'aggregate_snapshot': 'PortStatusSnapshotDTO', 'group_id': 'str', 'id': 'str', 'name': 'str', 'node_snapshots': 'list[NodePortStatusSnapshotDTO]', 'run_status': 'str', 'stats_last_refreshed': 'str', 'transmitting': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transmitting

Gets the transmitting of this PortStatusDTO. Whether the port has incoming or outgoing connections to a remote NiFi.

Returns:The transmitting of this PortStatusDTO. Return type:bool

nipyapi.nifi.models.port_status_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.port_status_entity.PortStatusEntity(port_status=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PortStatusEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'port_status': 'portStatus'}

can_read

Gets the can_read of this PortStatusEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this PortStatusEntity. Return type:bool

port_status

Gets the port_status of this PortStatusEntity.

Returns:The port_status of this PortStatusEntity. Return type:PortStatusDTO

swagger_types = {'can_read': 'bool', 'port_status': 'PortStatusDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.port_status_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.port_status_snapshot_dto.PortStatusSnapshotDTO(id=None, group_id=None, name=None, active_thread_count=None, flow_files_in=None, bytes_in=None, input=None, flow_files_out=None, bytes_out=None, output=None, transmitting=None, run_status=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PortStatusSnapshotDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this PortStatusSnapshotDTO. The active thread count for the port.

Returns:The active_thread_count of this PortStatusSnapshotDTO. Return type:int

attribute_map = {'active_thread_count': 'activeThreadCount', 'bytes_in': 'bytesIn', 'bytes_out': 'bytesOut', 'flow_files_in': 'flowFilesIn', 'flow_files_out': 'flowFilesOut', 'group_id': 'groupId', 'id': 'id', 'input': 'input', 'name': 'name', 'output': 'output', 'run_status': 'runStatus', 'transmitting': 'transmitting'}

bytes_in

Gets the bytes_in of this PortStatusSnapshotDTO. The size of hte FlowFiles that have been accepted in the last 5 minutes.

Returns:The bytes_in of this PortStatusSnapshotDTO. Return type:int

bytes_out

Gets the bytes_out of this PortStatusSnapshotDTO. The number of bytes that have been processed in the last 5 minutes.

Returns:The bytes_out of this PortStatusSnapshotDTO. Return type:int

flow_files_in

Gets the flow_files_in of this PortStatusSnapshotDTO. The number of FlowFiles that have been accepted in the last 5 minutes.

Returns:The flow_files_in of this PortStatusSnapshotDTO. Return type:int

flow_files_out

Gets the flow_files_out of this PortStatusSnapshotDTO. The number of FlowFiles that have been processed in the last 5 minutes.

Returns:The flow_files_out of this PortStatusSnapshotDTO. Return type:int

group_id

Gets the group_id of this PortStatusSnapshotDTO. The id of the parent process group of the port.

Returns:The group_id of this PortStatusSnapshotDTO. Return type:str

id

Gets the id of this PortStatusSnapshotDTO. The id of the port.

Returns:The id of this PortStatusSnapshotDTO. Return type:str

input

Gets the input of this PortStatusSnapshotDTO. The count/size of flowfiles that have been accepted in the last 5 minutes.

Returns:The input of this PortStatusSnapshotDTO. Return type:str

name

Gets the name of this PortStatusSnapshotDTO. The name of the port.

Returns:The name of this PortStatusSnapshotDTO. Return type:str

output

Gets the output of this PortStatusSnapshotDTO. The count/size of flowfiles that have been processed in the last 5 minutes.

Returns:The output of this PortStatusSnapshotDTO. Return type:str

run_status

Gets the run_status of this PortStatusSnapshotDTO. The run status of the port.

Returns:The run_status of this PortStatusSnapshotDTO. Return type:str

swagger_types = {'active_thread_count': 'int', 'bytes_in': 'int', 'bytes_out': 'int', 'flow_files_in': 'int', 'flow_files_out': 'int', 'group_id': 'str', 'id': 'str', 'input': 'str', 'name': 'str', 'output': 'str', 'run_status': 'str', 'transmitting': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transmitting

Gets the transmitting of this PortStatusSnapshotDTO. Whether the port has incoming or outgoing connections to a remote NiFi.

Returns:The transmitting of this PortStatusSnapshotDTO. Return type:bool

nipyapi.nifi.models.port_status_snapshot_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.port_status_snapshot_entity.PortStatusSnapshotEntity(id=None, port_status_snapshot=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PortStatusSnapshotEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'id': 'id', 'port_status_snapshot': 'portStatusSnapshot'}

can_read

Gets the can_read of this PortStatusSnapshotEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this PortStatusSnapshotEntity. Return type:bool

id

Gets the id of this PortStatusSnapshotEntity. The id of the port.

Returns:The id of this PortStatusSnapshotEntity. Return type:str

port_status_snapshot

Gets the port_status_snapshot of this PortStatusSnapshotEntity.

Returns:The port_status_snapshot of this PortStatusSnapshotEntity. Return type:PortStatusSnapshotDTO

swagger_types = {'can_read': 'bool', 'id': 'str', 'port_status_snapshot': 'PortStatusSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.position_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.position_dto.PositionDTO(x=None, y=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PositionDTO - a model defined in Swagger

attribute_map = {'x': 'x', 'y': 'y'}

swagger_types = {'x': 'float', 'y': 'float'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

x

Gets the x of this PositionDTO. The x coordinate.

Returns:The x of this PositionDTO. Return type:float

y

Gets the y of this PositionDTO. The y coordinate.

Returns:The y of this PositionDTO. Return type:float

nipyapi.nifi.models.previous_value_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.previous_value_dto.PreviousValueDTO(previous_value=None, timestamp=None, user_identity=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PreviousValueDTO - a model defined in Swagger

attribute_map = {'previous_value': 'previousValue', 'timestamp': 'timestamp', 'user_identity': 'userIdentity'}

previous_value

Gets the previous_value of this PreviousValueDTO. The previous value.

Returns:The previous_value of this PreviousValueDTO. Return type:str

swagger_types = {'previous_value': 'str', 'timestamp': 'str', 'user_identity': 'str'}

timestamp

Gets the timestamp of this PreviousValueDTO. The timestamp when the value was modified.

Returns:The timestamp of this PreviousValueDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

user_identity

Gets the user_identity of this PreviousValueDTO. The user who changed the previous value.

Returns:The user_identity of this PreviousValueDTO. Return type:str

nipyapi.nifi.models.prioritizer_types_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.prioritizer_types_entity.PrioritizerTypesEntity(prioritizer_types=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PrioritizerTypesEntity - a model defined in Swagger

attribute_map = {'prioritizer_types': 'prioritizerTypes'}

prioritizer_types

Gets the prioritizer_types of this PrioritizerTypesEntity.

Returns:The prioritizer_types of this PrioritizerTypesEntity. Return type:list[DocumentedTypeDTO]

swagger_types = {'prioritizer_types': 'list[DocumentedTypeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.process_group_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_dto.ProcessGroupDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, comments=None, variables=None, version_control_information=None, parameter_context=None, flowfile_concurrency=None, flowfile_outbound_policy=None, default_flow_file_expiration=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None, running_count=None, stopped_count=None, invalid_count=None, disabled_count=None, active_remote_port_count=None, inactive_remote_port_count=None, up_to_date_count=None, locally_modified_count=None, stale_count=None, locally_modified_and_stale_count=None, sync_failure_count=None, local_input_port_count=None, local_output_port_count=None, public_input_port_count=None, public_output_port_count=None, contents=None, input_port_count=None, output_port_count=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessGroupDTO - a model defined in Swagger

active_remote_port_count

Gets the active_remote_port_count of this ProcessGroupDTO. The number of active remote ports in the process group.

Returns:The active_remote_port_count of this ProcessGroupDTO. Return type:int

attribute_map = {'active_remote_port_count': 'activeRemotePortCount', 'comments': 'comments', 'contents': 'contents', 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', 'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', 'default_flow_file_expiration': 'defaultFlowFileExpiration', 'disabled_count': 'disabledCount', 'flowfile_concurrency': 'flowfileConcurrency', 'flowfile_outbound_policy': 'flowfileOutboundPolicy', 'id': 'id', 'inactive_remote_port_count': 'inactiveRemotePortCount', 'input_port_count': 'inputPortCount', 'invalid_count': 'invalidCount', 'local_input_port_count': 'localInputPortCount', 'local_output_port_count': 'localOutputPortCount', 'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', 'locally_modified_count': 'locallyModifiedCount', 'name': 'name', 'output_port_count': 'outputPortCount', 'parameter_context': 'parameterContext', 'parent_group_id': 'parentGroupId', 'position': 'position', 'public_input_port_count': 'publicInputPortCount', 'public_output_port_count': 'publicOutputPortCount', 'running_count': 'runningCount', 'stale_count': 'staleCount', 'stopped_count': 'stoppedCount', 'sync_failure_count': 'syncFailureCount', 'up_to_date_count': 'upToDateCount', 'variables': 'variables', 'version_control_information': 'versionControlInformation', 'versioned_component_id': 'versionedComponentId'}

comments

Gets the comments of this ProcessGroupDTO. The comments for the process group.

Returns:The comments of this ProcessGroupDTO. Return type:str

contents

Gets the contents of this ProcessGroupDTO. The contents of this process group.

Returns:The contents of this ProcessGroupDTO. Return type:FlowSnippetDTO

default_back_pressure_data_size_threshold

Gets the default_back_pressure_data_size_threshold of this ProcessGroupDTO. Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied.

Returns:The default_back_pressure_data_size_threshold of this ProcessGroupDTO. Return type:str

default_back_pressure_object_threshold

Gets the default_back_pressure_object_threshold of this ProcessGroupDTO. Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied.

Returns:The default_back_pressure_object_threshold of this ProcessGroupDTO. Return type:int

default_flow_file_expiration

Gets the default_flow_file_expiration of this ProcessGroupDTO. The default FlowFile Expiration for this Process Group.

Returns:The default_flow_file_expiration of this ProcessGroupDTO. Return type:str

disabled_count

Gets the disabled_count of this ProcessGroupDTO. The number of disabled components in the process group.

Returns:The disabled_count of this ProcessGroupDTO. Return type:int

flowfile_concurrency

Gets the flowfile_concurrency of this ProcessGroupDTO. The FlowFile Concurrency for this Process Group.

Returns:The flowfile_concurrency of this ProcessGroupDTO. Return type:str

flowfile_outbound_policy

Gets the flowfile_outbound_policy of this ProcessGroupDTO. The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.

Returns:The flowfile_outbound_policy of this ProcessGroupDTO. Return type:str

id

Gets the id of this ProcessGroupDTO. The id of the component.

Returns:The id of this ProcessGroupDTO. Return type:str

inactive_remote_port_count

Gets the inactive_remote_port_count of this ProcessGroupDTO. The number of inactive remote ports in the process group.

Returns:The inactive_remote_port_count of this ProcessGroupDTO. Return type:int

input_port_count

Gets the input_port_count of this ProcessGroupDTO. The number of input ports in the process group.

Returns:The input_port_count of this ProcessGroupDTO. Return type:int

invalid_count

Gets the invalid_count of this ProcessGroupDTO. The number of invalid components in the process group.

Returns:The invalid_count of this ProcessGroupDTO. Return type:int

local_input_port_count

Gets the local_input_port_count of this ProcessGroupDTO. The number of local input ports in the process group.

Returns:The local_input_port_count of this ProcessGroupDTO. Return type:int

local_output_port_count

Gets the local_output_port_count of this ProcessGroupDTO. The number of local output ports in the process group.

Returns:The local_output_port_count of this ProcessGroupDTO. Return type:int

locally_modified_and_stale_count

Gets the locally_modified_and_stale_count of this ProcessGroupDTO. The number of locally modified and stale versioned process groups in the process group.

Returns:The locally_modified_and_stale_count of this ProcessGroupDTO. Return type:int

locally_modified_count

Gets the locally_modified_count of this ProcessGroupDTO. The number of locally modified versioned process groups in the process group.

Returns:The locally_modified_count of this ProcessGroupDTO. Return type:int

name

Gets the name of this ProcessGroupDTO. The name of the process group.

Returns:The name of this ProcessGroupDTO. Return type:str

output_port_count

Gets the output_port_count of this ProcessGroupDTO. The number of output ports in the process group.

Returns:The output_port_count of this ProcessGroupDTO. Return type:int

parameter_context

Gets the parameter_context of this ProcessGroupDTO. The Parameter Context that this Process Group is bound to.

Returns:The parameter_context of this ProcessGroupDTO. Return type:ParameterContextReferenceEntity

parent_group_id

Gets the parent_group_id of this ProcessGroupDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this ProcessGroupDTO. Return type:str

position

Gets the position of this ProcessGroupDTO. The position of this component in the UI if applicable.

Returns:The position of this ProcessGroupDTO. Return type:PositionDTO

public_input_port_count

Gets the public_input_port_count of this ProcessGroupDTO. The number of public input ports in the process group.

Returns:The public_input_port_count of this ProcessGroupDTO. Return type:int

public_output_port_count

Gets the public_output_port_count of this ProcessGroupDTO. The number of public output ports in the process group.

Returns:The public_output_port_count of this ProcessGroupDTO. Return type:int

running_count

Gets the running_count of this ProcessGroupDTO. The number of running components in this process group.

Returns:The running_count of this ProcessGroupDTO. Return type:int

stale_count

Gets the stale_count of this ProcessGroupDTO. The number of stale versioned process groups in the process group.

Returns:The stale_count of this ProcessGroupDTO. Return type:int

stopped_count

Gets the stopped_count of this ProcessGroupDTO. The number of stopped components in the process group.

Returns:The stopped_count of this ProcessGroupDTO. Return type:int

swagger_types = {'active_remote_port_count': 'int', 'comments': 'str', 'contents': 'FlowSnippetDTO', 'default_back_pressure_data_size_threshold': 'str', 'default_back_pressure_object_threshold': 'int', 'default_flow_file_expiration': 'str', 'disabled_count': 'int', 'flowfile_concurrency': 'str', 'flowfile_outbound_policy': 'str', 'id': 'str', 'inactive_remote_port_count': 'int', 'input_port_count': 'int', 'invalid_count': 'int', 'local_input_port_count': 'int', 'local_output_port_count': 'int', 'locally_modified_and_stale_count': 'int', 'locally_modified_count': 'int', 'name': 'str', 'output_port_count': 'int', 'parameter_context': 'ParameterContextReferenceEntity', 'parent_group_id': 'str', 'position': 'PositionDTO', 'public_input_port_count': 'int', 'public_output_port_count': 'int', 'running_count': 'int', 'stale_count': 'int', 'stopped_count': 'int', 'sync_failure_count': 'int', 'up_to_date_count': 'int', 'variables': 'dict(str, str)', 'version_control_information': 'VersionControlInformationDTO', 'versioned_component_id': 'str'}

sync_failure_count

Gets the sync_failure_count of this ProcessGroupDTO. The number of versioned process groups in the process group that are unable to sync to a registry.

Returns:The sync_failure_count of this ProcessGroupDTO. Return type:int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

up_to_date_count

Gets the up_to_date_count of this ProcessGroupDTO. The number of up to date versioned process groups in the process group.

Returns:The up_to_date_count of this ProcessGroupDTO. Return type:int

variables

Gets the variables of this ProcessGroupDTO. The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.

Returns:The variables of this ProcessGroupDTO. Return type:dict(str, str)

version_control_information

Gets the version_control_information of this ProcessGroupDTO. The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control

Returns:The version_control_information of this ProcessGroupDTO. Return type:VersionControlInformationDTO

versioned_component_id

Gets the versioned_component_id of this ProcessGroupDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this ProcessGroupDTO. Return type:str

nipyapi.nifi.models.process_group_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_entity.ProcessGroupEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, versioned_flow_snapshot=None, running_count=None, stopped_count=None, invalid_count=None, disabled_count=None, active_remote_port_count=None, inactive_remote_port_count=None, versioned_flow_state=None, up_to_date_count=None, locally_modified_count=None, stale_count=None, locally_modified_and_stale_count=None, sync_failure_count=None, local_input_port_count=None, local_output_port_count=None, public_input_port_count=None, public_output_port_count=None, parameter_context=None, input_port_count=None, output_port_count=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessGroupEntity - a model defined in Swagger

active_remote_port_count

Gets the active_remote_port_count of this ProcessGroupEntity. The number of active remote ports in the process group.

Returns:The active_remote_port_count of this ProcessGroupEntity. Return type:int

attribute_map = {'active_remote_port_count': 'activeRemotePortCount', 'bulletins': 'bulletins', 'component': 'component', 'disabled_count': 'disabledCount', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'inactive_remote_port_count': 'inactiveRemotePortCount', 'input_port_count': 'inputPortCount', 'invalid_count': 'invalidCount', 'local_input_port_count': 'localInputPortCount', 'local_output_port_count': 'localOutputPortCount', 'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', 'locally_modified_count': 'locallyModifiedCount', 'output_port_count': 'outputPortCount', 'parameter_context': 'parameterContext', 'permissions': 'permissions', 'position': 'position', 'public_input_port_count': 'publicInputPortCount', 'public_output_port_count': 'publicOutputPortCount', 'revision': 'revision', 'running_count': 'runningCount', 'stale_count': 'staleCount', 'status': 'status', 'stopped_count': 'stoppedCount', 'sync_failure_count': 'syncFailureCount', 'up_to_date_count': 'upToDateCount', 'uri': 'uri', 'versioned_flow_snapshot': 'versionedFlowSnapshot', 'versioned_flow_state': 'versionedFlowState'}

bulletins

Gets the bulletins of this ProcessGroupEntity. The bulletins for this component.

Returns:The bulletins of this ProcessGroupEntity. Return type:list[BulletinEntity]

component

Gets the component of this ProcessGroupEntity.

Returns:The component of this ProcessGroupEntity. Return type:ProcessGroupDTO

disabled_count

Gets the disabled_count of this ProcessGroupEntity. The number of disabled components in the process group.

Returns:The disabled_count of this ProcessGroupEntity. Return type:int

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ProcessGroupEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ProcessGroupEntity. Return type:bool

id

Gets the id of this ProcessGroupEntity. The id of the component.

Returns:The id of this ProcessGroupEntity. Return type:str

inactive_remote_port_count

Gets the inactive_remote_port_count of this ProcessGroupEntity. The number of inactive remote ports in the process group.

Returns:The inactive_remote_port_count of this ProcessGroupEntity. Return type:int

input_port_count

Gets the input_port_count of this ProcessGroupEntity. The number of input ports in the process group.

Returns:The input_port_count of this ProcessGroupEntity. Return type:int

invalid_count

Gets the invalid_count of this ProcessGroupEntity. The number of invalid components in the process group.

Returns:The invalid_count of this ProcessGroupEntity. Return type:int

local_input_port_count

Gets the local_input_port_count of this ProcessGroupEntity. The number of local input ports in the process group.

Returns:The local_input_port_count of this ProcessGroupEntity. Return type:int

local_output_port_count

Gets the local_output_port_count of this ProcessGroupEntity. The number of local output ports in the process group.

Returns:The local_output_port_count of this ProcessGroupEntity. Return type:int

locally_modified_and_stale_count

Gets the locally_modified_and_stale_count of this ProcessGroupEntity. The number of locally modified and stale versioned process groups in the process group.

Returns:The locally_modified_and_stale_count of this ProcessGroupEntity. Return type:int

locally_modified_count

Gets the locally_modified_count of this ProcessGroupEntity. The number of locally modified versioned process groups in the process group.

Returns:The locally_modified_count of this ProcessGroupEntity. Return type:int

output_port_count

Gets the output_port_count of this ProcessGroupEntity. The number of output ports in the process group.

Returns:The output_port_count of this ProcessGroupEntity. Return type:int

parameter_context

Gets the parameter_context of this ProcessGroupEntity. The Parameter Context, or null if no Parameter Context has been bound to the Process Group

Returns:The parameter_context of this ProcessGroupEntity. Return type:ParameterContextReferenceEntity

permissions

Gets the permissions of this ProcessGroupEntity. The permissions for this component.

Returns:The permissions of this ProcessGroupEntity. Return type:PermissionsDTO

position

Gets the position of this ProcessGroupEntity. The position of this component in the UI if applicable.

Returns:The position of this ProcessGroupEntity. Return type:PositionDTO

public_input_port_count

Gets the public_input_port_count of this ProcessGroupEntity. The number of public input ports in the process group.

Returns:The public_input_port_count of this ProcessGroupEntity. Return type:int

public_output_port_count

Gets the public_output_port_count of this ProcessGroupEntity. The number of public output ports in the process group.

Returns:The public_output_port_count of this ProcessGroupEntity. Return type:int

revision

Gets the revision of this ProcessGroupEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this ProcessGroupEntity. Return type:RevisionDTO

running_count

Gets the running_count of this ProcessGroupEntity. The number of running components in this process group.

Returns:The running_count of this ProcessGroupEntity. Return type:int

stale_count

Gets the stale_count of this ProcessGroupEntity. The number of stale versioned process groups in the process group.

Returns:The stale_count of this ProcessGroupEntity. Return type:int

status

Gets the status of this ProcessGroupEntity. The status of the process group.

Returns:The status of this ProcessGroupEntity. Return type:ProcessGroupStatusDTO

stopped_count

Gets the stopped_count of this ProcessGroupEntity. The number of stopped components in the process group.

Returns:The stopped_count of this ProcessGroupEntity. Return type:int

swagger_types = {'active_remote_port_count': 'int', 'bulletins': 'list[BulletinEntity]', 'component': 'ProcessGroupDTO', 'disabled_count': 'int', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'inactive_remote_port_count': 'int', 'input_port_count': 'int', 'invalid_count': 'int', 'local_input_port_count': 'int', 'local_output_port_count': 'int', 'locally_modified_and_stale_count': 'int', 'locally_modified_count': 'int', 'output_port_count': 'int', 'parameter_context': 'ParameterContextReferenceEntity', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'public_input_port_count': 'int', 'public_output_port_count': 'int', 'revision': 'RevisionDTO', 'running_count': 'int', 'stale_count': 'int', 'status': 'ProcessGroupStatusDTO', 'stopped_count': 'int', 'sync_failure_count': 'int', 'up_to_date_count': 'int', 'uri': 'str', 'versioned_flow_snapshot': 'VersionedFlowSnapshot', 'versioned_flow_state': 'str'}

sync_failure_count

Gets the sync_failure_count of this ProcessGroupEntity. The number of versioned process groups in the process group that are unable to sync to a registry.

Returns:The sync_failure_count of this ProcessGroupEntity. Return type:int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

up_to_date_count

Gets the up_to_date_count of this ProcessGroupEntity. The number of up to date versioned process groups in the process group.

Returns:The up_to_date_count of this ProcessGroupEntity. Return type:int

uri

Gets the uri of this ProcessGroupEntity. The URI for futures requests to the component.

Returns:The uri of this ProcessGroupEntity. Return type:str

versioned_flow_snapshot

Gets the versioned_flow_snapshot of this ProcessGroupEntity. Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported

Returns:The versioned_flow_snapshot of this ProcessGroupEntity. Return type:VersionedFlowSnapshot

versioned_flow_state

Gets the versioned_flow_state of this ProcessGroupEntity. The current state of the Process Group, as it relates to the Versioned Flow

Returns:The versioned_flow_state of this ProcessGroupEntity. Return type:str

nipyapi.nifi.models.process_group_flow_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_flow_dto.ProcessGroupFlowDTO(id=None, uri=None, parent_group_id=None, parameter_context=None, breadcrumb=None, flow=None, last_refreshed=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessGroupFlowDTO - a model defined in Swagger

attribute_map = {'breadcrumb': 'breadcrumb', 'flow': 'flow', 'id': 'id', 'last_refreshed': 'lastRefreshed', 'parameter_context': 'parameterContext', 'parent_group_id': 'parentGroupId', 'uri': 'uri'}

breadcrumb

Gets the breadcrumb of this ProcessGroupFlowDTO. The breadcrumb of the process group.

Returns:The breadcrumb of this ProcessGroupFlowDTO. Return type:FlowBreadcrumbEntity

flow

Gets the flow of this ProcessGroupFlowDTO. The flow structure starting at this Process Group.

Returns:The flow of this ProcessGroupFlowDTO. Return type:FlowDTO

id

Gets the id of this ProcessGroupFlowDTO. The id of the component.

Returns:The id of this ProcessGroupFlowDTO. Return type:str

last_refreshed

Gets the last_refreshed of this ProcessGroupFlowDTO. The time the flow for the process group was last refreshed.

Returns:The last_refreshed of this ProcessGroupFlowDTO. Return type:str

parameter_context

Gets the parameter_context of this ProcessGroupFlowDTO. The Parameter Context, or null if no Parameter Context has been bound to the Process Group

Returns:The parameter_context of this ProcessGroupFlowDTO. Return type:ParameterContextReferenceEntity

parent_group_id

Gets the parent_group_id of this ProcessGroupFlowDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this ProcessGroupFlowDTO. Return type:str

swagger_types = {'breadcrumb': 'FlowBreadcrumbEntity', 'flow': 'FlowDTO', 'id': 'str', 'last_refreshed': 'str', 'parameter_context': 'ParameterContextReferenceEntity', 'parent_group_id': 'str', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ProcessGroupFlowDTO. The URI for futures requests to the component.

Returns:The uri of this ProcessGroupFlowDTO. Return type:str

nipyapi.nifi.models.process_group_flow_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_flow_entity.ProcessGroupFlowEntity(permissions=None, process_group_flow=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessGroupFlowEntity - a model defined in Swagger

attribute_map = {'permissions': 'permissions', 'process_group_flow': 'processGroupFlow'}

permissions

Gets the permissions of this ProcessGroupFlowEntity. The access policy for this process group.

Returns:The permissions of this ProcessGroupFlowEntity. Return type:PermissionsDTO

process_group_flow

Gets the process_group_flow of this ProcessGroupFlowEntity.

Returns:The process_group_flow of this ProcessGroupFlowEntity. Return type:ProcessGroupFlowDTO

swagger_types = {'permissions': 'PermissionsDTO', 'process_group_flow': 'ProcessGroupFlowDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.process_group_status_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_status_dto.ProcessGroupStatusDTO(id=None, name=None, stats_last_refreshed=None, aggregate_snapshot=None, node_snapshots=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessGroupStatusDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this ProcessGroupStatusDTO. The aggregate status of all nodes in the cluster

Returns:The aggregate_snapshot of this ProcessGroupStatusDTO. Return type:ProcessGroupStatusSnapshotDTO

attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'id': 'id', 'name': 'name', 'node_snapshots': 'nodeSnapshots', 'stats_last_refreshed': 'statsLastRefreshed'}

id

Gets the id of this ProcessGroupStatusDTO. The ID of the Process Group

Returns:The id of this ProcessGroupStatusDTO. Return type:str

name

Gets the name of this ProcessGroupStatusDTO. The name of the Process Group

Returns:The name of this ProcessGroupStatusDTO. Return type:str

node_snapshots

Gets the node_snapshots of this ProcessGroupStatusDTO. The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.

Returns:The node_snapshots of this ProcessGroupStatusDTO. Return type:list[NodeProcessGroupStatusSnapshotDTO]

stats_last_refreshed

Gets the stats_last_refreshed of this ProcessGroupStatusDTO. The time the status for the process group was last refreshed.

Returns:The stats_last_refreshed of this ProcessGroupStatusDTO. Return type:str

swagger_types = {'aggregate_snapshot': 'ProcessGroupStatusSnapshotDTO', 'id': 'str', 'name': 'str', 'node_snapshots': 'list[NodeProcessGroupStatusSnapshotDTO]', 'stats_last_refreshed': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.process_group_status_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_status_entity.ProcessGroupStatusEntity(process_group_status=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessGroupStatusEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'process_group_status': 'processGroupStatus'}

can_read

Gets the can_read of this ProcessGroupStatusEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this ProcessGroupStatusEntity. Return type:bool

process_group_status

Gets the process_group_status of this ProcessGroupStatusEntity.

Returns:The process_group_status of this ProcessGroupStatusEntity. Return type:ProcessGroupStatusDTO

swagger_types = {'can_read': 'bool', 'process_group_status': 'ProcessGroupStatusDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.process_group_status_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_status_snapshot_dto.ProcessGroupStatusSnapshotDTO(id=None, name=None, connection_status_snapshots=None, processor_status_snapshots=None, process_group_status_snapshots=None, remote_process_group_status_snapshots=None, input_port_status_snapshots=None, output_port_status_snapshots=None, versioned_flow_state=None, flow_files_in=None, bytes_in=None, input=None, flow_files_queued=None, bytes_queued=None, queued=None, queued_count=None, queued_size=None, bytes_read=None, read=None, bytes_written=None, written=None, flow_files_out=None, bytes_out=None, output=None, flow_files_transferred=None, bytes_transferred=None, transferred=None, bytes_received=None, flow_files_received=None, received=None, bytes_sent=None, flow_files_sent=None, sent=None, active_thread_count=None, terminated_thread_count=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessGroupStatusSnapshotDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this ProcessGroupStatusSnapshotDTO. The active thread count for this process group.

Returns:The active_thread_count of this ProcessGroupStatusSnapshotDTO. Return type:int

attribute_map = {'active_thread_count': 'activeThreadCount', 'bytes_in': 'bytesIn', 'bytes_out': 'bytesOut', 'bytes_queued': 'bytesQueued', 'bytes_read': 'bytesRead', 'bytes_received': 'bytesReceived', 'bytes_sent': 'bytesSent', 'bytes_transferred': 'bytesTransferred', 'bytes_written': 'bytesWritten', 'connection_status_snapshots': 'connectionStatusSnapshots', 'flow_files_in': 'flowFilesIn', 'flow_files_out': 'flowFilesOut', 'flow_files_queued': 'flowFilesQueued', 'flow_files_received': 'flowFilesReceived', 'flow_files_sent': 'flowFilesSent', 'flow_files_transferred': 'flowFilesTransferred', 'id': 'id', 'input': 'input', 'input_port_status_snapshots': 'inputPortStatusSnapshots', 'name': 'name', 'output': 'output', 'output_port_status_snapshots': 'outputPortStatusSnapshots', 'process_group_status_snapshots': 'processGroupStatusSnapshots', 'processor_status_snapshots': 'processorStatusSnapshots', 'queued': 'queued', 'queued_count': 'queuedCount', 'queued_size': 'queuedSize', 'read': 'read', 'received': 'received', 'remote_process_group_status_snapshots': 'remoteProcessGroupStatusSnapshots', 'sent': 'sent', 'terminated_thread_count': 'terminatedThreadCount', 'transferred': 'transferred', 'versioned_flow_state': 'versionedFlowState', 'written': 'written'}

bytes_in

Gets the bytes_in of this ProcessGroupStatusSnapshotDTO. The number of bytes that have come into this ProcessGroup in the last 5 minutes

Returns:The bytes_in of this ProcessGroupStatusSnapshotDTO. Return type:int

bytes_out

Gets the bytes_out of this ProcessGroupStatusSnapshotDTO. The number of bytes transferred out of this ProcessGroup in the last 5 minutes

Returns:The bytes_out of this ProcessGroupStatusSnapshotDTO. Return type:int

bytes_queued

Gets the bytes_queued of this ProcessGroupStatusSnapshotDTO. The number of bytes that are queued up in this ProcessGroup right now

Returns:The bytes_queued of this ProcessGroupStatusSnapshotDTO. Return type:int

bytes_read

Gets the bytes_read of this ProcessGroupStatusSnapshotDTO. The number of bytes read by components in this ProcessGroup in the last 5 minutes

Returns:The bytes_read of this ProcessGroupStatusSnapshotDTO. Return type:int

bytes_received

Gets the bytes_received of this ProcessGroupStatusSnapshotDTO. The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes

Returns:The bytes_received of this ProcessGroupStatusSnapshotDTO. Return type:int

bytes_sent

Gets the bytes_sent of this ProcessGroupStatusSnapshotDTO. The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes

Returns:The bytes_sent of this ProcessGroupStatusSnapshotDTO. Return type:int

bytes_transferred

Gets the bytes_transferred of this ProcessGroupStatusSnapshotDTO. The number of bytes transferred in this ProcessGroup in the last 5 minutes

Returns:The bytes_transferred of this ProcessGroupStatusSnapshotDTO. Return type:int

bytes_written

Gets the bytes_written of this ProcessGroupStatusSnapshotDTO. The number of bytes written by components in this ProcessGroup in the last 5 minutes

Returns:The bytes_written of this ProcessGroupStatusSnapshotDTO. Return type:int

connection_status_snapshots

Gets the connection_status_snapshots of this ProcessGroupStatusSnapshotDTO. The status of all connections in the process group.

Returns:The connection_status_snapshots of this ProcessGroupStatusSnapshotDTO. Return type:list[ConnectionStatusSnapshotEntity]

flow_files_in

Gets the flow_files_in of this ProcessGroupStatusSnapshotDTO. The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes

Returns:The flow_files_in of this ProcessGroupStatusSnapshotDTO. Return type:int

flow_files_out

Gets the flow_files_out of this ProcessGroupStatusSnapshotDTO. The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes

Returns:The flow_files_out of this ProcessGroupStatusSnapshotDTO. Return type:int

flow_files_queued

Gets the flow_files_queued of this ProcessGroupStatusSnapshotDTO. The number of FlowFiles that are queued up in this ProcessGroup right now

Returns:The flow_files_queued of this ProcessGroupStatusSnapshotDTO. Return type:int

flow_files_received

Gets the flow_files_received of this ProcessGroupStatusSnapshotDTO. The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes

Returns:The flow_files_received of this ProcessGroupStatusSnapshotDTO. Return type:int

flow_files_sent

Gets the flow_files_sent of this ProcessGroupStatusSnapshotDTO. The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes

Returns:The flow_files_sent of this ProcessGroupStatusSnapshotDTO. Return type:int

flow_files_transferred

Gets the flow_files_transferred of this ProcessGroupStatusSnapshotDTO. The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes

Returns:The flow_files_transferred of this ProcessGroupStatusSnapshotDTO. Return type:int

id

Gets the id of this ProcessGroupStatusSnapshotDTO. The id of the process group.

Returns:The id of this ProcessGroupStatusSnapshotDTO. Return type:str

input

Gets the input of this ProcessGroupStatusSnapshotDTO. The input count/size for the process group in the last 5 minutes (pretty printed).

Returns:The input of this ProcessGroupStatusSnapshotDTO. Return type:str

input_port_status_snapshots

Gets the input_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. The status of all input ports in the process group.

Returns:The input_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. Return type:list[PortStatusSnapshotEntity]

name

Gets the name of this ProcessGroupStatusSnapshotDTO. The name of this process group.

Returns:The name of this ProcessGroupStatusSnapshotDTO. Return type:str

output

Gets the output of this ProcessGroupStatusSnapshotDTO. The output count/size for the process group in the last 5 minutes.

Returns:The output of this ProcessGroupStatusSnapshotDTO. Return type:str

output_port_status_snapshots

Gets the output_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. The status of all output ports in the process group.

Returns:The output_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. Return type:list[PortStatusSnapshotEntity]

process_group_status_snapshots

Gets the process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. The status of all process groups in the process group.

Returns:The process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. Return type:list[ProcessGroupStatusSnapshotEntity]

processor_status_snapshots

Gets the processor_status_snapshots of this ProcessGroupStatusSnapshotDTO. The status of all processors in the process group.

Returns:The processor_status_snapshots of this ProcessGroupStatusSnapshotDTO. Return type:list[ProcessorStatusSnapshotEntity]

queued

Gets the queued of this ProcessGroupStatusSnapshotDTO. The count/size that is queued in the the process group.

Returns:The queued of this ProcessGroupStatusSnapshotDTO. Return type:str

queued_count

Gets the queued_count of this ProcessGroupStatusSnapshotDTO. The count that is queued for the process group.

Returns:The queued_count of this ProcessGroupStatusSnapshotDTO. Return type:str

queued_size

Gets the queued_size of this ProcessGroupStatusSnapshotDTO. The size that is queued for the process group.

Returns:The queued_size of this ProcessGroupStatusSnapshotDTO. Return type:str

read

Gets the read of this ProcessGroupStatusSnapshotDTO. The number of bytes read in the last 5 minutes.

Returns:The read of this ProcessGroupStatusSnapshotDTO. Return type:str

received

Gets the received of this ProcessGroupStatusSnapshotDTO. The count/size sent to the process group in the last 5 minutes.

Returns:The received of this ProcessGroupStatusSnapshotDTO. Return type:str

remote_process_group_status_snapshots

Gets the remote_process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. The status of all remote process groups in the process group.

Returns:The remote_process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. Return type:list[RemoteProcessGroupStatusSnapshotEntity]

sent

Gets the sent of this ProcessGroupStatusSnapshotDTO. The count/size sent from this process group in the last 5 minutes.

Returns:The sent of this ProcessGroupStatusSnapshotDTO. Return type:str

swagger_types = {'active_thread_count': 'int', 'bytes_in': 'int', 'bytes_out': 'int', 'bytes_queued': 'int', 'bytes_read': 'int', 'bytes_received': 'int', 'bytes_sent': 'int', 'bytes_transferred': 'int', 'bytes_written': 'int', 'connection_status_snapshots': 'list[ConnectionStatusSnapshotEntity]', 'flow_files_in': 'int', 'flow_files_out': 'int', 'flow_files_queued': 'int', 'flow_files_received': 'int', 'flow_files_sent': 'int', 'flow_files_transferred': 'int', 'id': 'str', 'input': 'str', 'input_port_status_snapshots': 'list[PortStatusSnapshotEntity]', 'name': 'str', 'output': 'str', 'output_port_status_snapshots': 'list[PortStatusSnapshotEntity]', 'process_group_status_snapshots': 'list[ProcessGroupStatusSnapshotEntity]', 'processor_status_snapshots': 'list[ProcessorStatusSnapshotEntity]', 'queued': 'str', 'queued_count': 'str', 'queued_size': 'str', 'read': 'str', 'received': 'str', 'remote_process_group_status_snapshots': 'list[RemoteProcessGroupStatusSnapshotEntity]', 'sent': 'str', 'terminated_thread_count': 'int', 'transferred': 'str', 'versioned_flow_state': 'str', 'written': 'str'}

terminated_thread_count

Gets the terminated_thread_count of this ProcessGroupStatusSnapshotDTO. The number of threads currently terminated for the process group.

Returns:The terminated_thread_count of this ProcessGroupStatusSnapshotDTO. Return type:int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transferred

Gets the transferred of this ProcessGroupStatusSnapshotDTO. The count/size transferred to/from queues in the process group in the last 5 minutes.

Returns:The transferred of this ProcessGroupStatusSnapshotDTO. Return type:str

versioned_flow_state

Gets the versioned_flow_state of this ProcessGroupStatusSnapshotDTO. The current state of the Process Group, as it relates to the Versioned Flow

Returns:The versioned_flow_state of this ProcessGroupStatusSnapshotDTO. Return type:str

written

Gets the written of this ProcessGroupStatusSnapshotDTO. The number of bytes written in the last 5 minutes.

Returns:The written of this ProcessGroupStatusSnapshotDTO. Return type:str

nipyapi.nifi.models.process_group_status_snapshot_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_status_snapshot_entity.ProcessGroupStatusSnapshotEntity(id=None, process_group_status_snapshot=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessGroupStatusSnapshotEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'id': 'id', 'process_group_status_snapshot': 'processGroupStatusSnapshot'}

can_read

Gets the can_read of this ProcessGroupStatusSnapshotEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this ProcessGroupStatusSnapshotEntity. Return type:bool

id

Gets the id of this ProcessGroupStatusSnapshotEntity. The id of the process group.

Returns:The id of this ProcessGroupStatusSnapshotEntity. Return type:str

process_group_status_snapshot

Gets the process_group_status_snapshot of this ProcessGroupStatusSnapshotEntity.

Returns:The process_group_status_snapshot of this ProcessGroupStatusSnapshotEntity. Return type:ProcessGroupStatusSnapshotDTO

swagger_types = {'can_read': 'bool', 'id': 'str', 'process_group_status_snapshot': 'ProcessGroupStatusSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.process_groups_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_groups_entity.ProcessGroupsEntity(process_groups=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessGroupsEntity - a model defined in Swagger

attribute_map = {'process_groups': 'processGroups'}

process_groups

Gets the process_groups of this ProcessGroupsEntity.

Returns:The process_groups of this ProcessGroupsEntity. Return type:list[ProcessGroupEntity]

swagger_types = {'process_groups': 'list[ProcessGroupEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.processor_config_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_config_dto.ProcessorConfigDTO(properties=None, descriptors=None, sensitive_dynamic_property_names=None, scheduling_period=None, scheduling_strategy=None, execution_node=None, penalty_duration=None, yield_duration=None, bulletin_level=None, run_duration_millis=None, concurrently_schedulable_task_count=None, auto_terminated_relationships=None, comments=None, custom_ui_url=None, loss_tolerant=None, annotation_data=None, default_concurrent_tasks=None, default_scheduling_period=None, retry_count=None, retried_relationships=None, backoff_mechanism=None, max_backoff_period=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessorConfigDTO - a model defined in Swagger

annotation_data

Gets the annotation_data of this ProcessorConfigDTO. The annotation data for the processor used to relay configuration between a custom UI and the procesosr.

Returns:The annotation_data of this ProcessorConfigDTO. Return type:str

attribute_map = {'annotation_data': 'annotationData', 'auto_terminated_relationships': 'autoTerminatedRelationships', 'backoff_mechanism': 'backoffMechanism', 'bulletin_level': 'bulletinLevel', 'comments': 'comments', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'custom_ui_url': 'customUiUrl', 'default_concurrent_tasks': 'defaultConcurrentTasks', 'default_scheduling_period': 'defaultSchedulingPeriod', 'descriptors': 'descriptors', 'execution_node': 'executionNode', 'loss_tolerant': 'lossTolerant', 'max_backoff_period': 'maxBackoffPeriod', 'penalty_duration': 'penaltyDuration', 'properties': 'properties', 'retried_relationships': 'retriedRelationships', 'retry_count': 'retryCount', 'run_duration_millis': 'runDurationMillis', 'scheduling_period': 'schedulingPeriod', 'scheduling_strategy': 'schedulingStrategy', 'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', 'yield_duration': 'yieldDuration'}

auto_terminated_relationships

Gets the auto_terminated_relationships of this ProcessorConfigDTO. The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the ‘isAutoTerminate’ property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.

Returns:The auto_terminated_relationships of this ProcessorConfigDTO. Return type:list[str]

backoff_mechanism

Gets the backoff_mechanism of this ProcessorConfigDTO. Determines whether the FlowFile should be penalized or the processor should be yielded between retries.

Returns:The backoff_mechanism of this ProcessorConfigDTO. Return type:str

bulletin_level

Gets the bulletin_level of this ProcessorConfigDTO. The level at which the processor will report bulletins.

Returns:The bulletin_level of this ProcessorConfigDTO. Return type:str

comments

Gets the comments of this ProcessorConfigDTO. The comments for the processor.

Returns:The comments of this ProcessorConfigDTO. Return type:str

concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this ProcessorConfigDTO. The number of tasks that should be concurrently schedule for the processor. If the processor doesn’t allow parallol processing then any positive input will be ignored.

Returns:The concurrently_schedulable_task_count of this ProcessorConfigDTO. Return type:int

custom_ui_url

Gets the custom_ui_url of this ProcessorConfigDTO. The URL for the processor’s custom configuration UI if applicable.

Returns:The custom_ui_url of this ProcessorConfigDTO. Return type:str

default_concurrent_tasks

Gets the default_concurrent_tasks of this ProcessorConfigDTO. Maps default values for concurrent tasks for each applicable scheduling strategy.

Returns:The default_concurrent_tasks of this ProcessorConfigDTO. Return type:dict(str, str)

default_scheduling_period

Gets the default_scheduling_period of this ProcessorConfigDTO. Maps default values for scheduling period for each applicable scheduling strategy.

Returns:The default_scheduling_period of this ProcessorConfigDTO. Return type:dict(str, str)

descriptors

Gets the descriptors of this ProcessorConfigDTO. Descriptors for the processor’s properties.

Returns:The descriptors of this ProcessorConfigDTO. Return type:dict(str, PropertyDescriptorDTO)

execution_node

Gets the execution_node of this ProcessorConfigDTO. Indicates the node where the process will execute.

Returns:The execution_node of this ProcessorConfigDTO. Return type:str

loss_tolerant

Gets the loss_tolerant of this ProcessorConfigDTO. Whether the processor is loss tolerant.

Returns:The loss_tolerant of this ProcessorConfigDTO. Return type:bool

max_backoff_period

Gets the max_backoff_period of this ProcessorConfigDTO. Maximum amount of time to be waited during a retry period.

Returns:The max_backoff_period of this ProcessorConfigDTO. Return type:str

penalty_duration

Gets the penalty_duration of this ProcessorConfigDTO. The amount of time that is used when the process penalizes a flowfile.

Returns:The penalty_duration of this ProcessorConfigDTO. Return type:str

properties

Gets the properties of this ProcessorConfigDTO. The properties for the processor. Properties whose value is not set will only contain the property name.

Returns:The properties of this ProcessorConfigDTO. Return type:dict(str, str)

retried_relationships

Gets the retried_relationships of this ProcessorConfigDTO. All the relationships should be retried.

Returns:The retried_relationships of this ProcessorConfigDTO. Return type:list[str]

retry_count

Gets the retry_count of this ProcessorConfigDTO. Overall number of retries.

Returns:The retry_count of this ProcessorConfigDTO. Return type:int

run_duration_millis

Gets the run_duration_millis of this ProcessorConfigDTO. The run duration for the processor in milliseconds.

Returns:The run_duration_millis of this ProcessorConfigDTO. Return type:int

scheduling_period

Gets the scheduling_period of this ProcessorConfigDTO. The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy.

Returns:The scheduling_period of this ProcessorConfigDTO. Return type:str

scheduling_strategy

Gets the scheduling_strategy of this ProcessorConfigDTO. Indcates whether the prcessor should be scheduled to run in event or timer driven mode.

Returns:The scheduling_strategy of this ProcessorConfigDTO. Return type:str

sensitive_dynamic_property_names

Gets the sensitive_dynamic_property_names of this ProcessorConfigDTO. Set of sensitive dynamic property names

Returns:The sensitive_dynamic_property_names of this ProcessorConfigDTO. Return type:list[str]

swagger_types = {'annotation_data': 'str', 'auto_terminated_relationships': 'list[str]', 'backoff_mechanism': 'str', 'bulletin_level': 'str', 'comments': 'str', 'concurrently_schedulable_task_count': 'int', 'custom_ui_url': 'str', 'default_concurrent_tasks': 'dict(str, str)', 'default_scheduling_period': 'dict(str, str)', 'descriptors': 'dict(str, PropertyDescriptorDTO)', 'execution_node': 'str', 'loss_tolerant': 'bool', 'max_backoff_period': 'str', 'penalty_duration': 'str', 'properties': 'dict(str, str)', 'retried_relationships': 'list[str]', 'retry_count': 'int', 'run_duration_millis': 'int', 'scheduling_period': 'str', 'scheduling_strategy': 'str', 'sensitive_dynamic_property_names': 'list[str]', 'yield_duration': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

yield_duration

Gets the yield_duration of this ProcessorConfigDTO. The amount of time that must elapse before this processor is scheduled again after yielding.

Returns:The yield_duration of this ProcessorConfigDTO. Return type:str

nipyapi.nifi.models.processor_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_dto.ProcessorDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, type=None, bundle=None, state=None, style=None, relationships=None, description=None, supports_parallel_processing=None, supports_event_driven=None, supports_batching=None, supports_sensitive_dynamic_properties=None, persists_state=None, restricted=None, deprecated=None, execution_node_restricted=None, multiple_versions_available=None, input_requirement=None, config=None, validation_errors=None, validation_status=None, extension_missing=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessorDTO - a model defined in Swagger

attribute_map = {'bundle': 'bundle', 'config': 'config', 'deprecated': 'deprecated', 'description': 'description', 'execution_node_restricted': 'executionNodeRestricted', 'extension_missing': 'extensionMissing', 'id': 'id', 'input_requirement': 'inputRequirement', 'multiple_versions_available': 'multipleVersionsAvailable', 'name': 'name', 'parent_group_id': 'parentGroupId', 'persists_state': 'persistsState', 'position': 'position', 'relationships': 'relationships', 'restricted': 'restricted', 'state': 'state', 'style': 'style', 'supports_batching': 'supportsBatching', 'supports_event_driven': 'supportsEventDriven', 'supports_parallel_processing': 'supportsParallelProcessing', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'type': 'type', 'validation_errors': 'validationErrors', 'validation_status': 'validationStatus', 'versioned_component_id': 'versionedComponentId'}

bundle

Gets the bundle of this ProcessorDTO. The details of the artifact that bundled this processor type.

Returns:The bundle of this ProcessorDTO. Return type:BundleDTO

config

Gets the config of this ProcessorDTO. The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.

Returns:The config of this ProcessorDTO. Return type:ProcessorConfigDTO

deprecated

Gets the deprecated of this ProcessorDTO. Whether the processor has been deprecated.

Returns:The deprecated of this ProcessorDTO. Return type:bool

description

Gets the description of this ProcessorDTO. The description of the processor.

Returns:The description of this ProcessorDTO. Return type:str

execution_node_restricted

Gets the execution_node_restricted of this ProcessorDTO. Indicates if the execution node of a processor is restricted to run only on the primary node

Returns:The execution_node_restricted of this ProcessorDTO. Return type:bool

extension_missing

Gets the extension_missing of this ProcessorDTO. Whether the underlying extension is missing.

Returns:The extension_missing of this ProcessorDTO. Return type:bool

id

Gets the id of this ProcessorDTO. The id of the component.

Returns:The id of this ProcessorDTO. Return type:str

input_requirement

Gets the input_requirement of this ProcessorDTO. The input requirement for this processor.

Returns:The input_requirement of this ProcessorDTO. Return type:str

multiple_versions_available

Gets the multiple_versions_available of this ProcessorDTO. Whether the processor has multiple versions available.

Returns:The multiple_versions_available of this ProcessorDTO. Return type:bool

name

Gets the name of this ProcessorDTO. The name of the processor.

Returns:The name of this ProcessorDTO. Return type:str

parent_group_id

Gets the parent_group_id of this ProcessorDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this ProcessorDTO. Return type:str

persists_state

Gets the persists_state of this ProcessorDTO. Whether the processor persists state.

Returns:The persists_state of this ProcessorDTO. Return type:bool

position

Gets the position of this ProcessorDTO. The position of this component in the UI if applicable.

Returns:The position of this ProcessorDTO. Return type:PositionDTO

relationships

Gets the relationships of this ProcessorDTO. The available relationships that the processor currently supports.

Returns:The relationships of this ProcessorDTO. Return type:list[RelationshipDTO]

restricted

Gets the restricted of this ProcessorDTO. Whether the processor requires elevated privileges.

Returns:The restricted of this ProcessorDTO. Return type:bool

state

Gets the state of this ProcessorDTO. The state of the processor

Returns:The state of this ProcessorDTO. Return type:str

style

Gets the style of this ProcessorDTO. Styles for the processor (background-color : #eee).

Returns:The style of this ProcessorDTO. Return type:dict(str, str)

supports_batching

Gets the supports_batching of this ProcessorDTO. Whether the processor supports batching. This makes the run duration settings available.

Returns:The supports_batching of this ProcessorDTO. Return type:bool

supports_event_driven

Gets the supports_event_driven of this ProcessorDTO. Whether the processor supports event driven scheduling.

Returns:The supports_event_driven of this ProcessorDTO. Return type:bool

supports_parallel_processing

Gets the supports_parallel_processing of this ProcessorDTO. Whether the processor supports parallel processing.

Returns:The supports_parallel_processing of this ProcessorDTO. Return type:bool

supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this ProcessorDTO. Whether the processor supports sensitive dynamic properties.

Returns:The supports_sensitive_dynamic_properties of this ProcessorDTO. Return type:bool

swagger_types = {'bundle': 'BundleDTO', 'config': 'ProcessorConfigDTO', 'deprecated': 'bool', 'description': 'str', 'execution_node_restricted': 'bool', 'extension_missing': 'bool', 'id': 'str', 'input_requirement': 'str', 'multiple_versions_available': 'bool', 'name': 'str', 'parent_group_id': 'str', 'persists_state': 'bool', 'position': 'PositionDTO', 'relationships': 'list[RelationshipDTO]', 'restricted': 'bool', 'state': 'str', 'style': 'dict(str, str)', 'supports_batching': 'bool', 'supports_event_driven': 'bool', 'supports_parallel_processing': 'bool', 'supports_sensitive_dynamic_properties': 'bool', 'type': 'str', 'validation_errors': 'list[str]', 'validation_status': 'str', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ProcessorDTO. The type of the processor.

Returns:The type of this ProcessorDTO. Return type:str

validation_errors

Gets the validation_errors of this ProcessorDTO. The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.

Returns:The validation_errors of this ProcessorDTO. Return type:list[str]

validation_status

Gets the validation_status of this ProcessorDTO. Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)

Returns:The validation_status of this ProcessorDTO. Return type:str

versioned_component_id

Gets the versioned_component_id of this ProcessorDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this ProcessorDTO. Return type:str

nipyapi.nifi.models.processor_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_entity.ProcessorEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, input_requirement=None, status=None, operate_permissions=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessorEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'input_requirement': 'inputRequirement', 'operate_permissions': 'operatePermissions', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'status': 'status', 'uri': 'uri'}

bulletins

Gets the bulletins of this ProcessorEntity. The bulletins for this component.

Returns:The bulletins of this ProcessorEntity. Return type:list[BulletinEntity]

component

Gets the component of this ProcessorEntity.

Returns:The component of this ProcessorEntity. Return type:ProcessorDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ProcessorEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ProcessorEntity. Return type:bool

id

Gets the id of this ProcessorEntity. The id of the component.

Returns:The id of this ProcessorEntity. Return type:str

input_requirement

Gets the input_requirement of this ProcessorEntity. The input requirement for this processor.

Returns:The input_requirement of this ProcessorEntity. Return type:str

operate_permissions

Gets the operate_permissions of this ProcessorEntity. The permissions for this component operations.

Returns:The operate_permissions of this ProcessorEntity. Return type:PermissionsDTO

permissions

Gets the permissions of this ProcessorEntity. The permissions for this component.

Returns:The permissions of this ProcessorEntity. Return type:PermissionsDTO

position

Gets the position of this ProcessorEntity. The position of this component in the UI if applicable.

Returns:The position of this ProcessorEntity. Return type:PositionDTO

revision

Gets the revision of this ProcessorEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this ProcessorEntity. Return type:RevisionDTO

status

Gets the status of this ProcessorEntity.

Returns:The status of this ProcessorEntity. Return type:ProcessorStatusDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'ProcessorDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'input_requirement': 'str', 'operate_permissions': 'PermissionsDTO', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'status': 'ProcessorStatusDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ProcessorEntity. The URI for futures requests to the component.

Returns:The uri of this ProcessorEntity. Return type:str

nipyapi.nifi.models.processor_status_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_status_dto.ProcessorStatusDTO(group_id=None, id=None, name=None, type=None, run_status=None, stats_last_refreshed=None, aggregate_snapshot=None, node_snapshots=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessorStatusDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this ProcessorStatusDTO. A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.

Returns:The aggregate_snapshot of this ProcessorStatusDTO. Return type:ProcessorStatusSnapshotDTO

attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'node_snapshots': 'nodeSnapshots', 'run_status': 'runStatus', 'stats_last_refreshed': 'statsLastRefreshed', 'type': 'type'}

group_id

Gets the group_id of this ProcessorStatusDTO. The unique ID of the process group that the Processor belongs to

Returns:The group_id of this ProcessorStatusDTO. Return type:str

id

Gets the id of this ProcessorStatusDTO. The unique ID of the Processor

Returns:The id of this ProcessorStatusDTO. Return type:str

name

Gets the name of this ProcessorStatusDTO. The name of the Processor

Returns:The name of this ProcessorStatusDTO. Return type:str

node_snapshots

Gets the node_snapshots of this ProcessorStatusDTO. A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.

Returns:The node_snapshots of this ProcessorStatusDTO. Return type:list[NodeProcessorStatusSnapshotDTO]

run_status

Gets the run_status of this ProcessorStatusDTO. The run status of the Processor

Returns:The run_status of this ProcessorStatusDTO. Return type:str

stats_last_refreshed

Gets the stats_last_refreshed of this ProcessorStatusDTO. The timestamp of when the stats were last refreshed

Returns:The stats_last_refreshed of this ProcessorStatusDTO. Return type:str

swagger_types = {'aggregate_snapshot': 'ProcessorStatusSnapshotDTO', 'group_id': 'str', 'id': 'str', 'name': 'str', 'node_snapshots': 'list[NodeProcessorStatusSnapshotDTO]', 'run_status': 'str', 'stats_last_refreshed': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ProcessorStatusDTO. The type of the Processor

Returns:The type of this ProcessorStatusDTO. Return type:str

nipyapi.nifi.models.processor_status_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_status_entity.ProcessorStatusEntity(processor_status=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessorStatusEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'processor_status': 'processorStatus'}

can_read

Gets the can_read of this ProcessorStatusEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this ProcessorStatusEntity. Return type:bool

processor_status

Gets the processor_status of this ProcessorStatusEntity.

Returns:The processor_status of this ProcessorStatusEntity. Return type:ProcessorStatusDTO

swagger_types = {'can_read': 'bool', 'processor_status': 'ProcessorStatusDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.processor_status_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_status_snapshot_dto.ProcessorStatusSnapshotDTO(id=None, group_id=None, name=None, type=None, run_status=None, execution_node=None, bytes_read=None, bytes_written=None, read=None, written=None, flow_files_in=None, bytes_in=None, input=None, flow_files_out=None, bytes_out=None, output=None, task_count=None, tasks_duration_nanos=None, tasks=None, tasks_duration=None, active_thread_count=None, terminated_thread_count=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessorStatusSnapshotDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this ProcessorStatusSnapshotDTO. The number of threads currently executing in the processor.

Returns:The active_thread_count of this ProcessorStatusSnapshotDTO. Return type:int

attribute_map = {'active_thread_count': 'activeThreadCount', 'bytes_in': 'bytesIn', 'bytes_out': 'bytesOut', 'bytes_read': 'bytesRead', 'bytes_written': 'bytesWritten', 'execution_node': 'executionNode', 'flow_files_in': 'flowFilesIn', 'flow_files_out': 'flowFilesOut', 'group_id': 'groupId', 'id': 'id', 'input': 'input', 'name': 'name', 'output': 'output', 'read': 'read', 'run_status': 'runStatus', 'task_count': 'taskCount', 'tasks': 'tasks', 'tasks_duration': 'tasksDuration', 'tasks_duration_nanos': 'tasksDurationNanos', 'terminated_thread_count': 'terminatedThreadCount', 'type': 'type', 'written': 'written'}

bytes_in

Gets the bytes_in of this ProcessorStatusSnapshotDTO. The size of the FlowFiles that have been accepted in the last 5 minutes

Returns:The bytes_in of this ProcessorStatusSnapshotDTO. Return type:int

bytes_out

Gets the bytes_out of this ProcessorStatusSnapshotDTO. The size of the FlowFiles transferred to a Connection in the last 5 minutes

Returns:The bytes_out of this ProcessorStatusSnapshotDTO. Return type:int

bytes_read

Gets the bytes_read of this ProcessorStatusSnapshotDTO. The number of bytes read by this Processor in the last 5 mintues

Returns:The bytes_read of this ProcessorStatusSnapshotDTO. Return type:int

bytes_written

Gets the bytes_written of this ProcessorStatusSnapshotDTO. The number of bytes written by this Processor in the last 5 minutes

Returns:The bytes_written of this ProcessorStatusSnapshotDTO. Return type:int

execution_node

Gets the execution_node of this ProcessorStatusSnapshotDTO. Indicates the node where the process will execute.

Returns:The execution_node of this ProcessorStatusSnapshotDTO. Return type:str

flow_files_in

Gets the flow_files_in of this ProcessorStatusSnapshotDTO. The number of FlowFiles that have been accepted in the last 5 minutes

Returns:The flow_files_in of this ProcessorStatusSnapshotDTO. Return type:int

flow_files_out

Gets the flow_files_out of this ProcessorStatusSnapshotDTO. The number of FlowFiles transferred to a Connection in the last 5 minutes

Returns:The flow_files_out of this ProcessorStatusSnapshotDTO. Return type:int

group_id

Gets the group_id of this ProcessorStatusSnapshotDTO. The id of the parent process group to which the processor belongs.

Returns:The group_id of this ProcessorStatusSnapshotDTO. Return type:str

id

Gets the id of this ProcessorStatusSnapshotDTO. The id of the processor.

Returns:The id of this ProcessorStatusSnapshotDTO. Return type:str

input

Gets the input of this ProcessorStatusSnapshotDTO. The count/size of flowfiles that have been accepted in the last 5 minutes.

Returns:The input of this ProcessorStatusSnapshotDTO. Return type:str

name

Gets the name of this ProcessorStatusSnapshotDTO. The name of the prcessor.

Returns:The name of this ProcessorStatusSnapshotDTO. Return type:str

output

Gets the output of this ProcessorStatusSnapshotDTO. The count/size of flowfiles that have been processed in the last 5 minutes.

Returns:The output of this ProcessorStatusSnapshotDTO. Return type:str

read

Gets the read of this ProcessorStatusSnapshotDTO. The number of bytes read in the last 5 minutes.

Returns:The read of this ProcessorStatusSnapshotDTO. Return type:str

run_status

Gets the run_status of this ProcessorStatusSnapshotDTO. The state of the processor.

Returns:The run_status of this ProcessorStatusSnapshotDTO. Return type:str

swagger_types = {'active_thread_count': 'int', 'bytes_in': 'int', 'bytes_out': 'int', 'bytes_read': 'int', 'bytes_written': 'int', 'execution_node': 'str', 'flow_files_in': 'int', 'flow_files_out': 'int', 'group_id': 'str', 'id': 'str', 'input': 'str', 'name': 'str', 'output': 'str', 'read': 'str', 'run_status': 'str', 'task_count': 'int', 'tasks': 'str', 'tasks_duration': 'str', 'tasks_duration_nanos': 'int', 'terminated_thread_count': 'int', 'type': 'str', 'written': 'str'}

task_count

Gets the task_count of this ProcessorStatusSnapshotDTO. The number of times this Processor has run in the last 5 minutes

Returns:The task_count of this ProcessorStatusSnapshotDTO. Return type:int

tasks

Gets the tasks of this ProcessorStatusSnapshotDTO. The total number of task this connectable has completed over the last 5 minutes.

Returns:The tasks of this ProcessorStatusSnapshotDTO. Return type:str

tasks_duration

Gets the tasks_duration of this ProcessorStatusSnapshotDTO. The total duration of all tasks for this connectable over the last 5 minutes.

Returns:The tasks_duration of this ProcessorStatusSnapshotDTO. Return type:str

tasks_duration_nanos

Gets the tasks_duration_nanos of this ProcessorStatusSnapshotDTO. The number of nanoseconds that this Processor has spent running in the last 5 minutes

Returns:The tasks_duration_nanos of this ProcessorStatusSnapshotDTO. Return type:int

terminated_thread_count

Gets the terminated_thread_count of this ProcessorStatusSnapshotDTO. The number of threads currently terminated for the processor.

Returns:The terminated_thread_count of this ProcessorStatusSnapshotDTO. Return type:int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ProcessorStatusSnapshotDTO. The type of the processor.

Returns:The type of this ProcessorStatusSnapshotDTO. Return type:str

written

Gets the written of this ProcessorStatusSnapshotDTO. The number of bytes written in the last 5 minutes.

Returns:The written of this ProcessorStatusSnapshotDTO. Return type:str

nipyapi.nifi.models.processor_status_snapshot_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_status_snapshot_entity.ProcessorStatusSnapshotEntity(id=None, processor_status_snapshot=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessorStatusSnapshotEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'id': 'id', 'processor_status_snapshot': 'processorStatusSnapshot'}

can_read

Gets the can_read of this ProcessorStatusSnapshotEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this ProcessorStatusSnapshotEntity. Return type:bool

id

Gets the id of this ProcessorStatusSnapshotEntity. The id of the processor.

Returns:The id of this ProcessorStatusSnapshotEntity. Return type:str

processor_status_snapshot

Gets the processor_status_snapshot of this ProcessorStatusSnapshotEntity.

Returns:The processor_status_snapshot of this ProcessorStatusSnapshotEntity. Return type:ProcessorStatusSnapshotDTO

swagger_types = {'can_read': 'bool', 'id': 'str', 'processor_status_snapshot': 'ProcessorStatusSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.processor_types_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_types_entity.ProcessorTypesEntity(processor_types=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessorTypesEntity - a model defined in Swagger

attribute_map = {'processor_types': 'processorTypes'}

processor_types

Gets the processor_types of this ProcessorTypesEntity.

Returns:The processor_types of this ProcessorTypesEntity. Return type:list[DocumentedTypeDTO]

swagger_types = {'processor_types': 'list[DocumentedTypeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.processors_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processors_entity.ProcessorsEntity(processors=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProcessorsEntity - a model defined in Swagger

attribute_map = {'processors': 'processors'}

processors

Gets the processors of this ProcessorsEntity.

Returns:The processors of this ProcessorsEntity. Return type:list[ProcessorEntity]

swagger_types = {'processors': 'list[ProcessorEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.property_descriptor_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.property_descriptor_dto.PropertyDescriptorDTO(name=None, display_name=None, description=None, default_value=None, allowable_values=None, required=None, sensitive=None, dynamic=None, supports_el=None, expression_language_scope=None, identifies_controller_service=None, identifies_controller_service_bundle=None, dependencies=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PropertyDescriptorDTO - a model defined in Swagger

allowable_values

Gets the allowable_values of this PropertyDescriptorDTO. Allowable values for the property. If empty then the allowed values are not constrained.

Returns:The allowable_values of this PropertyDescriptorDTO. Return type:list[AllowableValueEntity]

attribute_map = {'allowable_values': 'allowableValues', 'default_value': 'defaultValue', 'dependencies': 'dependencies', 'description': 'description', 'display_name': 'displayName', 'dynamic': 'dynamic', 'expression_language_scope': 'expressionLanguageScope', 'identifies_controller_service': 'identifiesControllerService', 'identifies_controller_service_bundle': 'identifiesControllerServiceBundle', 'name': 'name', 'required': 'required', 'sensitive': 'sensitive', 'supports_el': 'supportsEl'}

default_value

Gets the default_value of this PropertyDescriptorDTO. The default value for the property.

Returns:The default_value of this PropertyDescriptorDTO. Return type:str

dependencies

Gets the dependencies of this PropertyDescriptorDTO. A list of dependencies that must be met in order for this Property to be relevant. If any of these dependencies is not met, the property described by this Property Descriptor is not relevant.

Returns:The dependencies of this PropertyDescriptorDTO. Return type:list[PropertyDependencyDTO]

description

Gets the description of this PropertyDescriptorDTO. The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent.

Returns:The description of this PropertyDescriptorDTO. Return type:str

display_name

Gets the display_name of this PropertyDescriptorDTO. The human readable name for the property.

Returns:The display_name of this PropertyDescriptorDTO. Return type:str

dynamic

Gets the dynamic of this PropertyDescriptorDTO. Whether the property is dynamic (user-defined).

Returns:The dynamic of this PropertyDescriptorDTO. Return type:bool

expression_language_scope

Gets the expression_language_scope of this PropertyDescriptorDTO. Scope of the Expression Language evaluation for the property.

Returns:The expression_language_scope of this PropertyDescriptorDTO. Return type:str

identifies_controller_service

Gets the identifies_controller_service of this PropertyDescriptorDTO. If the property identifies a controller service this returns the fully qualified type.

Returns:The identifies_controller_service of this PropertyDescriptorDTO. Return type:str

identifies_controller_service_bundle

Gets the identifies_controller_service_bundle of this PropertyDescriptorDTO. If the property identifies a controller service this returns the bundle of the type, null otherwise.

Returns:The identifies_controller_service_bundle of this PropertyDescriptorDTO. Return type:BundleDTO

name

Gets the name of this PropertyDescriptorDTO. The name for the property.

Returns:The name of this PropertyDescriptorDTO. Return type:str

required

Gets the required of this PropertyDescriptorDTO. Whether the property is required.

Returns:The required of this PropertyDescriptorDTO. Return type:bool

sensitive

Gets the sensitive of this PropertyDescriptorDTO. Whether the property is sensitive and protected whenever stored or represented.

Returns:The sensitive of this PropertyDescriptorDTO. Return type:bool

supports_el

Gets the supports_el of this PropertyDescriptorDTO. Whether the property supports expression language.

Returns:The supports_el of this PropertyDescriptorDTO. Return type:bool

swagger_types = {'allowable_values': 'list[AllowableValueEntity]', 'default_value': 'str', 'dependencies': 'list[PropertyDependencyDTO]', 'description': 'str', 'display_name': 'str', 'dynamic': 'bool', 'expression_language_scope': 'str', 'identifies_controller_service': 'str', 'identifies_controller_service_bundle': 'BundleDTO', 'name': 'str', 'required': 'bool', 'sensitive': 'bool', 'supports_el': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.property_descriptor_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.property_descriptor_entity.PropertyDescriptorEntity(property_descriptor=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PropertyDescriptorEntity - a model defined in Swagger

attribute_map = {'property_descriptor': 'propertyDescriptor'}

property_descriptor

Gets the property_descriptor of this PropertyDescriptorEntity.

Returns:The property_descriptor of this PropertyDescriptorEntity. Return type:PropertyDescriptorDTO

swagger_types = {'property_descriptor': 'PropertyDescriptorDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.property_history_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.property_history_dto.PropertyHistoryDTO(previous_values=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

PropertyHistoryDTO - a model defined in Swagger

attribute_map = {'previous_values': 'previousValues'}

previous_values

Gets the previous_values of this PropertyHistoryDTO. Previous values for a given property.

Returns:The previous_values of this PropertyHistoryDTO. Return type:list[PreviousValueDTO]

swagger_types = {'previous_values': 'list[PreviousValueDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.provenance_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_dto.ProvenanceDTO(id=None, uri=None, submission_time=None, expiration=None, percent_completed=None, finished=None, request=None, results=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProvenanceDTO - a model defined in Swagger

attribute_map = {'expiration': 'expiration', 'finished': 'finished', 'id': 'id', 'percent_completed': 'percentCompleted', 'request': 'request', 'results': 'results', 'submission_time': 'submissionTime', 'uri': 'uri'}

expiration

Gets the expiration of this ProvenanceDTO. The timestamp when the query will expire.

Returns:The expiration of this ProvenanceDTO. Return type:str

finished

Gets the finished of this ProvenanceDTO. Whether the query has finished.

Returns:The finished of this ProvenanceDTO. Return type:bool

id

Gets the id of this ProvenanceDTO. The id of the provenance query.

Returns:The id of this ProvenanceDTO. Return type:str

percent_completed

Gets the percent_completed of this ProvenanceDTO. The current percent complete.

Returns:The percent_completed of this ProvenanceDTO. Return type:int

request

Gets the request of this ProvenanceDTO. The provenance request.

Returns:The request of this ProvenanceDTO. Return type:ProvenanceRequestDTO

results

Gets the results of this ProvenanceDTO. The provenance results.

Returns:The results of this ProvenanceDTO. Return type:ProvenanceResultsDTO

submission_time

Gets the submission_time of this ProvenanceDTO. The timestamp when the query was submitted.

Returns:The submission_time of this ProvenanceDTO. Return type:str

swagger_types = {'expiration': 'str', 'finished': 'bool', 'id': 'str', 'percent_completed': 'int', 'request': 'ProvenanceRequestDTO', 'results': 'ProvenanceResultsDTO', 'submission_time': 'str', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ProvenanceDTO. The URI for this query. Used for obtaining/deleting the request at a later time

Returns:The uri of this ProvenanceDTO. Return type:str

nipyapi.nifi.models.provenance_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_entity.ProvenanceEntity(provenance=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProvenanceEntity - a model defined in Swagger

attribute_map = {'provenance': 'provenance'}

provenance

Gets the provenance of this ProvenanceEntity.

Returns:The provenance of this ProvenanceEntity. Return type:ProvenanceDTO

swagger_types = {'provenance': 'ProvenanceDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.provenance_event_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_event_dto.ProvenanceEventDTO(id=None, event_id=None, event_time=None, event_duration=None, lineage_duration=None, event_type=None, flow_file_uuid=None, file_size=None, file_size_bytes=None, cluster_node_id=None, cluster_node_address=None, group_id=None, component_id=None, component_type=None, component_name=None, source_system_flow_file_id=None, alternate_identifier_uri=None, attributes=None, parent_uuids=None, child_uuids=None, transit_uri=None, relationship=None, details=None, content_equal=None, input_content_available=None, input_content_claim_section=None, input_content_claim_container=None, input_content_claim_identifier=None, input_content_claim_offset=None, input_content_claim_file_size=None, input_content_claim_file_size_bytes=None, output_content_available=None, output_content_claim_section=None, output_content_claim_container=None, output_content_claim_identifier=None, output_content_claim_offset=None, output_content_claim_file_size=None, output_content_claim_file_size_bytes=None, replay_available=None, replay_explanation=None, source_connection_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProvenanceEventDTO - a model defined in Swagger

alternate_identifier_uri

Gets the alternate_identifier_uri of this ProvenanceEventDTO. The alternate identifier uri for the fileflow for the event.

Returns:The alternate_identifier_uri of this ProvenanceEventDTO. Return type:str

attribute_map = {'alternate_identifier_uri': 'alternateIdentifierUri', 'attributes': 'attributes', 'child_uuids': 'childUuids', 'cluster_node_address': 'clusterNodeAddress', 'cluster_node_id': 'clusterNodeId', 'component_id': 'componentId', 'component_name': 'componentName', 'component_type': 'componentType', 'content_equal': 'contentEqual', 'details': 'details', 'event_duration': 'eventDuration', 'event_id': 'eventId', 'event_time': 'eventTime', 'event_type': 'eventType', 'file_size': 'fileSize', 'file_size_bytes': 'fileSizeBytes', 'flow_file_uuid': 'flowFileUuid', 'group_id': 'groupId', 'id': 'id', 'input_content_available': 'inputContentAvailable', 'input_content_claim_container': 'inputContentClaimContainer', 'input_content_claim_file_size': 'inputContentClaimFileSize', 'input_content_claim_file_size_bytes': 'inputContentClaimFileSizeBytes', 'input_content_claim_identifier': 'inputContentClaimIdentifier', 'input_content_claim_offset': 'inputContentClaimOffset', 'input_content_claim_section': 'inputContentClaimSection', 'lineage_duration': 'lineageDuration', 'output_content_available': 'outputContentAvailable', 'output_content_claim_container': 'outputContentClaimContainer', 'output_content_claim_file_size': 'outputContentClaimFileSize', 'output_content_claim_file_size_bytes': 'outputContentClaimFileSizeBytes', 'output_content_claim_identifier': 'outputContentClaimIdentifier', 'output_content_claim_offset': 'outputContentClaimOffset', 'output_content_claim_section': 'outputContentClaimSection', 'parent_uuids': 'parentUuids', 'relationship': 'relationship', 'replay_available': 'replayAvailable', 'replay_explanation': 'replayExplanation', 'source_connection_identifier': 'sourceConnectionIdentifier', 'source_system_flow_file_id': 'sourceSystemFlowFileId', 'transit_uri': 'transitUri'}

attributes

Gets the attributes of this ProvenanceEventDTO. The attributes of the flowfile for the event.

Returns:The attributes of this ProvenanceEventDTO. Return type:list[AttributeDTO]

child_uuids

Gets the child_uuids of this ProvenanceEventDTO. The child uuids for the event.

Returns:The child_uuids of this ProvenanceEventDTO. Return type:list[str]

cluster_node_address

Gets the cluster_node_address of this ProvenanceEventDTO. The label for the node where the event originated.

Returns:The cluster_node_address of this ProvenanceEventDTO. Return type:str

cluster_node_id

Gets the cluster_node_id of this ProvenanceEventDTO. The identifier for the node where the event originated.

Returns:The cluster_node_id of this ProvenanceEventDTO. Return type:str

component_id

Gets the component_id of this ProvenanceEventDTO. The id of the component that generated the event.

Returns:The component_id of this ProvenanceEventDTO. Return type:str

component_name

Gets the component_name of this ProvenanceEventDTO. The name of the component that generated the event.

Returns:The component_name of this ProvenanceEventDTO. Return type:str

component_type

Gets the component_type of this ProvenanceEventDTO. The type of the component that generated the event.

Returns:The component_type of this ProvenanceEventDTO. Return type:str

content_equal

Gets the content_equal of this ProvenanceEventDTO. Whether the input and output content claim is the same.

Returns:The content_equal of this ProvenanceEventDTO. Return type:bool

details

Gets the details of this ProvenanceEventDTO. The event details.

Returns:The details of this ProvenanceEventDTO. Return type:str

event_duration

Gets the event_duration of this ProvenanceEventDTO. The event duration in milliseconds.

Returns:The event_duration of this ProvenanceEventDTO. Return type:int

event_id

Gets the event_id of this ProvenanceEventDTO. The event id. This is a one up number thats unique per node.

Returns:The event_id of this ProvenanceEventDTO. Return type:int

event_time

Gets the event_time of this ProvenanceEventDTO. The timestamp of the event.

Returns:The event_time of this ProvenanceEventDTO. Return type:str

event_type

Gets the event_type of this ProvenanceEventDTO. The type of the event.

Returns:The event_type of this ProvenanceEventDTO. Return type:str

file_size

Gets the file_size of this ProvenanceEventDTO. The size of the flowfile for the event.

Returns:The file_size of this ProvenanceEventDTO. Return type:str

file_size_bytes

Gets the file_size_bytes of this ProvenanceEventDTO. The size of the flowfile in bytes for the event.

Returns:The file_size_bytes of this ProvenanceEventDTO. Return type:int

flow_file_uuid

Gets the flow_file_uuid of this ProvenanceEventDTO. The uuid of the flowfile for the event.

Returns:The flow_file_uuid of this ProvenanceEventDTO. Return type:str

group_id

Gets the group_id of this ProvenanceEventDTO. The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set.

Returns:The group_id of this ProvenanceEventDTO. Return type:str

id

Gets the id of this ProvenanceEventDTO. The event uuid.

Returns:The id of this ProvenanceEventDTO. Return type:str

input_content_available

Gets the input_content_available of this ProvenanceEventDTO. Whether the input content is still available.

Returns:The input_content_available of this ProvenanceEventDTO. Return type:bool

input_content_claim_container

Gets the input_content_claim_container of this ProvenanceEventDTO. The container in which the input content claim lives.

Returns:The input_content_claim_container of this ProvenanceEventDTO. Return type:str

input_content_claim_file_size

Gets the input_content_claim_file_size of this ProvenanceEventDTO. The file size of the input content claim formatted.

Returns:The input_content_claim_file_size of this ProvenanceEventDTO. Return type:str

input_content_claim_file_size_bytes

Gets the input_content_claim_file_size_bytes of this ProvenanceEventDTO. The file size of the intput content claim in bytes.

Returns:The input_content_claim_file_size_bytes of this ProvenanceEventDTO. Return type:int

input_content_claim_identifier

Gets the input_content_claim_identifier of this ProvenanceEventDTO. The identifier of the input content claim.

Returns:The input_content_claim_identifier of this ProvenanceEventDTO. Return type:str

input_content_claim_offset

Gets the input_content_claim_offset of this ProvenanceEventDTO. The offset into the input content claim where the flowfiles content begins.

Returns:The input_content_claim_offset of this ProvenanceEventDTO. Return type:int

input_content_claim_section

Gets the input_content_claim_section of this ProvenanceEventDTO. The section in which the input content claim lives.

Returns:The input_content_claim_section of this ProvenanceEventDTO. Return type:str

lineage_duration

Gets the lineage_duration of this ProvenanceEventDTO. The duration since the lineage began, in milliseconds.

Returns:The lineage_duration of this ProvenanceEventDTO. Return type:int

output_content_available

Gets the output_content_available of this ProvenanceEventDTO. Whether the output content is still available.

Returns:The output_content_available of this ProvenanceEventDTO. Return type:bool

output_content_claim_container

Gets the output_content_claim_container of this ProvenanceEventDTO. The container in which the output content claim lives.

Returns:The output_content_claim_container of this ProvenanceEventDTO. Return type:str

output_content_claim_file_size

Gets the output_content_claim_file_size of this ProvenanceEventDTO. The file size of the output content claim formatted.

Returns:The output_content_claim_file_size of this ProvenanceEventDTO. Return type:str

output_content_claim_file_size_bytes

Gets the output_content_claim_file_size_bytes of this ProvenanceEventDTO. The file size of the output content claim in bytes.

Returns:The output_content_claim_file_size_bytes of this ProvenanceEventDTO. Return type:int

output_content_claim_identifier

Gets the output_content_claim_identifier of this ProvenanceEventDTO. The identifier of the output content claim.

Returns:The output_content_claim_identifier of this ProvenanceEventDTO. Return type:str

output_content_claim_offset

Gets the output_content_claim_offset of this ProvenanceEventDTO. The offset into the output content claim where the flowfiles content begins.

Returns:The output_content_claim_offset of this ProvenanceEventDTO. Return type:int

output_content_claim_section

Gets the output_content_claim_section of this ProvenanceEventDTO. The section in which the output content claim lives.

Returns:The output_content_claim_section of this ProvenanceEventDTO. Return type:str

parent_uuids

Gets the parent_uuids of this ProvenanceEventDTO. The parent uuids for the event.

Returns:The parent_uuids of this ProvenanceEventDTO. Return type:list[str]

relationship

Gets the relationship of this ProvenanceEventDTO. The relationship to which the flowfile was routed if the event is of type ROUTE.

Returns:The relationship of this ProvenanceEventDTO. Return type:str

replay_available

Gets the replay_available of this ProvenanceEventDTO. Whether or not replay is available.

Returns:The replay_available of this ProvenanceEventDTO. Return type:bool

replay_explanation

Gets the replay_explanation of this ProvenanceEventDTO. Explanation as to why replay is unavailable.

Returns:The replay_explanation of this ProvenanceEventDTO. Return type:str

source_connection_identifier

Gets the source_connection_identifier of this ProvenanceEventDTO. The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event.

Returns:The source_connection_identifier of this ProvenanceEventDTO. Return type:str

source_system_flow_file_id

Gets the source_system_flow_file_id of this ProvenanceEventDTO. The source system flowfile id.

Returns:The source_system_flow_file_id of this ProvenanceEventDTO. Return type:str

swagger_types = {'alternate_identifier_uri': 'str', 'attributes': 'list[AttributeDTO]', 'child_uuids': 'list[str]', 'cluster_node_address': 'str', 'cluster_node_id': 'str', 'component_id': 'str', 'component_name': 'str', 'component_type': 'str', 'content_equal': 'bool', 'details': 'str', 'event_duration': 'int', 'event_id': 'int', 'event_time': 'str', 'event_type': 'str', 'file_size': 'str', 'file_size_bytes': 'int', 'flow_file_uuid': 'str', 'group_id': 'str', 'id': 'str', 'input_content_available': 'bool', 'input_content_claim_container': 'str', 'input_content_claim_file_size': 'str', 'input_content_claim_file_size_bytes': 'int', 'input_content_claim_identifier': 'str', 'input_content_claim_offset': 'int', 'input_content_claim_section': 'str', 'lineage_duration': 'int', 'output_content_available': 'bool', 'output_content_claim_container': 'str', 'output_content_claim_file_size': 'str', 'output_content_claim_file_size_bytes': 'int', 'output_content_claim_identifier': 'str', 'output_content_claim_offset': 'int', 'output_content_claim_section': 'str', 'parent_uuids': 'list[str]', 'relationship': 'str', 'replay_available': 'bool', 'replay_explanation': 'str', 'source_connection_identifier': 'str', 'source_system_flow_file_id': 'str', 'transit_uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transit_uri

Gets the transit_uri of this ProvenanceEventDTO. The source/destination system uri if the event was a RECEIVE/SEND.

Returns:The transit_uri of this ProvenanceEventDTO. Return type:str

nipyapi.nifi.models.provenance_event_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_event_entity.ProvenanceEventEntity(provenance_event=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProvenanceEventEntity - a model defined in Swagger

attribute_map = {'provenance_event': 'provenanceEvent'}

provenance_event

Gets the provenance_event of this ProvenanceEventEntity.

Returns:The provenance_event of this ProvenanceEventEntity. Return type:ProvenanceEventDTO

swagger_types = {'provenance_event': 'ProvenanceEventDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.provenance_link_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_link_dto.ProvenanceLinkDTO(source_id=None, target_id=None, flow_file_uuid=None, timestamp=None, millis=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProvenanceLinkDTO - a model defined in Swagger

attribute_map = {'flow_file_uuid': 'flowFileUuid', 'millis': 'millis', 'source_id': 'sourceId', 'target_id': 'targetId', 'timestamp': 'timestamp'}

flow_file_uuid

Gets the flow_file_uuid of this ProvenanceLinkDTO. The flowfile uuid that traversed the link.

Returns:The flow_file_uuid of this ProvenanceLinkDTO. Return type:str

millis

Gets the millis of this ProvenanceLinkDTO. The timestamp of this link in milliseconds.

Returns:The millis of this ProvenanceLinkDTO. Return type:int

source_id

Gets the source_id of this ProvenanceLinkDTO. The source node id of the link.

Returns:The source_id of this ProvenanceLinkDTO. Return type:str

swagger_types = {'flow_file_uuid': 'str', 'millis': 'int', 'source_id': 'str', 'target_id': 'str', 'timestamp': 'str'}

target_id

Gets the target_id of this ProvenanceLinkDTO. The target node id of the link.

Returns:The target_id of this ProvenanceLinkDTO. Return type:str

timestamp

Gets the timestamp of this ProvenanceLinkDTO. The timestamp of the link (based on the destination).

Returns:The timestamp of this ProvenanceLinkDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.provenance_node_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_node_dto.ProvenanceNodeDTO(id=None, flow_file_uuid=None, parent_uuids=None, child_uuids=None, cluster_node_identifier=None, type=None, event_type=None, millis=None, timestamp=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProvenanceNodeDTO - a model defined in Swagger

attribute_map = {'child_uuids': 'childUuids', 'cluster_node_identifier': 'clusterNodeIdentifier', 'event_type': 'eventType', 'flow_file_uuid': 'flowFileUuid', 'id': 'id', 'millis': 'millis', 'parent_uuids': 'parentUuids', 'timestamp': 'timestamp', 'type': 'type'}

child_uuids

Gets the child_uuids of this ProvenanceNodeDTO. The uuid of the childrent flowfiles of the provenance event.

Returns:The child_uuids of this ProvenanceNodeDTO. Return type:list[str]

cluster_node_identifier

Gets the cluster_node_identifier of this ProvenanceNodeDTO. The identifier of the node that this event/flowfile originated from.

Returns:The cluster_node_identifier of this ProvenanceNodeDTO. Return type:str

event_type

Gets the event_type of this ProvenanceNodeDTO. If the type is EVENT, this is the type of event.

Returns:The event_type of this ProvenanceNodeDTO. Return type:str

flow_file_uuid

Gets the flow_file_uuid of this ProvenanceNodeDTO. The uuid of the flowfile associated with the provenance event.

Returns:The flow_file_uuid of this ProvenanceNodeDTO. Return type:str

id

Gets the id of this ProvenanceNodeDTO. The id of the node.

Returns:The id of this ProvenanceNodeDTO. Return type:str

millis

Gets the millis of this ProvenanceNodeDTO. The timestamp of the node in milliseconds.

Returns:The millis of this ProvenanceNodeDTO. Return type:int

parent_uuids

Gets the parent_uuids of this ProvenanceNodeDTO. The uuid of the parent flowfiles of the provenance event.

Returns:The parent_uuids of this ProvenanceNodeDTO. Return type:list[str]

swagger_types = {'child_uuids': 'list[str]', 'cluster_node_identifier': 'str', 'event_type': 'str', 'flow_file_uuid': 'str', 'id': 'str', 'millis': 'int', 'parent_uuids': 'list[str]', 'timestamp': 'str', 'type': 'str'}

timestamp

Gets the timestamp of this ProvenanceNodeDTO. The timestamp of the node formatted.

Returns:The timestamp of this ProvenanceNodeDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ProvenanceNodeDTO. The type of the node.

Returns:The type of this ProvenanceNodeDTO. Return type:str

nipyapi.nifi.models.provenance_options_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_options_dto.ProvenanceOptionsDTO(searchable_fields=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProvenanceOptionsDTO - a model defined in Swagger

attribute_map = {'searchable_fields': 'searchableFields'}

searchable_fields

Gets the searchable_fields of this ProvenanceOptionsDTO. The available searchable field for the NiFi.

Returns:The searchable_fields of this ProvenanceOptionsDTO. Return type:list[ProvenanceSearchableFieldDTO]

swagger_types = {'searchable_fields': 'list[ProvenanceSearchableFieldDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.provenance_options_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_options_entity.ProvenanceOptionsEntity(provenance_options=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProvenanceOptionsEntity - a model defined in Swagger

attribute_map = {'provenance_options': 'provenanceOptions'}

provenance_options

Gets the provenance_options of this ProvenanceOptionsEntity.

Returns:The provenance_options of this ProvenanceOptionsEntity. Return type:ProvenanceOptionsDTO

swagger_types = {'provenance_options': 'ProvenanceOptionsDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.provenance_request_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_request_dto.ProvenanceRequestDTO(search_terms=None, cluster_node_id=None, start_date=None, end_date=None, minimum_file_size=None, maximum_file_size=None, max_results=None, summarize=None, incremental_results=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProvenanceRequestDTO - a model defined in Swagger

attribute_map = {'cluster_node_id': 'clusterNodeId', 'end_date': 'endDate', 'incremental_results': 'incrementalResults', 'max_results': 'maxResults', 'maximum_file_size': 'maximumFileSize', 'minimum_file_size': 'minimumFileSize', 'search_terms': 'searchTerms', 'start_date': 'startDate', 'summarize': 'summarize'}

cluster_node_id

Gets the cluster_node_id of this ProvenanceRequestDTO. The id of the node in the cluster where this provenance originated.

Returns:The cluster_node_id of this ProvenanceRequestDTO. Return type:str

end_date

Gets the end_date of this ProvenanceRequestDTO. The latest event time to include in the query.

Returns:The end_date of this ProvenanceRequestDTO. Return type:str

incremental_results

Gets the incremental_results of this ProvenanceRequestDTO. Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.

Returns:The incremental_results of this ProvenanceRequestDTO. Return type:bool

max_results

Gets the max_results of this ProvenanceRequestDTO. The maximum number of results to include.

Returns:The max_results of this ProvenanceRequestDTO. Return type:int

maximum_file_size

Gets the maximum_file_size of this ProvenanceRequestDTO. The maximum file size to include in the query.

Returns:The maximum_file_size of this ProvenanceRequestDTO. Return type:str

minimum_file_size

Gets the minimum_file_size of this ProvenanceRequestDTO. The minimum file size to include in the query.

Returns:The minimum_file_size of this ProvenanceRequestDTO. Return type:str

search_terms

Gets the search_terms of this ProvenanceRequestDTO. The search terms used to perform the search.

Returns:The search_terms of this ProvenanceRequestDTO. Return type:dict(str, ProvenanceSearchValueDTO)

start_date

Gets the start_date of this ProvenanceRequestDTO. The earliest event time to include in the query.

Returns:The start_date of this ProvenanceRequestDTO. Return type:str

summarize

Gets the summarize of this ProvenanceRequestDTO. Whether or not to summarize provenance events returned. This property is false by default.

Returns:The summarize of this ProvenanceRequestDTO. Return type:bool

swagger_types = {'cluster_node_id': 'str', 'end_date': 'str', 'incremental_results': 'bool', 'max_results': 'int', 'maximum_file_size': 'str', 'minimum_file_size': 'str', 'search_terms': 'dict(str, ProvenanceSearchValueDTO)', 'start_date': 'str', 'summarize': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.provenance_results_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_results_dto.ProvenanceResultsDTO(provenance_events=None, total=None, total_count=None, generated=None, oldest_event=None, time_offset=None, errors=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProvenanceResultsDTO - a model defined in Swagger

attribute_map = {'errors': 'errors', 'generated': 'generated', 'oldest_event': 'oldestEvent', 'provenance_events': 'provenanceEvents', 'time_offset': 'timeOffset', 'total': 'total', 'total_count': 'totalCount'}

errors

Gets the errors of this ProvenanceResultsDTO. Any errors that occurred while performing the provenance request.

Returns:The errors of this ProvenanceResultsDTO. Return type:list[str]

generated

Gets the generated of this ProvenanceResultsDTO. Then the search was performed.

Returns:The generated of this ProvenanceResultsDTO. Return type:str

oldest_event

Gets the oldest_event of this ProvenanceResultsDTO. The oldest event available in the provenance repository.

Returns:The oldest_event of this ProvenanceResultsDTO. Return type:str

provenance_events

Gets the provenance_events of this ProvenanceResultsDTO. The provenance events that matched the search criteria.

Returns:The provenance_events of this ProvenanceResultsDTO. Return type:list[ProvenanceEventDTO]

swagger_types = {'errors': 'list[str]', 'generated': 'str', 'oldest_event': 'str', 'provenance_events': 'list[ProvenanceEventDTO]', 'time_offset': 'int', 'total': 'str', 'total_count': 'int'}

time_offset

Gets the time_offset of this ProvenanceResultsDTO. The time offset of the server that’s used for event time.

Returns:The time_offset of this ProvenanceResultsDTO. Return type:int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

total

Gets the total of this ProvenanceResultsDTO. The total number of results formatted.

Returns:The total of this ProvenanceResultsDTO. Return type:str

total_count

Gets the total_count of this ProvenanceResultsDTO. The total number of results.

Returns:The total_count of this ProvenanceResultsDTO. Return type:int

nipyapi.nifi.models.provenance_searchable_field_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_searchable_field_dto.ProvenanceSearchableFieldDTO(id=None, field=None, label=None, type=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ProvenanceSearchableFieldDTO - a model defined in Swagger

attribute_map = {'field': 'field', 'id': 'id', 'label': 'label', 'type': 'type'}

field

Gets the field of this ProvenanceSearchableFieldDTO. The searchable field.

Returns:The field of this ProvenanceSearchableFieldDTO. Return type:str

id

Gets the id of this ProvenanceSearchableFieldDTO. The id of the searchable field.

Returns:The id of this ProvenanceSearchableFieldDTO. Return type:str

label

Gets the label of this ProvenanceSearchableFieldDTO. The label for the searchable field.

Returns:The label of this ProvenanceSearchableFieldDTO. Return type:str

swagger_types = {'field': 'str', 'id': 'str', 'label': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ProvenanceSearchableFieldDTO. The type of the searchable field.

Returns:The type of this ProvenanceSearchableFieldDTO. Return type:str

nipyapi.nifi.models.queue_size_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.queue_size_dto.QueueSizeDTO(byte_count=None, object_count=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

QueueSizeDTO - a model defined in Swagger

attribute_map = {'byte_count': 'byteCount', 'object_count': 'objectCount'}

byte_count

Gets the byte_count of this QueueSizeDTO. The size of objects in a queue.

Returns:The byte_count of this QueueSizeDTO. Return type:int

object_count

Gets the object_count of this QueueSizeDTO. The count of objects in a queue.

Returns:The object_count of this QueueSizeDTO. Return type:int

swagger_types = {'byte_count': 'int', 'object_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.registry_client_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.registry_client_entity.RegistryClientEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RegistryClientEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this RegistryClientEntity. The bulletins for this component.

Returns:The bulletins of this RegistryClientEntity. Return type:list[BulletinEntity]

component

Gets the component of this RegistryClientEntity.

Returns:The component of this RegistryClientEntity. Return type:RegistryDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this RegistryClientEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this RegistryClientEntity. Return type:bool

id

Gets the id of this RegistryClientEntity. The id of the component.

Returns:The id of this RegistryClientEntity. Return type:str

permissions

Gets the permissions of this RegistryClientEntity. The permissions for this component.

Returns:The permissions of this RegistryClientEntity. Return type:PermissionsDTO

position

Gets the position of this RegistryClientEntity. The position of this component in the UI if applicable.

Returns:The position of this RegistryClientEntity. Return type:PositionDTO

revision

Gets the revision of this RegistryClientEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this RegistryClientEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'RegistryDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this RegistryClientEntity. The URI for futures requests to the component.

Returns:The uri of this RegistryClientEntity. Return type:str

nipyapi.nifi.models.registry_clients_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.registry_clients_entity.RegistryClientsEntity(registries=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RegistryClientsEntity - a model defined in Swagger

attribute_map = {'registries': 'registries'}

registries

Gets the registries of this RegistryClientsEntity.

Returns:The registries of this RegistryClientsEntity. Return type:list[RegistryClientEntity]

swagger_types = {'registries': 'list[RegistryClientEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.registry_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.registry_dto.RegistryDTO(id=None, name=None, description=None, uri=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RegistryDTO - a model defined in Swagger

attribute_map = {'description': 'description', 'id': 'id', 'name': 'name', 'uri': 'uri'}

description

Gets the description of this RegistryDTO. The registry description

Returns:The description of this RegistryDTO. Return type:str

id

Gets the id of this RegistryDTO. The registry identifier

Returns:The id of this RegistryDTO. Return type:str

name

Gets the name of this RegistryDTO. The registry name

Returns:The name of this RegistryDTO. Return type:str

swagger_types = {'description': 'str', 'id': 'str', 'name': 'str', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this RegistryDTO. The registry URI

Returns:The uri of this RegistryDTO. Return type:str

nipyapi.nifi.models.relationship_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.relationship_dto.RelationshipDTO(name=None, description=None, auto_terminate=None, retry=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RelationshipDTO - a model defined in Swagger

attribute_map = {'auto_terminate': 'autoTerminate', 'description': 'description', 'name': 'name', 'retry': 'retry'}

auto_terminate

Gets the auto_terminate of this RelationshipDTO. Whether or not flowfiles sent to this relationship should auto terminate.

Returns:The auto_terminate of this RelationshipDTO. Return type:bool

description

Gets the description of this RelationshipDTO. The relationship description.

Returns:The description of this RelationshipDTO. Return type:str

name

Gets the name of this RelationshipDTO. The relationship name.

Returns:The name of this RelationshipDTO. Return type:str

retry

Gets the retry of this RelationshipDTO. Whether or not flowfiles sent to this relationship should retry.

Returns:The retry of this RelationshipDTO. Return type:bool

swagger_types = {'auto_terminate': 'bool', 'description': 'str', 'name': 'str', 'retry': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.remote_process_group_contents_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_contents_dto.RemoteProcessGroupContentsDTO(input_ports=None, output_ports=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RemoteProcessGroupContentsDTO - a model defined in Swagger

attribute_map = {'input_ports': 'inputPorts', 'output_ports': 'outputPorts'}

input_ports

Gets the input_ports of this RemoteProcessGroupContentsDTO. The input ports to which data can be sent.

Returns:The input_ports of this RemoteProcessGroupContentsDTO. Return type:list[RemoteProcessGroupPortDTO]

output_ports

Gets the output_ports of this RemoteProcessGroupContentsDTO. The output ports from which data can be retrieved.

Returns:The output_ports of this RemoteProcessGroupContentsDTO. Return type:list[RemoteProcessGroupPortDTO]

swagger_types = {'input_ports': 'list[RemoteProcessGroupPortDTO]', 'output_ports': 'list[RemoteProcessGroupPortDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.remote_process_group_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_dto.RemoteProcessGroupDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, target_uri=None, target_uris=None, target_secure=None, name=None, comments=None, communications_timeout=None, yield_duration=None, transport_protocol=None, local_network_interface=None, proxy_host=None, proxy_port=None, proxy_user=None, proxy_password=None, authorization_issues=None, validation_errors=None, transmitting=None, input_port_count=None, output_port_count=None, active_remote_input_port_count=None, inactive_remote_input_port_count=None, active_remote_output_port_count=None, inactive_remote_output_port_count=None, flow_refreshed=None, contents=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RemoteProcessGroupDTO - a model defined in Swagger

active_remote_input_port_count

Gets the active_remote_input_port_count of this RemoteProcessGroupDTO. The number of active remote input ports.

Returns:The active_remote_input_port_count of this RemoteProcessGroupDTO. Return type:int

active_remote_output_port_count

Gets the active_remote_output_port_count of this RemoteProcessGroupDTO. The number of active remote output ports.

Returns:The active_remote_output_port_count of this RemoteProcessGroupDTO. Return type:int

attribute_map = {'active_remote_input_port_count': 'activeRemoteInputPortCount', 'active_remote_output_port_count': 'activeRemoteOutputPortCount', 'authorization_issues': 'authorizationIssues', 'comments': 'comments', 'communications_timeout': 'communicationsTimeout', 'contents': 'contents', 'flow_refreshed': 'flowRefreshed', 'id': 'id', 'inactive_remote_input_port_count': 'inactiveRemoteInputPortCount', 'inactive_remote_output_port_count': 'inactiveRemoteOutputPortCount', 'input_port_count': 'inputPortCount', 'local_network_interface': 'localNetworkInterface', 'name': 'name', 'output_port_count': 'outputPortCount', 'parent_group_id': 'parentGroupId', 'position': 'position', 'proxy_host': 'proxyHost', 'proxy_password': 'proxyPassword', 'proxy_port': 'proxyPort', 'proxy_user': 'proxyUser', 'target_secure': 'targetSecure', 'target_uri': 'targetUri', 'target_uris': 'targetUris', 'transmitting': 'transmitting', 'transport_protocol': 'transportProtocol', 'validation_errors': 'validationErrors', 'versioned_component_id': 'versionedComponentId', 'yield_duration': 'yieldDuration'}

authorization_issues

Gets the authorization_issues of this RemoteProcessGroupDTO. Any remote authorization issues for the remote process group.

Returns:The authorization_issues of this RemoteProcessGroupDTO. Return type:list[str]

comments

Gets the comments of this RemoteProcessGroupDTO. The comments for the remote process group.

Returns:The comments of this RemoteProcessGroupDTO. Return type:str

communications_timeout

Gets the communications_timeout of this RemoteProcessGroupDTO. The time period used for the timeout when communicating with the target.

Returns:The communications_timeout of this RemoteProcessGroupDTO. Return type:str

contents

Gets the contents of this RemoteProcessGroupDTO. The contents of the remote process group. Will contain available input/output ports.

Returns:The contents of this RemoteProcessGroupDTO. Return type:RemoteProcessGroupContentsDTO

flow_refreshed

Gets the flow_refreshed of this RemoteProcessGroupDTO. The timestamp when this remote process group was last refreshed.

Returns:The flow_refreshed of this RemoteProcessGroupDTO. Return type:str

id

Gets the id of this RemoteProcessGroupDTO. The id of the component.

Returns:The id of this RemoteProcessGroupDTO. Return type:str

inactive_remote_input_port_count

Gets the inactive_remote_input_port_count of this RemoteProcessGroupDTO. The number of inactive remote input ports.

Returns:The inactive_remote_input_port_count of this RemoteProcessGroupDTO. Return type:int

inactive_remote_output_port_count

Gets the inactive_remote_output_port_count of this RemoteProcessGroupDTO. The number of inactive remote output ports.

Returns:The inactive_remote_output_port_count of this RemoteProcessGroupDTO. Return type:int

input_port_count

Gets the input_port_count of this RemoteProcessGroupDTO. The number of remote input ports currently available on the target.

Returns:The input_port_count of this RemoteProcessGroupDTO. Return type:int

local_network_interface

Gets the local_network_interface of this RemoteProcessGroupDTO. The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier.

Returns:The local_network_interface of this RemoteProcessGroupDTO. Return type:str

name

Gets the name of this RemoteProcessGroupDTO. The name of the remote process group.

Returns:The name of this RemoteProcessGroupDTO. Return type:str

output_port_count

Gets the output_port_count of this RemoteProcessGroupDTO. The number of remote output ports currently available on the target.

Returns:The output_port_count of this RemoteProcessGroupDTO. Return type:int

parent_group_id

Gets the parent_group_id of this RemoteProcessGroupDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this RemoteProcessGroupDTO. Return type:str

position

Gets the position of this RemoteProcessGroupDTO. The position of this component in the UI if applicable.

Returns:The position of this RemoteProcessGroupDTO. Return type:PositionDTO

proxy_host

Gets the proxy_host of this RemoteProcessGroupDTO.

Returns:The proxy_host of this RemoteProcessGroupDTO. Return type:str

proxy_password

Gets the proxy_password of this RemoteProcessGroupDTO.

Returns:The proxy_password of this RemoteProcessGroupDTO. Return type:str

proxy_port

Gets the proxy_port of this RemoteProcessGroupDTO.

Returns:The proxy_port of this RemoteProcessGroupDTO. Return type:int

proxy_user

Gets the proxy_user of this RemoteProcessGroupDTO.

Returns:The proxy_user of this RemoteProcessGroupDTO. Return type:str

swagger_types = {'active_remote_input_port_count': 'int', 'active_remote_output_port_count': 'int', 'authorization_issues': 'list[str]', 'comments': 'str', 'communications_timeout': 'str', 'contents': 'RemoteProcessGroupContentsDTO', 'flow_refreshed': 'str', 'id': 'str', 'inactive_remote_input_port_count': 'int', 'inactive_remote_output_port_count': 'int', 'input_port_count': 'int', 'local_network_interface': 'str', 'name': 'str', 'output_port_count': 'int', 'parent_group_id': 'str', 'position': 'PositionDTO', 'proxy_host': 'str', 'proxy_password': 'str', 'proxy_port': 'int', 'proxy_user': 'str', 'target_secure': 'bool', 'target_uri': 'str', 'target_uris': 'str', 'transmitting': 'bool', 'transport_protocol': 'str', 'validation_errors': 'list[str]', 'versioned_component_id': 'str', 'yield_duration': 'str'}

target_secure

Gets the target_secure of this RemoteProcessGroupDTO. Whether the target is running securely.

Returns:The target_secure of this RemoteProcessGroupDTO. Return type:bool

target_uri

Gets the target_uri of this RemoteProcessGroupDTO. The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null.

Returns:The target_uri of this RemoteProcessGroupDTO. Return type:str

target_uris

Gets the target_uris of this RemoteProcessGroupDTO. The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null.

Returns:The target_uris of this RemoteProcessGroupDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transmitting

Gets the transmitting of this RemoteProcessGroupDTO. Whether the remote process group is actively transmitting.

Returns:The transmitting of this RemoteProcessGroupDTO. Return type:bool

transport_protocol

Gets the transport_protocol of this RemoteProcessGroupDTO.

Returns:The transport_protocol of this RemoteProcessGroupDTO. Return type:str

validation_errors

Gets the validation_errors of this RemoteProcessGroupDTO. The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.

Returns:The validation_errors of this RemoteProcessGroupDTO. Return type:list[str]

versioned_component_id

Gets the versioned_component_id of this RemoteProcessGroupDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this RemoteProcessGroupDTO. Return type:str

yield_duration

Gets the yield_duration of this RemoteProcessGroupDTO. When yielding, this amount of time must elapse before the remote process group is scheduled again.

Returns:The yield_duration of this RemoteProcessGroupDTO. Return type:str

nipyapi.nifi.models.remote_process_group_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_entity.RemoteProcessGroupEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, input_port_count=None, output_port_count=None, operate_permissions=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RemoteProcessGroupEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'input_port_count': 'inputPortCount', 'operate_permissions': 'operatePermissions', 'output_port_count': 'outputPortCount', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'status': 'status', 'uri': 'uri'}

bulletins

Gets the bulletins of this RemoteProcessGroupEntity. The bulletins for this component.

Returns:The bulletins of this RemoteProcessGroupEntity. Return type:list[BulletinEntity]

component

Gets the component of this RemoteProcessGroupEntity.

Returns:The component of this RemoteProcessGroupEntity. Return type:RemoteProcessGroupDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this RemoteProcessGroupEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this RemoteProcessGroupEntity. Return type:bool

id

Gets the id of this RemoteProcessGroupEntity. The id of the component.

Returns:The id of this RemoteProcessGroupEntity. Return type:str

input_port_count

Gets the input_port_count of this RemoteProcessGroupEntity. The number of remote input ports currently available on the target.

Returns:The input_port_count of this RemoteProcessGroupEntity. Return type:int

operate_permissions

Gets the operate_permissions of this RemoteProcessGroupEntity. The permissions for this component operations.

Returns:The operate_permissions of this RemoteProcessGroupEntity. Return type:PermissionsDTO

output_port_count

Gets the output_port_count of this RemoteProcessGroupEntity. The number of remote output ports currently available on the target.

Returns:The output_port_count of this RemoteProcessGroupEntity. Return type:int

permissions

Gets the permissions of this RemoteProcessGroupEntity. The permissions for this component.

Returns:The permissions of this RemoteProcessGroupEntity. Return type:PermissionsDTO

position

Gets the position of this RemoteProcessGroupEntity. The position of this component in the UI if applicable.

Returns:The position of this RemoteProcessGroupEntity. Return type:PositionDTO

revision

Gets the revision of this RemoteProcessGroupEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this RemoteProcessGroupEntity. Return type:RevisionDTO

status

Gets the status of this RemoteProcessGroupEntity. The status of the remote process group.

Returns:The status of this RemoteProcessGroupEntity. Return type:RemoteProcessGroupStatusDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'RemoteProcessGroupDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'input_port_count': 'int', 'operate_permissions': 'PermissionsDTO', 'output_port_count': 'int', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'status': 'RemoteProcessGroupStatusDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this RemoteProcessGroupEntity. The URI for futures requests to the component.

Returns:The uri of this RemoteProcessGroupEntity. Return type:str

nipyapi.nifi.models.remote_process_group_port_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_port_dto.RemoteProcessGroupPortDTO(id=None, target_id=None, versioned_component_id=None, group_id=None, name=None, comments=None, concurrently_schedulable_task_count=None, transmitting=None, use_compression=None, exists=None, target_running=None, connected=None, batch_settings=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RemoteProcessGroupPortDTO - a model defined in Swagger

attribute_map = {'batch_settings': 'batchSettings', 'comments': 'comments', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'connected': 'connected', 'exists': 'exists', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'target_id': 'targetId', 'target_running': 'targetRunning', 'transmitting': 'transmitting', 'use_compression': 'useCompression', 'versioned_component_id': 'versionedComponentId'}

batch_settings

Gets the batch_settings of this RemoteProcessGroupPortDTO. The batch settings for data transmission.

Returns:The batch_settings of this RemoteProcessGroupPortDTO. Return type:BatchSettingsDTO

comments

Gets the comments of this RemoteProcessGroupPortDTO. The comments as configured on the target port.

Returns:The comments of this RemoteProcessGroupPortDTO. Return type:str

concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this RemoteProcessGroupPortDTO. The number of task that may transmit flowfiles to the target port concurrently.

Returns:The concurrently_schedulable_task_count of this RemoteProcessGroupPortDTO. Return type:int

connected

Gets the connected of this RemoteProcessGroupPortDTO. Whether the port has either an incoming or outgoing connection.

Returns:The connected of this RemoteProcessGroupPortDTO. Return type:bool

exists

Gets the exists of this RemoteProcessGroupPortDTO. Whether the target port exists.

Returns:The exists of this RemoteProcessGroupPortDTO. Return type:bool

group_id

Gets the group_id of this RemoteProcessGroupPortDTO. The id of the remote process group that the port resides in.

Returns:The group_id of this RemoteProcessGroupPortDTO. Return type:str

id

Gets the id of this RemoteProcessGroupPortDTO. The id of the port.

Returns:The id of this RemoteProcessGroupPortDTO. Return type:str

name

Gets the name of this RemoteProcessGroupPortDTO. The name of the target port.

Returns:The name of this RemoteProcessGroupPortDTO. Return type:str

swagger_types = {'batch_settings': 'BatchSettingsDTO', 'comments': 'str', 'concurrently_schedulable_task_count': 'int', 'connected': 'bool', 'exists': 'bool', 'group_id': 'str', 'id': 'str', 'name': 'str', 'target_id': 'str', 'target_running': 'bool', 'transmitting': 'bool', 'use_compression': 'bool', 'versioned_component_id': 'str'}

target_id

Gets the target_id of this RemoteProcessGroupPortDTO. The id of the target port.

Returns:The target_id of this RemoteProcessGroupPortDTO. Return type:str

target_running

Gets the target_running of this RemoteProcessGroupPortDTO. Whether the target port is running.

Returns:The target_running of this RemoteProcessGroupPortDTO. Return type:bool

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transmitting

Gets the transmitting of this RemoteProcessGroupPortDTO. Whether the remote port is configured for transmission.

Returns:The transmitting of this RemoteProcessGroupPortDTO. Return type:bool

use_compression

Gets the use_compression of this RemoteProcessGroupPortDTO. Whether the flowfiles are compressed when sent to the target port.

Returns:The use_compression of this RemoteProcessGroupPortDTO. Return type:bool

versioned_component_id

Gets the versioned_component_id of this RemoteProcessGroupPortDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this RemoteProcessGroupPortDTO. Return type:str

nipyapi.nifi.models.remote_process_group_port_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_port_entity.RemoteProcessGroupPortEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, remote_process_group_port=None, operate_permissions=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RemoteProcessGroupPortEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'operate_permissions': 'operatePermissions', 'permissions': 'permissions', 'position': 'position', 'remote_process_group_port': 'remoteProcessGroupPort', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this RemoteProcessGroupPortEntity. The bulletins for this component.

Returns:The bulletins of this RemoteProcessGroupPortEntity. Return type:list[BulletinEntity]

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this RemoteProcessGroupPortEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this RemoteProcessGroupPortEntity. Return type:bool

id

Gets the id of this RemoteProcessGroupPortEntity. The id of the component.

Returns:The id of this RemoteProcessGroupPortEntity. Return type:str

operate_permissions

Gets the operate_permissions of this RemoteProcessGroupPortEntity. The permissions for this component operations.

Returns:The operate_permissions of this RemoteProcessGroupPortEntity. Return type:PermissionsDTO

permissions

Gets the permissions of this RemoteProcessGroupPortEntity. The permissions for this component.

Returns:The permissions of this RemoteProcessGroupPortEntity. Return type:PermissionsDTO

position

Gets the position of this RemoteProcessGroupPortEntity. The position of this component in the UI if applicable.

Returns:The position of this RemoteProcessGroupPortEntity. Return type:PositionDTO

remote_process_group_port

Gets the remote_process_group_port of this RemoteProcessGroupPortEntity.

Returns:The remote_process_group_port of this RemoteProcessGroupPortEntity. Return type:RemoteProcessGroupPortDTO

revision

Gets the revision of this RemoteProcessGroupPortEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this RemoteProcessGroupPortEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'operate_permissions': 'PermissionsDTO', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'remote_process_group_port': 'RemoteProcessGroupPortDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this RemoteProcessGroupPortEntity. The URI for futures requests to the component.

Returns:The uri of this RemoteProcessGroupPortEntity. Return type:str

nipyapi.nifi.models.remote_process_group_status_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_status_dto.RemoteProcessGroupStatusDTO(group_id=None, id=None, name=None, target_uri=None, transmission_status=None, stats_last_refreshed=None, validation_status=None, aggregate_snapshot=None, node_snapshots=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RemoteProcessGroupStatusDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this RemoteProcessGroupStatusDTO. A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.

Returns:The aggregate_snapshot of this RemoteProcessGroupStatusDTO. Return type:RemoteProcessGroupStatusSnapshotDTO

attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'node_snapshots': 'nodeSnapshots', 'stats_last_refreshed': 'statsLastRefreshed', 'target_uri': 'targetUri', 'transmission_status': 'transmissionStatus', 'validation_status': 'validationStatus'}

group_id

Gets the group_id of this RemoteProcessGroupStatusDTO. The unique ID of the process group that the Processor belongs to

Returns:The group_id of this RemoteProcessGroupStatusDTO. Return type:str

id

Gets the id of this RemoteProcessGroupStatusDTO. The unique ID of the Processor

Returns:The id of this RemoteProcessGroupStatusDTO. Return type:str

name

Gets the name of this RemoteProcessGroupStatusDTO. The name of the remote process group.

Returns:The name of this RemoteProcessGroupStatusDTO. Return type:str

node_snapshots

Gets the node_snapshots of this RemoteProcessGroupStatusDTO. A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.

Returns:The node_snapshots of this RemoteProcessGroupStatusDTO. Return type:list[NodeRemoteProcessGroupStatusSnapshotDTO]

stats_last_refreshed

Gets the stats_last_refreshed of this RemoteProcessGroupStatusDTO. The time the status for the process group was last refreshed.

Returns:The stats_last_refreshed of this RemoteProcessGroupStatusDTO. Return type:str

swagger_types = {'aggregate_snapshot': 'RemoteProcessGroupStatusSnapshotDTO', 'group_id': 'str', 'id': 'str', 'name': 'str', 'node_snapshots': 'list[NodeRemoteProcessGroupStatusSnapshotDTO]', 'stats_last_refreshed': 'str', 'target_uri': 'str', 'transmission_status': 'str', 'validation_status': 'str'}

target_uri

Gets the target_uri of this RemoteProcessGroupStatusDTO. The URI of the target system.

Returns:The target_uri of this RemoteProcessGroupStatusDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transmission_status

Gets the transmission_status of this RemoteProcessGroupStatusDTO. The transmission status of the remote process group.

Returns:The transmission_status of this RemoteProcessGroupStatusDTO. Return type:str

validation_status

Gets the validation_status of this RemoteProcessGroupStatusDTO. Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)

Returns:The validation_status of this RemoteProcessGroupStatusDTO. Return type:str

nipyapi.nifi.models.remote_process_group_status_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_status_entity.RemoteProcessGroupStatusEntity(remote_process_group_status=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RemoteProcessGroupStatusEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'remote_process_group_status': 'remoteProcessGroupStatus'}

can_read

Gets the can_read of this RemoteProcessGroupStatusEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this RemoteProcessGroupStatusEntity. Return type:bool

remote_process_group_status

Gets the remote_process_group_status of this RemoteProcessGroupStatusEntity.

Returns:The remote_process_group_status of this RemoteProcessGroupStatusEntity. Return type:RemoteProcessGroupStatusDTO

swagger_types = {'can_read': 'bool', 'remote_process_group_status': 'RemoteProcessGroupStatusDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.remote_process_group_status_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_status_snapshot_dto.RemoteProcessGroupStatusSnapshotDTO(id=None, group_id=None, name=None, target_uri=None, transmission_status=None, active_thread_count=None, flow_files_sent=None, bytes_sent=None, sent=None, flow_files_received=None, bytes_received=None, received=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RemoteProcessGroupStatusSnapshotDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this RemoteProcessGroupStatusSnapshotDTO. The number of active threads for the remote process group.

Returns:The active_thread_count of this RemoteProcessGroupStatusSnapshotDTO. Return type:int

attribute_map = {'active_thread_count': 'activeThreadCount', 'bytes_received': 'bytesReceived', 'bytes_sent': 'bytesSent', 'flow_files_received': 'flowFilesReceived', 'flow_files_sent': 'flowFilesSent', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'received': 'received', 'sent': 'sent', 'target_uri': 'targetUri', 'transmission_status': 'transmissionStatus'}

bytes_received

Gets the bytes_received of this RemoteProcessGroupStatusSnapshotDTO. The size of the FlowFiles received from the remote process group in the last 5 minutes.

Returns:The bytes_received of this RemoteProcessGroupStatusSnapshotDTO. Return type:int

bytes_sent

Gets the bytes_sent of this RemoteProcessGroupStatusSnapshotDTO. The size of the FlowFiles sent to the remote process group in the last 5 minutes.

Returns:The bytes_sent of this RemoteProcessGroupStatusSnapshotDTO. Return type:int

flow_files_received

Gets the flow_files_received of this RemoteProcessGroupStatusSnapshotDTO. The number of FlowFiles received from the remote process group in the last 5 minutes.

Returns:The flow_files_received of this RemoteProcessGroupStatusSnapshotDTO. Return type:int

flow_files_sent

Gets the flow_files_sent of this RemoteProcessGroupStatusSnapshotDTO. The number of FlowFiles sent to the remote process group in the last 5 minutes.

Returns:The flow_files_sent of this RemoteProcessGroupStatusSnapshotDTO. Return type:int

group_id

Gets the group_id of this RemoteProcessGroupStatusSnapshotDTO. The id of the parent process group the remote process group resides in.

Returns:The group_id of this RemoteProcessGroupStatusSnapshotDTO. Return type:str

id

Gets the id of this RemoteProcessGroupStatusSnapshotDTO. The id of the remote process group.

Returns:The id of this RemoteProcessGroupStatusSnapshotDTO. Return type:str

name

Gets the name of this RemoteProcessGroupStatusSnapshotDTO. The name of the remote process group.

Returns:The name of this RemoteProcessGroupStatusSnapshotDTO. Return type:str

received

Gets the received of this RemoteProcessGroupStatusSnapshotDTO. The count/size of the flowfiles received from the remote process group in the last 5 minutes.

Returns:The received of this RemoteProcessGroupStatusSnapshotDTO. Return type:str

sent

Gets the sent of this RemoteProcessGroupStatusSnapshotDTO. The count/size of the flowfiles sent to the remote process group in the last 5 minutes.

Returns:The sent of this RemoteProcessGroupStatusSnapshotDTO. Return type:str

swagger_types = {'active_thread_count': 'int', 'bytes_received': 'int', 'bytes_sent': 'int', 'flow_files_received': 'int', 'flow_files_sent': 'int', 'group_id': 'str', 'id': 'str', 'name': 'str', 'received': 'str', 'sent': 'str', 'target_uri': 'str', 'transmission_status': 'str'}

target_uri

Gets the target_uri of this RemoteProcessGroupStatusSnapshotDTO. The URI of the target system.

Returns:The target_uri of this RemoteProcessGroupStatusSnapshotDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transmission_status

Gets the transmission_status of this RemoteProcessGroupStatusSnapshotDTO. The transmission status of the remote process group.

Returns:The transmission_status of this RemoteProcessGroupStatusSnapshotDTO. Return type:str

nipyapi.nifi.models.remote_process_group_status_snapshot_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_status_snapshot_entity.RemoteProcessGroupStatusSnapshotEntity(id=None, remote_process_group_status_snapshot=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RemoteProcessGroupStatusSnapshotEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'id': 'id', 'remote_process_group_status_snapshot': 'remoteProcessGroupStatusSnapshot'}

can_read

Gets the can_read of this RemoteProcessGroupStatusSnapshotEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this RemoteProcessGroupStatusSnapshotEntity. Return type:bool

id

Gets the id of this RemoteProcessGroupStatusSnapshotEntity. The id of the remote process group.

Returns:The id of this RemoteProcessGroupStatusSnapshotEntity. Return type:str

remote_process_group_status_snapshot

Gets the remote_process_group_status_snapshot of this RemoteProcessGroupStatusSnapshotEntity.

Returns:The remote_process_group_status_snapshot of this RemoteProcessGroupStatusSnapshotEntity. Return type:RemoteProcessGroupStatusSnapshotDTO

swagger_types = {'can_read': 'bool', 'id': 'str', 'remote_process_group_status_snapshot': 'RemoteProcessGroupStatusSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.remote_process_groups_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_groups_entity.RemoteProcessGroupsEntity(remote_process_groups=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RemoteProcessGroupsEntity - a model defined in Swagger

attribute_map = {'remote_process_groups': 'remoteProcessGroups'}

remote_process_groups

Gets the remote_process_groups of this RemoteProcessGroupsEntity.

Returns:The remote_process_groups of this RemoteProcessGroupsEntity. Return type:list[RemoteProcessGroupEntity]

swagger_types = {'remote_process_groups': 'list[RemoteProcessGroupEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.reporting_task_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.reporting_task_dto.ReportingTaskDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, type=None, bundle=None, state=None, comments=None, persists_state=None, restricted=None, deprecated=None, multiple_versions_available=None, supports_sensitive_dynamic_properties=None, scheduling_period=None, scheduling_strategy=None, default_scheduling_period=None, properties=None, descriptors=None, sensitive_dynamic_property_names=None, custom_ui_url=None, annotation_data=None, validation_errors=None, validation_status=None, active_thread_count=None, extension_missing=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ReportingTaskDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this ReportingTaskDTO. The number of active threads for the reporting task.

Returns:The active_thread_count of this ReportingTaskDTO. Return type:int

annotation_data

Gets the annotation_data of this ReportingTaskDTO. The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task.

Returns:The annotation_data of this ReportingTaskDTO. Return type:str

attribute_map = {'active_thread_count': 'activeThreadCount', 'annotation_data': 'annotationData', 'bundle': 'bundle', 'comments': 'comments', 'custom_ui_url': 'customUiUrl', 'default_scheduling_period': 'defaultSchedulingPeriod', 'deprecated': 'deprecated', 'descriptors': 'descriptors', 'extension_missing': 'extensionMissing', 'id': 'id', 'multiple_versions_available': 'multipleVersionsAvailable', 'name': 'name', 'parent_group_id': 'parentGroupId', 'persists_state': 'persistsState', 'position': 'position', 'properties': 'properties', 'restricted': 'restricted', 'scheduling_period': 'schedulingPeriod', 'scheduling_strategy': 'schedulingStrategy', 'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', 'state': 'state', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'type': 'type', 'validation_errors': 'validationErrors', 'validation_status': 'validationStatus', 'versioned_component_id': 'versionedComponentId'}

bundle

Gets the bundle of this ReportingTaskDTO. The details of the artifact that bundled this processor type.

Returns:The bundle of this ReportingTaskDTO. Return type:BundleDTO

comments

Gets the comments of this ReportingTaskDTO. The comments of the reporting task.

Returns:The comments of this ReportingTaskDTO. Return type:str

custom_ui_url

Gets the custom_ui_url of this ReportingTaskDTO. The URL for the custom configuration UI for the reporting task.

Returns:The custom_ui_url of this ReportingTaskDTO. Return type:str

default_scheduling_period

Gets the default_scheduling_period of this ReportingTaskDTO. The default scheduling period for the different scheduling strategies.

Returns:The default_scheduling_period of this ReportingTaskDTO. Return type:dict(str, str)

deprecated

Gets the deprecated of this ReportingTaskDTO. Whether the reporting task has been deprecated.

Returns:The deprecated of this ReportingTaskDTO. Return type:bool

descriptors

Gets the descriptors of this ReportingTaskDTO. The descriptors for the reporting tasks properties.

Returns:The descriptors of this ReportingTaskDTO. Return type:dict(str, PropertyDescriptorDTO)

extension_missing

Gets the extension_missing of this ReportingTaskDTO. Whether the underlying extension is missing.

Returns:The extension_missing of this ReportingTaskDTO. Return type:bool

id

Gets the id of this ReportingTaskDTO. The id of the component.

Returns:The id of this ReportingTaskDTO. Return type:str

multiple_versions_available

Gets the multiple_versions_available of this ReportingTaskDTO. Whether the reporting task has multiple versions available.

Returns:The multiple_versions_available of this ReportingTaskDTO. Return type:bool

name

Gets the name of this ReportingTaskDTO. The name of the reporting task.

Returns:The name of this ReportingTaskDTO. Return type:str

parent_group_id

Gets the parent_group_id of this ReportingTaskDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this ReportingTaskDTO. Return type:str

persists_state

Gets the persists_state of this ReportingTaskDTO. Whether the reporting task persists state.

Returns:The persists_state of this ReportingTaskDTO. Return type:bool

position

Gets the position of this ReportingTaskDTO. The position of this component in the UI if applicable.

Returns:The position of this ReportingTaskDTO. Return type:PositionDTO

properties

Gets the properties of this ReportingTaskDTO. The properties of the reporting task.

Returns:The properties of this ReportingTaskDTO. Return type:dict(str, str)

restricted

Gets the restricted of this ReportingTaskDTO. Whether the reporting task requires elevated privileges.

Returns:The restricted of this ReportingTaskDTO. Return type:bool

scheduling_period

Gets the scheduling_period of this ReportingTaskDTO. The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy.

Returns:The scheduling_period of this ReportingTaskDTO. Return type:str

scheduling_strategy

Gets the scheduling_strategy of this ReportingTaskDTO. The scheduling strategy that determines how the schedulingPeriod value should be interpreted.

Returns:The scheduling_strategy of this ReportingTaskDTO. Return type:str

sensitive_dynamic_property_names

Gets the sensitive_dynamic_property_names of this ReportingTaskDTO. Set of sensitive dynamic property names

Returns:The sensitive_dynamic_property_names of this ReportingTaskDTO. Return type:list[str]

state

Gets the state of this ReportingTaskDTO. The state of the reporting task.

Returns:The state of this ReportingTaskDTO. Return type:str

supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this ReportingTaskDTO. Whether the reporting task supports sensitive dynamic properties.

Returns:The supports_sensitive_dynamic_properties of this ReportingTaskDTO. Return type:bool

swagger_types = {'active_thread_count': 'int', 'annotation_data': 'str', 'bundle': 'BundleDTO', 'comments': 'str', 'custom_ui_url': 'str', 'default_scheduling_period': 'dict(str, str)', 'deprecated': 'bool', 'descriptors': 'dict(str, PropertyDescriptorDTO)', 'extension_missing': 'bool', 'id': 'str', 'multiple_versions_available': 'bool', 'name': 'str', 'parent_group_id': 'str', 'persists_state': 'bool', 'position': 'PositionDTO', 'properties': 'dict(str, str)', 'restricted': 'bool', 'scheduling_period': 'str', 'scheduling_strategy': 'str', 'sensitive_dynamic_property_names': 'list[str]', 'state': 'str', 'supports_sensitive_dynamic_properties': 'bool', 'type': 'str', 'validation_errors': 'list[str]', 'validation_status': 'str', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ReportingTaskDTO. The fully qualified type of the reporting task.

Returns:The type of this ReportingTaskDTO. Return type:str

validation_errors

Gets the validation_errors of this ReportingTaskDTO. Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.

Returns:The validation_errors of this ReportingTaskDTO. Return type:list[str]

validation_status

Gets the validation_status of this ReportingTaskDTO. Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)

Returns:The validation_status of this ReportingTaskDTO. Return type:str

versioned_component_id

Gets the versioned_component_id of this ReportingTaskDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this ReportingTaskDTO. Return type:str

nipyapi.nifi.models.reporting_task_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.reporting_task_entity.ReportingTaskEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, operate_permissions=None, status=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ReportingTaskEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'operate_permissions': 'operatePermissions', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'status': 'status', 'uri': 'uri'}

bulletins

Gets the bulletins of this ReportingTaskEntity. The bulletins for this component.

Returns:The bulletins of this ReportingTaskEntity. Return type:list[BulletinEntity]

component

Gets the component of this ReportingTaskEntity.

Returns:The component of this ReportingTaskEntity. Return type:ReportingTaskDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ReportingTaskEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ReportingTaskEntity. Return type:bool

id

Gets the id of this ReportingTaskEntity. The id of the component.

Returns:The id of this ReportingTaskEntity. Return type:str

operate_permissions

Gets the operate_permissions of this ReportingTaskEntity. The permissions for this component operations.

Returns:The operate_permissions of this ReportingTaskEntity. Return type:PermissionsDTO

permissions

Gets the permissions of this ReportingTaskEntity. The permissions for this component.

Returns:The permissions of this ReportingTaskEntity. Return type:PermissionsDTO

position

Gets the position of this ReportingTaskEntity. The position of this component in the UI if applicable.

Returns:The position of this ReportingTaskEntity. Return type:PositionDTO

revision

Gets the revision of this ReportingTaskEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this ReportingTaskEntity. Return type:RevisionDTO

status

Gets the status of this ReportingTaskEntity. The status for this ReportingTask.

Returns:The status of this ReportingTaskEntity. Return type:ReportingTaskStatusDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'ReportingTaskDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'operate_permissions': 'PermissionsDTO', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'status': 'ReportingTaskStatusDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ReportingTaskEntity. The URI for futures requests to the component.

Returns:The uri of this ReportingTaskEntity. Return type:str

nipyapi.nifi.models.reporting_task_types_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.reporting_task_types_entity.ReportingTaskTypesEntity(reporting_task_types=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ReportingTaskTypesEntity - a model defined in Swagger

attribute_map = {'reporting_task_types': 'reportingTaskTypes'}

reporting_task_types

Gets the reporting_task_types of this ReportingTaskTypesEntity.

Returns:The reporting_task_types of this ReportingTaskTypesEntity. Return type:list[DocumentedTypeDTO]

swagger_types = {'reporting_task_types': 'list[DocumentedTypeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.reporting_tasks_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.reporting_tasks_entity.ReportingTasksEntity(reporting_tasks=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ReportingTasksEntity - a model defined in Swagger

attribute_map = {'reporting_tasks': 'reportingTasks'}

reporting_tasks

Gets the reporting_tasks of this ReportingTasksEntity.

Returns:The reporting_tasks of this ReportingTasksEntity. Return type:list[ReportingTaskEntity]

swagger_types = {'reporting_tasks': 'list[ReportingTaskEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.resource_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.resource_dto.ResourceDTO(identifier=None, name=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ResourceDTO - a model defined in Swagger

attribute_map = {'identifier': 'identifier', 'name': 'name'}

identifier

Gets the identifier of this ResourceDTO. The identifier of the resource.

Returns:The identifier of this ResourceDTO. Return type:str

name

Gets the name of this ResourceDTO. The name of the resource.

Returns:The name of this ResourceDTO. Return type:str

swagger_types = {'identifier': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.resources_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.resources_entity.ResourcesEntity(resources=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ResourcesEntity - a model defined in Swagger

attribute_map = {'resources': 'resources'}

resources

Gets the resources of this ResourcesEntity.

Returns:The resources of this ResourcesEntity. Return type:list[ResourceDTO]

swagger_types = {'resources': 'list[ResourceDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.revision_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.revision_dto.RevisionDTO(client_id=None, version=None, last_modifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

RevisionDTO - a model defined in Swagger

attribute_map = {'client_id': 'clientId', 'last_modifier': 'lastModifier', 'version': 'version'}

client_id

Gets the client_id of this RevisionDTO. A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back

Returns:The client_id of this RevisionDTO. Return type:str

last_modifier

Gets the last_modifier of this RevisionDTO. The user that last modified the flow.

Returns:The last_modifier of this RevisionDTO. Return type:str

swagger_types = {'client_id': 'str', 'last_modifier': 'str', 'version': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version

Gets the version of this RevisionDTO. NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version.

Returns:The version of this RevisionDTO. Return type:int

nipyapi.nifi.models.schedule_components_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.schedule_components_entity.ScheduleComponentsEntity(id=None, state=None, components=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ScheduleComponentsEntity - a model defined in Swagger

attribute_map = {'components': 'components', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'state': 'state'}

components

Gets the components of this ScheduleComponentsEntity. Optional components to schedule. If not specified, all authorized descendant components will be used.

Returns:The components of this ScheduleComponentsEntity. Return type:dict(str, RevisionDTO)

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ScheduleComponentsEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ScheduleComponentsEntity. Return type:bool

id

Gets the id of this ScheduleComponentsEntity. The id of the ProcessGroup

Returns:The id of this ScheduleComponentsEntity. Return type:str

state

Gets the state of this ScheduleComponentsEntity. The desired state of the descendant components

Returns:The state of this ScheduleComponentsEntity. Return type:str

swagger_types = {'components': 'dict(str, RevisionDTO)', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'state': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.search_results_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.search_results_dto.SearchResultsDTO(processor_results=None, connection_results=None, process_group_results=None, input_port_results=None, output_port_results=None, remote_process_group_results=None, funnel_results=None, label_results=None, controller_service_node_results=None, parameter_context_results=None, parameter_results=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

SearchResultsDTO - a model defined in Swagger

attribute_map = {'connection_results': 'connectionResults', 'controller_service_node_results': 'controllerServiceNodeResults', 'funnel_results': 'funnelResults', 'input_port_results': 'inputPortResults', 'label_results': 'labelResults', 'output_port_results': 'outputPortResults', 'parameter_context_results': 'parameterContextResults', 'parameter_results': 'parameterResults', 'process_group_results': 'processGroupResults', 'processor_results': 'processorResults', 'remote_process_group_results': 'remoteProcessGroupResults'}

connection_results

Gets the connection_results of this SearchResultsDTO. The connections that matched the search.

Returns:The connection_results of this SearchResultsDTO. Return type:list[ComponentSearchResultDTO]

controller_service_node_results

Gets the controller_service_node_results of this SearchResultsDTO. The controller service nodes that matched the search

Returns:The controller_service_node_results of this SearchResultsDTO. Return type:list[ComponentSearchResultDTO]

funnel_results

Gets the funnel_results of this SearchResultsDTO. The funnels that matched the search.

Returns:The funnel_results of this SearchResultsDTO. Return type:list[ComponentSearchResultDTO]

input_port_results

Gets the input_port_results of this SearchResultsDTO. The input ports that matched the search.

Returns:The input_port_results of this SearchResultsDTO. Return type:list[ComponentSearchResultDTO]

label_results

Gets the label_results of this SearchResultsDTO. The labels that matched the search.

Returns:The label_results of this SearchResultsDTO. Return type:list[ComponentSearchResultDTO]

output_port_results

Gets the output_port_results of this SearchResultsDTO. The output ports that matched the search.

Returns:The output_port_results of this SearchResultsDTO. Return type:list[ComponentSearchResultDTO]

parameter_context_results

Gets the parameter_context_results of this SearchResultsDTO. The parameter contexts that matched the search.

Returns:The parameter_context_results of this SearchResultsDTO. Return type:list[ComponentSearchResultDTO]

parameter_results

Gets the parameter_results of this SearchResultsDTO. The parameters that matched the search.

Returns:The parameter_results of this SearchResultsDTO. Return type:list[ComponentSearchResultDTO]

process_group_results

Gets the process_group_results of this SearchResultsDTO. The process groups that matched the search.

Returns:The process_group_results of this SearchResultsDTO. Return type:list[ComponentSearchResultDTO]

processor_results

Gets the processor_results of this SearchResultsDTO. The processors that matched the search.

Returns:The processor_results of this SearchResultsDTO. Return type:list[ComponentSearchResultDTO]

remote_process_group_results

Gets the remote_process_group_results of this SearchResultsDTO. The remote process groups that matched the search.

Returns:The remote_process_group_results of this SearchResultsDTO. Return type:list[ComponentSearchResultDTO]

swagger_types = {'connection_results': 'list[ComponentSearchResultDTO]', 'controller_service_node_results': 'list[ComponentSearchResultDTO]', 'funnel_results': 'list[ComponentSearchResultDTO]', 'input_port_results': 'list[ComponentSearchResultDTO]', 'label_results': 'list[ComponentSearchResultDTO]', 'output_port_results': 'list[ComponentSearchResultDTO]', 'parameter_context_results': 'list[ComponentSearchResultDTO]', 'parameter_results': 'list[ComponentSearchResultDTO]', 'process_group_results': 'list[ComponentSearchResultDTO]', 'processor_results': 'list[ComponentSearchResultDTO]', 'remote_process_group_results': 'list[ComponentSearchResultDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.search_results_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.search_results_entity.SearchResultsEntity(search_results_dto=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

SearchResultsEntity - a model defined in Swagger

attribute_map = {'search_results_dto': 'searchResultsDTO'}

search_results_dto

Gets the search_results_dto of this SearchResultsEntity.

Returns:The search_results_dto of this SearchResultsEntity. Return type:SearchResultsDTO

swagger_types = {'search_results_dto': 'SearchResultsDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.snippet_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.snippet_dto.SnippetDTO(id=None, uri=None, parent_group_id=None, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

SnippetDTO - a model defined in Swagger

attribute_map = {'connections': 'connections', 'funnels': 'funnels', 'id': 'id', 'input_ports': 'inputPorts', 'labels': 'labels', 'output_ports': 'outputPorts', 'parent_group_id': 'parentGroupId', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups', 'uri': 'uri'}

connections

Gets the connections of this SnippetDTO. The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The connections of this SnippetDTO. Return type:dict(str, RevisionDTO)

funnels

Gets the funnels of this SnippetDTO. The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The funnels of this SnippetDTO. Return type:dict(str, RevisionDTO)

id

Gets the id of this SnippetDTO. The id of the snippet.

Returns:The id of this SnippetDTO. Return type:str

input_ports

Gets the input_ports of this SnippetDTO. The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The input_ports of this SnippetDTO. Return type:dict(str, RevisionDTO)

labels

Gets the labels of this SnippetDTO. The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The labels of this SnippetDTO. Return type:dict(str, RevisionDTO)

output_ports

Gets the output_ports of this SnippetDTO. The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The output_ports of this SnippetDTO. Return type:dict(str, RevisionDTO)

parent_group_id

Gets the parent_group_id of this SnippetDTO. The group id for the components in the snippet.

Returns:The parent_group_id of this SnippetDTO. Return type:str

process_groups

Gets the process_groups of this SnippetDTO. The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The process_groups of this SnippetDTO. Return type:dict(str, RevisionDTO)

processors

Gets the processors of this SnippetDTO. The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The processors of this SnippetDTO. Return type:dict(str, RevisionDTO)

remote_process_groups

Gets the remote_process_groups of this SnippetDTO. The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The remote_process_groups of this SnippetDTO. Return type:dict(str, RevisionDTO)

swagger_types = {'connections': 'dict(str, RevisionDTO)', 'funnels': 'dict(str, RevisionDTO)', 'id': 'str', 'input_ports': 'dict(str, RevisionDTO)', 'labels': 'dict(str, RevisionDTO)', 'output_ports': 'dict(str, RevisionDTO)', 'parent_group_id': 'str', 'process_groups': 'dict(str, RevisionDTO)', 'processors': 'dict(str, RevisionDTO)', 'remote_process_groups': 'dict(str, RevisionDTO)', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this SnippetDTO. The URI of the snippet.

Returns:The uri of this SnippetDTO. Return type:str

nipyapi.nifi.models.snippet_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.snippet_entity.SnippetEntity(snippet=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

SnippetEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'snippet': 'snippet'}

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this SnippetEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this SnippetEntity. Return type:bool

snippet

Gets the snippet of this SnippetEntity. The snippet.

Returns:The snippet of this SnippetEntity. Return type:SnippetDTO

swagger_types = {'disconnected_node_acknowledged': 'bool', 'snippet': 'SnippetDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.start_version_control_request_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.start_version_control_request_entity.StartVersionControlRequestEntity(versioned_flow=None, process_group_revision=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

StartVersionControlRequestEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'versioned_flow': 'versionedFlow'}

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this StartVersionControlRequestEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this StartVersionControlRequestEntity. Return type:bool

process_group_revision

Gets the process_group_revision of this StartVersionControlRequestEntity. The Revision of the Process Group under Version Control

Returns:The process_group_revision of this StartVersionControlRequestEntity. Return type:RevisionDTO

swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_revision': 'RevisionDTO', 'versioned_flow': 'VersionedFlowDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_flow

Gets the versioned_flow of this StartVersionControlRequestEntity. The versioned flow

Returns:The versioned_flow of this StartVersionControlRequestEntity. Return type:VersionedFlowDTO

nipyapi.nifi.models.state_entry_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.state_entry_dto.StateEntryDTO(key=None, value=None, cluster_node_id=None, cluster_node_address=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

StateEntryDTO - a model defined in Swagger

attribute_map = {'cluster_node_address': 'clusterNodeAddress', 'cluster_node_id': 'clusterNodeId', 'key': 'key', 'value': 'value'}

cluster_node_address

Gets the cluster_node_address of this StateEntryDTO. The label for the node where the state originated.

Returns:The cluster_node_address of this StateEntryDTO. Return type:str

cluster_node_id

Gets the cluster_node_id of this StateEntryDTO. The identifier for the node where the state originated.

Returns:The cluster_node_id of this StateEntryDTO. Return type:str

key

Gets the key of this StateEntryDTO. The key for this state.

Returns:The key of this StateEntryDTO. Return type:str

swagger_types = {'cluster_node_address': 'str', 'cluster_node_id': 'str', 'key': 'str', 'value': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

value

Gets the value of this StateEntryDTO. The value for this state.

Returns:The value of this StateEntryDTO. Return type:str

nipyapi.nifi.models.state_map_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.state_map_dto.StateMapDTO(scope=None, total_entry_count=None, state=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

StateMapDTO - a model defined in Swagger

attribute_map = {'scope': 'scope', 'state': 'state', 'total_entry_count': 'totalEntryCount'}

scope

Gets the scope of this StateMapDTO. The scope of this StateMap.

Returns:The scope of this StateMapDTO. Return type:str

state

Gets the state of this StateMapDTO. The state.

Returns:The state of this StateMapDTO. Return type:list[StateEntryDTO]

swagger_types = {'scope': 'str', 'state': 'list[StateEntryDTO]', 'total_entry_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

total_entry_count

Gets the total_entry_count of this StateMapDTO. The total number of state entries. When the state map is lengthy, only of portion of the entries are returned.

Returns:The total_entry_count of this StateMapDTO. Return type:int

nipyapi.nifi.models.status_descriptor_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.status_descriptor_dto.StatusDescriptorDTO(field=None, label=None, description=None, formatter=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

StatusDescriptorDTO - a model defined in Swagger

attribute_map = {'description': 'description', 'field': 'field', 'formatter': 'formatter', 'label': 'label'}

description

Gets the description of this StatusDescriptorDTO. The description of the status field.

Returns:The description of this StatusDescriptorDTO. Return type:str

field

Gets the field of this StatusDescriptorDTO. The name of the status field.

Returns:The field of this StatusDescriptorDTO. Return type:str

formatter

Gets the formatter of this StatusDescriptorDTO. The formatter for the status descriptor.

Returns:The formatter of this StatusDescriptorDTO. Return type:str

label

Gets the label of this StatusDescriptorDTO. The label for the status field.

Returns:The label of this StatusDescriptorDTO. Return type:str

swagger_types = {'description': 'str', 'field': 'str', 'formatter': 'str', 'label': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.status_history_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.status_history_dto.StatusHistoryDTO(generated=None, component_details=None, field_descriptors=None, aggregate_snapshots=None, node_snapshots=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

StatusHistoryDTO - a model defined in Swagger

aggregate_snapshots

Gets the aggregate_snapshots of this StatusHistoryDTO. A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.

Returns:The aggregate_snapshots of this StatusHistoryDTO. Return type:list[StatusSnapshotDTO]

attribute_map = {'aggregate_snapshots': 'aggregateSnapshots', 'component_details': 'componentDetails', 'field_descriptors': 'fieldDescriptors', 'generated': 'generated', 'node_snapshots': 'nodeSnapshots'}

component_details

Gets the component_details of this StatusHistoryDTO. A Map of key/value pairs that describe the component that the status history belongs to

Returns:The component_details of this StatusHistoryDTO. Return type:dict(str, str)

field_descriptors

Gets the field_descriptors of this StatusHistoryDTO. The Descriptors that provide information on each of the metrics provided in the status history

Returns:The field_descriptors of this StatusHistoryDTO. Return type:list[StatusDescriptorDTO]

generated

Gets the generated of this StatusHistoryDTO. When the status history was generated.

Returns:The generated of this StatusHistoryDTO. Return type:str

node_snapshots

Gets the node_snapshots of this StatusHistoryDTO. The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.

Returns:The node_snapshots of this StatusHistoryDTO. Return type:list[NodeStatusSnapshotsDTO]

swagger_types = {'aggregate_snapshots': 'list[StatusSnapshotDTO]', 'component_details': 'dict(str, str)', 'field_descriptors': 'list[StatusDescriptorDTO]', 'generated': 'str', 'node_snapshots': 'list[NodeStatusSnapshotsDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.status_history_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.status_history_entity.StatusHistoryEntity(status_history=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

StatusHistoryEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'status_history': 'statusHistory'}

can_read

Gets the can_read of this StatusHistoryEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this StatusHistoryEntity. Return type:bool

status_history

Gets the status_history of this StatusHistoryEntity.

Returns:The status_history of this StatusHistoryEntity. Return type:StatusHistoryDTO

swagger_types = {'can_read': 'bool', 'status_history': 'StatusHistoryDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.status_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.status_snapshot_dto.StatusSnapshotDTO(timestamp=None, status_metrics=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

StatusSnapshotDTO - a model defined in Swagger

attribute_map = {'status_metrics': 'statusMetrics', 'timestamp': 'timestamp'}

status_metrics

Gets the status_metrics of this StatusSnapshotDTO. The status metrics.

Returns:The status_metrics of this StatusSnapshotDTO. Return type:dict(str, int)

swagger_types = {'status_metrics': 'dict(str, int)', 'timestamp': 'datetime'}

timestamp

Gets the timestamp of this StatusSnapshotDTO. The timestamp of the snapshot.

Returns:The timestamp of this StatusSnapshotDTO. Return type:datetime

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.storage_usage_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.storage_usage_dto.StorageUsageDTO(identifier=None, free_space=None, total_space=None, used_space=None, free_space_bytes=None, total_space_bytes=None, used_space_bytes=None, utilization=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

StorageUsageDTO - a model defined in Swagger

attribute_map = {'free_space': 'freeSpace', 'free_space_bytes': 'freeSpaceBytes', 'identifier': 'identifier', 'total_space': 'totalSpace', 'total_space_bytes': 'totalSpaceBytes', 'used_space': 'usedSpace', 'used_space_bytes': 'usedSpaceBytes', 'utilization': 'utilization'}

free_space

Gets the free_space of this StorageUsageDTO. Amount of free space.

Returns:The free_space of this StorageUsageDTO. Return type:str

free_space_bytes

Gets the free_space_bytes of this StorageUsageDTO. The number of bytes of free space.

Returns:The free_space_bytes of this StorageUsageDTO. Return type:int

identifier

Gets the identifier of this StorageUsageDTO. The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration.

Returns:The identifier of this StorageUsageDTO. Return type:str

swagger_types = {'free_space': 'str', 'free_space_bytes': 'int', 'identifier': 'str', 'total_space': 'str', 'total_space_bytes': 'int', 'used_space': 'str', 'used_space_bytes': 'int', 'utilization': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

total_space

Gets the total_space of this StorageUsageDTO. Amount of total space.

Returns:The total_space of this StorageUsageDTO. Return type:str

total_space_bytes

Gets the total_space_bytes of this StorageUsageDTO. The number of bytes of total space.

Returns:The total_space_bytes of this StorageUsageDTO. Return type:int

used_space

Gets the used_space of this StorageUsageDTO. Amount of used space.

Returns:The used_space of this StorageUsageDTO. Return type:str

used_space_bytes

Gets the used_space_bytes of this StorageUsageDTO. The number of bytes of used space.

Returns:The used_space_bytes of this StorageUsageDTO. Return type:int

utilization

Gets the utilization of this StorageUsageDTO. Utilization of this storage location.

Returns:The utilization of this StorageUsageDTO. Return type:str

nipyapi.nifi.models.streaming_output 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.streaming_output.StreamingOutput

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

StreamingOutput - a model defined in Swagger

attribute_map = {}

swagger_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.submit_replay_request_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.submit_replay_request_entity.SubmitReplayRequestEntity(event_id=None, cluster_node_id=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

SubmitReplayRequestEntity - a model defined in Swagger

attribute_map = {'cluster_node_id': 'clusterNodeId', 'event_id': 'eventId'}

cluster_node_id

Gets the cluster_node_id of this SubmitReplayRequestEntity. The identifier of the node where to submit the replay request.

Returns:The cluster_node_id of this SubmitReplayRequestEntity. Return type:str

event_id

Gets the event_id of this SubmitReplayRequestEntity. The event identifier

Returns:The event_id of this SubmitReplayRequestEntity. Return type:int

swagger_types = {'cluster_node_id': 'str', 'event_id': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.system_diagnostics_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.system_diagnostics_dto.SystemDiagnosticsDTO(aggregate_snapshot=None, node_snapshots=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

SystemDiagnosticsDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this SystemDiagnosticsDTO. A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.

Returns:The aggregate_snapshot of this SystemDiagnosticsDTO. Return type:SystemDiagnosticsSnapshotDTO

attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'node_snapshots': 'nodeSnapshots'}

node_snapshots

Gets the node_snapshots of this SystemDiagnosticsDTO. A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.

Returns:The node_snapshots of this SystemDiagnosticsDTO. Return type:list[NodeSystemDiagnosticsSnapshotDTO]

swagger_types = {'aggregate_snapshot': 'SystemDiagnosticsSnapshotDTO', 'node_snapshots': 'list[NodeSystemDiagnosticsSnapshotDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.system_diagnostics_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.system_diagnostics_entity.SystemDiagnosticsEntity(system_diagnostics=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

SystemDiagnosticsEntity - a model defined in Swagger

attribute_map = {'system_diagnostics': 'systemDiagnostics'}

swagger_types = {'system_diagnostics': 'SystemDiagnosticsDTO'}

system_diagnostics

Gets the system_diagnostics of this SystemDiagnosticsEntity.

Returns:The system_diagnostics of this SystemDiagnosticsEntity. Return type:SystemDiagnosticsDTO

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.system_diagnostics_snapshot_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.system_diagnostics_snapshot_dto.SystemDiagnosticsSnapshotDTO(total_non_heap=None, total_non_heap_bytes=None, used_non_heap=None, used_non_heap_bytes=None, free_non_heap=None, free_non_heap_bytes=None, max_non_heap=None, max_non_heap_bytes=None, non_heap_utilization=None, total_heap=None, total_heap_bytes=None, used_heap=None, used_heap_bytes=None, free_heap=None, free_heap_bytes=None, max_heap=None, max_heap_bytes=None, heap_utilization=None, available_processors=None, processor_load_average=None, total_threads=None, daemon_threads=None, uptime=None, flow_file_repository_storage_usage=None, content_repository_storage_usage=None, provenance_repository_storage_usage=None, garbage_collection=None, stats_last_refreshed=None, version_info=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

SystemDiagnosticsSnapshotDTO - a model defined in Swagger

attribute_map = {'available_processors': 'availableProcessors', 'content_repository_storage_usage': 'contentRepositoryStorageUsage', 'daemon_threads': 'daemonThreads', 'flow_file_repository_storage_usage': 'flowFileRepositoryStorageUsage', 'free_heap': 'freeHeap', 'free_heap_bytes': 'freeHeapBytes', 'free_non_heap': 'freeNonHeap', 'free_non_heap_bytes': 'freeNonHeapBytes', 'garbage_collection': 'garbageCollection', 'heap_utilization': 'heapUtilization', 'max_heap': 'maxHeap', 'max_heap_bytes': 'maxHeapBytes', 'max_non_heap': 'maxNonHeap', 'max_non_heap_bytes': 'maxNonHeapBytes', 'non_heap_utilization': 'nonHeapUtilization', 'processor_load_average': 'processorLoadAverage', 'provenance_repository_storage_usage': 'provenanceRepositoryStorageUsage', 'stats_last_refreshed': 'statsLastRefreshed', 'total_heap': 'totalHeap', 'total_heap_bytes': 'totalHeapBytes', 'total_non_heap': 'totalNonHeap', 'total_non_heap_bytes': 'totalNonHeapBytes', 'total_threads': 'totalThreads', 'uptime': 'uptime', 'used_heap': 'usedHeap', 'used_heap_bytes': 'usedHeapBytes', 'used_non_heap': 'usedNonHeap', 'used_non_heap_bytes': 'usedNonHeapBytes', 'version_info': 'versionInfo'}

available_processors

Gets the available_processors of this SystemDiagnosticsSnapshotDTO. Number of available processors if supported by the underlying system.

Returns:The available_processors of this SystemDiagnosticsSnapshotDTO. Return type:int

content_repository_storage_usage

Gets the content_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. The content repository storage usage.

Returns:The content_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. Return type:list[StorageUsageDTO]

daemon_threads

Gets the daemon_threads of this SystemDiagnosticsSnapshotDTO. Number of daemon threads.

Returns:The daemon_threads of this SystemDiagnosticsSnapshotDTO. Return type:int

flow_file_repository_storage_usage

Gets the flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. The flowfile repository storage usage.

Returns:The flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. Return type:StorageUsageDTO

free_heap

Gets the free_heap of this SystemDiagnosticsSnapshotDTO. Amount of free heap.

Returns:The free_heap of this SystemDiagnosticsSnapshotDTO. Return type:str

free_heap_bytes

Gets the free_heap_bytes of this SystemDiagnosticsSnapshotDTO. The number of bytes that are allocated to the JVM heap but not currently being used

Returns:The free_heap_bytes of this SystemDiagnosticsSnapshotDTO. Return type:int

free_non_heap

Gets the free_non_heap of this SystemDiagnosticsSnapshotDTO. Amount of free non heap.

Returns:The free_non_heap of this SystemDiagnosticsSnapshotDTO. Return type:str

free_non_heap_bytes

Gets the free_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. Total number of free non-heap bytes available to the JVM

Returns:The free_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. Return type:int

garbage_collection

Gets the garbage_collection of this SystemDiagnosticsSnapshotDTO. The garbage collection details.

Returns:The garbage_collection of this SystemDiagnosticsSnapshotDTO. Return type:list[GarbageCollectionDTO]

heap_utilization

Gets the heap_utilization of this SystemDiagnosticsSnapshotDTO. Utilization of heap.

Returns:The heap_utilization of this SystemDiagnosticsSnapshotDTO. Return type:str

max_heap

Gets the max_heap of this SystemDiagnosticsSnapshotDTO. Maximum size of heap.

Returns:The max_heap of this SystemDiagnosticsSnapshotDTO. Return type:str

max_heap_bytes

Gets the max_heap_bytes of this SystemDiagnosticsSnapshotDTO. The maximum number of bytes that can be used by the JVM

Returns:The max_heap_bytes of this SystemDiagnosticsSnapshotDTO. Return type:int

max_non_heap

Gets the max_non_heap of this SystemDiagnosticsSnapshotDTO. Maximum size of non heap.

Returns:The max_non_heap of this SystemDiagnosticsSnapshotDTO. Return type:str

max_non_heap_bytes

Gets the max_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. The maximum number of bytes that the JVM can use for non-heap purposes

Returns:The max_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. Return type:int

non_heap_utilization

Gets the non_heap_utilization of this SystemDiagnosticsSnapshotDTO. Utilization of non heap.

Returns:The non_heap_utilization of this SystemDiagnosticsSnapshotDTO. Return type:str

processor_load_average

Gets the processor_load_average of this SystemDiagnosticsSnapshotDTO. The processor load average if supported by the underlying system.

Returns:The processor_load_average of this SystemDiagnosticsSnapshotDTO. Return type:float

provenance_repository_storage_usage

Gets the provenance_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. The provenance repository storage usage.

Returns:The provenance_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. Return type:list[StorageUsageDTO]

stats_last_refreshed

Gets the stats_last_refreshed of this SystemDiagnosticsSnapshotDTO. When the diagnostics were generated.

Returns:The stats_last_refreshed of this SystemDiagnosticsSnapshotDTO. Return type:str

swagger_types = {'available_processors': 'int', 'content_repository_storage_usage': 'list[StorageUsageDTO]', 'daemon_threads': 'int', 'flow_file_repository_storage_usage': 'StorageUsageDTO', 'free_heap': 'str', 'free_heap_bytes': 'int', 'free_non_heap': 'str', 'free_non_heap_bytes': 'int', 'garbage_collection': 'list[GarbageCollectionDTO]', 'heap_utilization': 'str', 'max_heap': 'str', 'max_heap_bytes': 'int', 'max_non_heap': 'str', 'max_non_heap_bytes': 'int', 'non_heap_utilization': 'str', 'processor_load_average': 'float', 'provenance_repository_storage_usage': 'list[StorageUsageDTO]', 'stats_last_refreshed': 'str', 'total_heap': 'str', 'total_heap_bytes': 'int', 'total_non_heap': 'str', 'total_non_heap_bytes': 'int', 'total_threads': 'int', 'uptime': 'str', 'used_heap': 'str', 'used_heap_bytes': 'int', 'used_non_heap': 'str', 'used_non_heap_bytes': 'int', 'version_info': 'VersionInfoDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

total_heap

Gets the total_heap of this SystemDiagnosticsSnapshotDTO. Total size of heap.

Returns:The total_heap of this SystemDiagnosticsSnapshotDTO. Return type:str

total_heap_bytes

Gets the total_heap_bytes of this SystemDiagnosticsSnapshotDTO. The total number of bytes that are available for the JVM heap to use

Returns:The total_heap_bytes of this SystemDiagnosticsSnapshotDTO. Return type:int

total_non_heap

Gets the total_non_heap of this SystemDiagnosticsSnapshotDTO. Total size of non heap.

Returns:The total_non_heap of this SystemDiagnosticsSnapshotDTO. Return type:str

total_non_heap_bytes

Gets the total_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. Total number of bytes allocated to the JVM not used for heap

Returns:The total_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. Return type:int

total_threads

Gets the total_threads of this SystemDiagnosticsSnapshotDTO. Total number of threads.

Returns:The total_threads of this SystemDiagnosticsSnapshotDTO. Return type:int

uptime

Gets the uptime of this SystemDiagnosticsSnapshotDTO. The uptime of the Java virtual machine

Returns:The uptime of this SystemDiagnosticsSnapshotDTO. Return type:str

used_heap

Gets the used_heap of this SystemDiagnosticsSnapshotDTO. Amount of used heap.

Returns:The used_heap of this SystemDiagnosticsSnapshotDTO. Return type:str

used_heap_bytes

Gets the used_heap_bytes of this SystemDiagnosticsSnapshotDTO. The number of bytes of JVM heap that are currently being used

Returns:The used_heap_bytes of this SystemDiagnosticsSnapshotDTO. Return type:int

used_non_heap

Gets the used_non_heap of this SystemDiagnosticsSnapshotDTO. Amount of use non heap.

Returns:The used_non_heap of this SystemDiagnosticsSnapshotDTO. Return type:str

used_non_heap_bytes

Gets the used_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. Total number of bytes used by the JVM not in the heap space

Returns:The used_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. Return type:int

version_info

Gets the version_info of this SystemDiagnosticsSnapshotDTO. The nifi, os, java, and build version information

Returns:The version_info of this SystemDiagnosticsSnapshotDTO. Return type:VersionInfoDTO

nipyapi.nifi.models.template_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.template_dto.TemplateDTO(uri=None, id=None, group_id=None, name=None, description=None, timestamp=None, encoding_version=None, snippet=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

TemplateDTO - a model defined in Swagger

attribute_map = {'description': 'description', 'encoding_version': 'encodingVersion', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'snippet': 'snippet', 'timestamp': 'timestamp', 'uri': 'uri'}

description

Gets the description of this TemplateDTO. The description of the template.

Returns:The description of this TemplateDTO. Return type:str

encoding_version

Gets the encoding_version of this TemplateDTO. The encoding version of this template.

Returns:The encoding_version of this TemplateDTO. Return type:str

group_id

Gets the group_id of this TemplateDTO. The id of the Process Group that the template belongs to.

Returns:The group_id of this TemplateDTO. Return type:str

id

Gets the id of this TemplateDTO. The id of the template.

Returns:The id of this TemplateDTO. Return type:str

name

Gets the name of this TemplateDTO. The name of the template.

Returns:The name of this TemplateDTO. Return type:str

snippet

Gets the snippet of this TemplateDTO. The contents of the template.

Returns:The snippet of this TemplateDTO. Return type:FlowSnippetDTO

swagger_types = {'description': 'str', 'encoding_version': 'str', 'group_id': 'str', 'id': 'str', 'name': 'str', 'snippet': 'FlowSnippetDTO', 'timestamp': 'str', 'uri': 'str'}

timestamp

Gets the timestamp of this TemplateDTO. The timestamp when this template was created.

Returns:The timestamp of this TemplateDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this TemplateDTO. The URI for the template.

Returns:The uri of this TemplateDTO. Return type:str

nipyapi.nifi.models.template_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.template_entity.TemplateEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, template=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

TemplateEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'template': 'template', 'uri': 'uri'}

bulletins

Gets the bulletins of this TemplateEntity. The bulletins for this component.

Returns:The bulletins of this TemplateEntity. Return type:list[BulletinEntity]

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this TemplateEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this TemplateEntity. Return type:bool

id

Gets the id of this TemplateEntity. The id of the component.

Returns:The id of this TemplateEntity. Return type:str

permissions

Gets the permissions of this TemplateEntity. The permissions for this component.

Returns:The permissions of this TemplateEntity. Return type:PermissionsDTO

position

Gets the position of this TemplateEntity. The position of this component in the UI if applicable.

Returns:The position of this TemplateEntity. Return type:PositionDTO

revision

Gets the revision of this TemplateEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this TemplateEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'template': 'TemplateDTO', 'uri': 'str'}

template

Gets the template of this TemplateEntity.

Returns:The template of this TemplateEntity. Return type:TemplateDTO

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this TemplateEntity. The URI for futures requests to the component.

Returns:The uri of this TemplateEntity. Return type:str

nipyapi.nifi.models.templates_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.templates_entity.TemplatesEntity(templates=None, generated=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

TemplatesEntity - a model defined in Swagger

attribute_map = {'generated': 'generated', 'templates': 'templates'}

generated

Gets the generated of this TemplatesEntity. When this content was generated.

Returns:The generated of this TemplatesEntity. Return type:str

swagger_types = {'generated': 'str', 'templates': 'list[TemplateEntity]'}

templates

Gets the templates of this TemplatesEntity.

Returns:The templates of this TemplatesEntity. Return type:list[TemplateEntity]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.tenant_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.tenant_dto.TenantDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, identity=None, configurable=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

TenantDTO - a model defined in Swagger

attribute_map = {'configurable': 'configurable', 'id': 'id', 'identity': 'identity', 'parent_group_id': 'parentGroupId', 'position': 'position', 'versioned_component_id': 'versionedComponentId'}

configurable

Gets the configurable of this TenantDTO. Whether this tenant is configurable.

Returns:The configurable of this TenantDTO. Return type:bool

id

Gets the id of this TenantDTO. The id of the component.

Returns:The id of this TenantDTO. Return type:str

identity

Gets the identity of this TenantDTO. The identity of the tenant.

Returns:The identity of this TenantDTO. Return type:str

parent_group_id

Gets the parent_group_id of this TenantDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this TenantDTO. Return type:str

position

Gets the position of this TenantDTO. The position of this component in the UI if applicable.

Returns:The position of this TenantDTO. Return type:PositionDTO

swagger_types = {'configurable': 'bool', 'id': 'str', 'identity': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_component_id

Gets the versioned_component_id of this TenantDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this TenantDTO. Return type:str

nipyapi.nifi.models.tenant_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.tenant_entity.TenantEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

TenantEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this TenantEntity. The bulletins for this component.

Returns:The bulletins of this TenantEntity. Return type:list[BulletinEntity]

component

Gets the component of this TenantEntity.

Returns:The component of this TenantEntity. Return type:TenantDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this TenantEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this TenantEntity. Return type:bool

id

Gets the id of this TenantEntity. The id of the component.

Returns:The id of this TenantEntity. Return type:str

permissions

Gets the permissions of this TenantEntity. The permissions for this component.

Returns:The permissions of this TenantEntity. Return type:PermissionsDTO

position

Gets the position of this TenantEntity. The position of this component in the UI if applicable.

Returns:The position of this TenantEntity. Return type:PositionDTO

revision

Gets the revision of this TenantEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this TenantEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'TenantDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this TenantEntity. The URI for futures requests to the component.

Returns:The uri of this TenantEntity. Return type:str

nipyapi.nifi.models.tenants_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.tenants_entity.TenantsEntity(users=None, user_groups=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

TenantsEntity - a model defined in Swagger

attribute_map = {'user_groups': 'userGroups', 'users': 'users'}

swagger_types = {'user_groups': 'list[TenantEntity]', 'users': 'list[TenantEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

user_groups

Gets the user_groups of this TenantsEntity.

Returns:The user_groups of this TenantsEntity. Return type:list[TenantEntity]

users

Gets the users of this TenantsEntity.

Returns:The users of this TenantsEntity. Return type:list[TenantEntity]

nipyapi.nifi.models.transaction_result_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.transaction_result_entity.TransactionResultEntity(flow_file_sent=None, response_code=None, message=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

TransactionResultEntity - a model defined in Swagger

attribute_map = {'flow_file_sent': 'flowFileSent', 'message': 'message', 'response_code': 'responseCode'}

flow_file_sent

Gets the flow_file_sent of this TransactionResultEntity.

Returns:The flow_file_sent of this TransactionResultEntity. Return type:int

message

Gets the message of this TransactionResultEntity.

Returns:The message of this TransactionResultEntity. Return type:str

response_code

Gets the response_code of this TransactionResultEntity.

Returns:The response_code of this TransactionResultEntity. Return type:int

swagger_types = {'flow_file_sent': 'int', 'message': 'str', 'response_code': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.update_controller_service_reference_request_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.update_controller_service_reference_request_entity.UpdateControllerServiceReferenceRequestEntity(id=None, state=None, referencing_component_revisions=None, disconnected_node_acknowledged=None, ui_only=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

UpdateControllerServiceReferenceRequestEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'referencing_component_revisions': 'referencingComponentRevisions', 'state': 'state', 'ui_only': 'uiOnly'}

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this UpdateControllerServiceReferenceRequestEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this UpdateControllerServiceReferenceRequestEntity. Return type:bool

id

Gets the id of this UpdateControllerServiceReferenceRequestEntity. The identifier of the Controller Service.

Returns:The id of this UpdateControllerServiceReferenceRequestEntity. Return type:str

referencing_component_revisions

Gets the referencing_component_revisions of this UpdateControllerServiceReferenceRequestEntity. The revisions for all referencing components.

Returns:The referencing_component_revisions of this UpdateControllerServiceReferenceRequestEntity. Return type:dict(str, RevisionDTO)

state

Gets the state of this UpdateControllerServiceReferenceRequestEntity. The new state of the references for the controller service.

Returns:The state of this UpdateControllerServiceReferenceRequestEntity. Return type:str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'id': 'str', 'referencing_component_revisions': 'dict(str, RevisionDTO)', 'state': 'str', 'ui_only': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ui_only

Gets the ui_only of this UpdateControllerServiceReferenceRequestEntity. Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI.

Returns:The ui_only of this UpdateControllerServiceReferenceRequestEntity. Return type:bool

nipyapi.nifi.models.user_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.user_dto.UserDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, identity=None, configurable=None, user_groups=None, access_policies=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

UserDTO - a model defined in Swagger

access_policies

Gets the access_policies of this UserDTO. The access policies this user belongs to.

Returns:The access_policies of this UserDTO. Return type:list[AccessPolicySummaryEntity]

attribute_map = {'access_policies': 'accessPolicies', 'configurable': 'configurable', 'id': 'id', 'identity': 'identity', 'parent_group_id': 'parentGroupId', 'position': 'position', 'user_groups': 'userGroups', 'versioned_component_id': 'versionedComponentId'}

configurable

Gets the configurable of this UserDTO. Whether this tenant is configurable.

Returns:The configurable of this UserDTO. Return type:bool

id

Gets the id of this UserDTO. The id of the component.

Returns:The id of this UserDTO. Return type:str

identity

Gets the identity of this UserDTO. The identity of the tenant.

Returns:The identity of this UserDTO. Return type:str

parent_group_id

Gets the parent_group_id of this UserDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this UserDTO. Return type:str

position

Gets the position of this UserDTO. The position of this component in the UI if applicable.

Returns:The position of this UserDTO. Return type:PositionDTO

swagger_types = {'access_policies': 'list[AccessPolicySummaryEntity]', 'configurable': 'bool', 'id': 'str', 'identity': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'user_groups': 'list[TenantEntity]', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

user_groups

Gets the user_groups of this UserDTO. The groups to which the user belongs. This field is read only and it provided for convenience.

Returns:The user_groups of this UserDTO. Return type:list[TenantEntity]

versioned_component_id

Gets the versioned_component_id of this UserDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this UserDTO. Return type:str

nipyapi.nifi.models.user_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.user_entity.UserEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

UserEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this UserEntity. The bulletins for this component.

Returns:The bulletins of this UserEntity. Return type:list[BulletinEntity]

component

Gets the component of this UserEntity.

Returns:The component of this UserEntity. Return type:UserDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this UserEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this UserEntity. Return type:bool

id

Gets the id of this UserEntity. The id of the component.

Returns:The id of this UserEntity. Return type:str

permissions

Gets the permissions of this UserEntity. The permissions for this component.

Returns:The permissions of this UserEntity. Return type:PermissionsDTO

position

Gets the position of this UserEntity. The position of this component in the UI if applicable.

Returns:The position of this UserEntity. Return type:PositionDTO

revision

Gets the revision of this UserEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this UserEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'UserDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this UserEntity. The URI for futures requests to the component.

Returns:The uri of this UserEntity. Return type:str

nipyapi.nifi.models.user_group_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.user_group_dto.UserGroupDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, identity=None, configurable=None, users=None, access_policies=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

UserGroupDTO - a model defined in Swagger

access_policies

Gets the access_policies of this UserGroupDTO. The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.

Returns:The access_policies of this UserGroupDTO. Return type:list[AccessPolicyEntity]

attribute_map = {'access_policies': 'accessPolicies', 'configurable': 'configurable', 'id': 'id', 'identity': 'identity', 'parent_group_id': 'parentGroupId', 'position': 'position', 'users': 'users', 'versioned_component_id': 'versionedComponentId'}

configurable

Gets the configurable of this UserGroupDTO. Whether this tenant is configurable.

Returns:The configurable of this UserGroupDTO. Return type:bool

id

Gets the id of this UserGroupDTO. The id of the component.

Returns:The id of this UserGroupDTO. Return type:str

identity

Gets the identity of this UserGroupDTO. The identity of the tenant.

Returns:The identity of this UserGroupDTO. Return type:str

parent_group_id

Gets the parent_group_id of this UserGroupDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this UserGroupDTO. Return type:str

position

Gets the position of this UserGroupDTO. The position of this component in the UI if applicable.

Returns:The position of this UserGroupDTO. Return type:PositionDTO

swagger_types = {'access_policies': 'list[AccessPolicyEntity]', 'configurable': 'bool', 'id': 'str', 'identity': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'users': 'list[TenantEntity]', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

users

Gets the users of this UserGroupDTO. The users that belong to the user group.

Returns:The users of this UserGroupDTO. Return type:list[TenantEntity]

versioned_component_id

Gets the versioned_component_id of this UserGroupDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this UserGroupDTO. Return type:str

nipyapi.nifi.models.user_group_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.user_group_entity.UserGroupEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

UserGroupEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this UserGroupEntity. The bulletins for this component.

Returns:The bulletins of this UserGroupEntity. Return type:list[BulletinEntity]

component

Gets the component of this UserGroupEntity.

Returns:The component of this UserGroupEntity. Return type:UserGroupDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this UserGroupEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this UserGroupEntity. Return type:bool

id

Gets the id of this UserGroupEntity. The id of the component.

Returns:The id of this UserGroupEntity. Return type:str

permissions

Gets the permissions of this UserGroupEntity. The permissions for this component.

Returns:The permissions of this UserGroupEntity. Return type:PermissionsDTO

position

Gets the position of this UserGroupEntity. The position of this component in the UI if applicable.

Returns:The position of this UserGroupEntity. Return type:PositionDTO

revision

Gets the revision of this UserGroupEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this UserGroupEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'UserGroupDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this UserGroupEntity. The URI for futures requests to the component.

Returns:The uri of this UserGroupEntity. Return type:str

nipyapi.nifi.models.user_groups_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.user_groups_entity.UserGroupsEntity(user_groups=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

UserGroupsEntity - a model defined in Swagger

attribute_map = {'user_groups': 'userGroups'}

swagger_types = {'user_groups': 'list[UserGroupEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

user_groups

Gets the user_groups of this UserGroupsEntity.

Returns:The user_groups of this UserGroupsEntity. Return type:list[UserGroupEntity]

nipyapi.nifi.models.users_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.users_entity.UsersEntity(generated=None, users=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

UsersEntity - a model defined in Swagger

attribute_map = {'generated': 'generated', 'users': 'users'}

generated

Gets the generated of this UsersEntity. When this content was generated.

Returns:The generated of this UsersEntity. Return type:str

swagger_types = {'generated': 'str', 'users': 'list[UserEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

users

Gets the users of this UsersEntity.

Returns:The users of this UsersEntity. Return type:list[UserEntity]

nipyapi.nifi.models.variable_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_dto.VariableDTO(name=None, value=None, process_group_id=None, affected_components=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VariableDTO - a model defined in Swagger

affected_components

Gets the affected_components of this VariableDTO. A set of all components that will be affected if the value of this variable is changed

Returns:The affected_components of this VariableDTO. Return type:list[AffectedComponentEntity]

attribute_map = {'affected_components': 'affectedComponents', 'name': 'name', 'process_group_id': 'processGroupId', 'value': 'value'}

name

Gets the name of this VariableDTO. The name of the variable

Returns:The name of this VariableDTO. Return type:str

process_group_id

Gets the process_group_id of this VariableDTO. The ID of the Process Group where this Variable is defined

Returns:The process_group_id of this VariableDTO. Return type:str

swagger_types = {'affected_components': 'list[AffectedComponentEntity]', 'name': 'str', 'process_group_id': 'str', 'value': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

value

Gets the value of this VariableDTO. The value of the variable

Returns:The value of this VariableDTO. Return type:str

nipyapi.nifi.models.variable_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_entity.VariableEntity(variable=None, can_write=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VariableEntity - a model defined in Swagger

attribute_map = {'can_write': 'canWrite', 'variable': 'variable'}

can_write

Gets the can_write of this VariableEntity. Indicates whether the user can write a given resource.

Returns:The can_write of this VariableEntity. Return type:bool

swagger_types = {'can_write': 'bool', 'variable': 'VariableDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variable

Gets the variable of this VariableEntity. The variable information

Returns:The variable of this VariableEntity. Return type:VariableDTO

nipyapi.nifi.models.variable_registry_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_registry_dto.VariableRegistryDTO(variables=None, process_group_id=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VariableRegistryDTO - a model defined in Swagger

attribute_map = {'process_group_id': 'processGroupId', 'variables': 'variables'}

process_group_id

Gets the process_group_id of this VariableRegistryDTO. The UUID of the Process Group that this Variable Registry belongs to

Returns:The process_group_id of this VariableRegistryDTO. Return type:str

swagger_types = {'process_group_id': 'str', 'variables': 'list[VariableEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variables

Gets the variables of this VariableRegistryDTO. The variables that are available in this Variable Registry

Returns:The variables of this VariableRegistryDTO. Return type:list[VariableEntity]

nipyapi.nifi.models.variable_registry_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_registry_entity.VariableRegistryEntity(process_group_revision=None, variable_registry=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VariableRegistryEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'variable_registry': 'variableRegistry'}

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this VariableRegistryEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this VariableRegistryEntity. Return type:bool

process_group_revision

Gets the process_group_revision of this VariableRegistryEntity. The revision of the Process Group that the Variable Registry belongs to

Returns:The process_group_revision of this VariableRegistryEntity. Return type:RevisionDTO

swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_revision': 'RevisionDTO', 'variable_registry': 'VariableRegistryDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variable_registry

Gets the variable_registry of this VariableRegistryEntity. The Variable Registry.

Returns:The variable_registry of this VariableRegistryEntity. Return type:VariableRegistryDTO

nipyapi.nifi.models.variable_registry_update_request_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_registry_update_request_dto.VariableRegistryUpdateRequestDTO(request_id=None, uri=None, submission_time=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, update_steps=None, process_group_id=None, affected_components=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VariableRegistryUpdateRequestDTO - a model defined in Swagger

affected_components

Gets the affected_components of this VariableRegistryUpdateRequestDTO. A set of all components that will be affected if the value of this variable is changed

Returns:The affected_components of this VariableRegistryUpdateRequestDTO. Return type:list[AffectedComponentEntity]

attribute_map = {'affected_components': 'affectedComponents', 'complete': 'complete', 'failure_reason': 'failureReason', 'last_updated': 'lastUpdated', 'percent_completed': 'percentCompleted', 'process_group_id': 'processGroupId', 'request_id': 'requestId', 'state': 'state', 'submission_time': 'submissionTime', 'update_steps': 'updateSteps', 'uri': 'uri'}

complete

Gets the complete of this VariableRegistryUpdateRequestDTO. Whether or not the request is completed

Returns:The complete of this VariableRegistryUpdateRequestDTO. Return type:bool

failure_reason

Gets the failure_reason of this VariableRegistryUpdateRequestDTO. The reason for the request failing, or null if the request has not failed

Returns:The failure_reason of this VariableRegistryUpdateRequestDTO. Return type:str

last_updated

Gets the last_updated of this VariableRegistryUpdateRequestDTO. The timestamp of when the request was last updated

Returns:The last_updated of this VariableRegistryUpdateRequestDTO. Return type:datetime

percent_completed

Gets the percent_completed of this VariableRegistryUpdateRequestDTO. A value between 0 and 100 (inclusive) indicating how close the request is to completion

Returns:The percent_completed of this VariableRegistryUpdateRequestDTO. Return type:int

process_group_id

Gets the process_group_id of this VariableRegistryUpdateRequestDTO. The unique ID of the Process Group that the variable registry belongs to

Returns:The process_group_id of this VariableRegistryUpdateRequestDTO. Return type:str

request_id

Gets the request_id of this VariableRegistryUpdateRequestDTO. The ID of the request

Returns:The request_id of this VariableRegistryUpdateRequestDTO. Return type:str

state

Gets the state of this VariableRegistryUpdateRequestDTO. A description of the current state of the request

Returns:The state of this VariableRegistryUpdateRequestDTO. Return type:str

submission_time

Gets the submission_time of this VariableRegistryUpdateRequestDTO. The timestamp of when the request was submitted

Returns:The submission_time of this VariableRegistryUpdateRequestDTO. Return type:datetime

swagger_types = {'affected_components': 'list[AffectedComponentEntity]', 'complete': 'bool', 'failure_reason': 'str', 'last_updated': 'datetime', 'percent_completed': 'int', 'process_group_id': 'str', 'request_id': 'str', 'state': 'str', 'submission_time': 'datetime', 'update_steps': 'list[VariableRegistryUpdateStepDTO]', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

update_steps

Gets the update_steps of this VariableRegistryUpdateRequestDTO. The steps that are required in order to complete the request, along with the status of each

Returns:The update_steps of this VariableRegistryUpdateRequestDTO. Return type:list[VariableRegistryUpdateStepDTO]

uri

Gets the uri of this VariableRegistryUpdateRequestDTO. The URI for the request

Returns:The uri of this VariableRegistryUpdateRequestDTO. Return type:str

nipyapi.nifi.models.variable_registry_update_request_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_registry_update_request_entity.VariableRegistryUpdateRequestEntity(request=None, process_group_revision=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VariableRegistryUpdateRequestEntity - a model defined in Swagger

attribute_map = {'process_group_revision': 'processGroupRevision', 'request': 'request'}

process_group_revision

Gets the process_group_revision of this VariableRegistryUpdateRequestEntity. The revision for the Process Group that owns this variable registry.

Returns:The process_group_revision of this VariableRegistryUpdateRequestEntity. Return type:RevisionDTO

request

Gets the request of this VariableRegistryUpdateRequestEntity. The Variable Registry Update Request

Returns:The request of this VariableRegistryUpdateRequestEntity. Return type:VariableRegistryUpdateRequestDTO

swagger_types = {'process_group_revision': 'RevisionDTO', 'request': 'VariableRegistryUpdateRequestDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.variable_registry_update_step_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_registry_update_step_dto.VariableRegistryUpdateStepDTO(description=None, complete=None, failure_reason=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VariableRegistryUpdateStepDTO - a model defined in Swagger

attribute_map = {'complete': 'complete', 'description': 'description', 'failure_reason': 'failureReason'}

complete

Gets the complete of this VariableRegistryUpdateStepDTO. Whether or not this step has completed

Returns:The complete of this VariableRegistryUpdateStepDTO. Return type:bool

description

Gets the description of this VariableRegistryUpdateStepDTO. Explanation of what happens in this step

Returns:The description of this VariableRegistryUpdateStepDTO. Return type:str

failure_reason

Gets the failure_reason of this VariableRegistryUpdateStepDTO. An explanation of why this step failed, or null if this step did not fail

Returns:The failure_reason of this VariableRegistryUpdateStepDTO. Return type:str

swagger_types = {'complete': 'bool', 'description': 'str', 'failure_reason': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.version_control_component_mapping_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.version_control_component_mapping_entity.VersionControlComponentMappingEntity(version_control_component_mapping=None, process_group_revision=None, disconnected_node_acknowledged=None, version_control_information=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionControlComponentMappingEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'version_control_component_mapping': 'versionControlComponentMapping', 'version_control_information': 'versionControlInformation'}

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this VersionControlComponentMappingEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this VersionControlComponentMappingEntity. Return type:bool

process_group_revision

Gets the process_group_revision of this VersionControlComponentMappingEntity. The revision of the Process Group

Returns:The process_group_revision of this VersionControlComponentMappingEntity. Return type:RevisionDTO

swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_revision': 'RevisionDTO', 'version_control_component_mapping': 'dict(str, str)', 'version_control_information': 'VersionControlInformationDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version_control_component_mapping

Gets the version_control_component_mapping of this VersionControlComponentMappingEntity. The mapping of Versioned Component Identifiers to instance ID’s

Returns:The version_control_component_mapping of this VersionControlComponentMappingEntity. Return type:dict(str, str)

version_control_information

Gets the version_control_information of this VersionControlComponentMappingEntity. The Version Control information

Returns:The version_control_information of this VersionControlComponentMappingEntity. Return type:VersionControlInformationDTO

nipyapi.nifi.models.version_control_information_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.version_control_information_dto.VersionControlInformationDTO(group_id=None, registry_id=None, registry_name=None, bucket_id=None, bucket_name=None, flow_id=None, flow_name=None, flow_description=None, version=None, state=None, state_explanation=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionControlInformationDTO - a model defined in Swagger

attribute_map = {'bucket_id': 'bucketId', 'bucket_name': 'bucketName', 'flow_description': 'flowDescription', 'flow_id': 'flowId', 'flow_name': 'flowName', 'group_id': 'groupId', 'registry_id': 'registryId', 'registry_name': 'registryName', 'state': 'state', 'state_explanation': 'stateExplanation', 'version': 'version'}

bucket_id

Gets the bucket_id of this VersionControlInformationDTO. The ID of the bucket that the flow is stored in

Returns:The bucket_id of this VersionControlInformationDTO. Return type:str

bucket_name

Gets the bucket_name of this VersionControlInformationDTO. The name of the bucket that the flow is stored in

Returns:The bucket_name of this VersionControlInformationDTO. Return type:str

flow_description

Gets the flow_description of this VersionControlInformationDTO. The description of the flow

Returns:The flow_description of this VersionControlInformationDTO. Return type:str

flow_id

Gets the flow_id of this VersionControlInformationDTO. The ID of the flow

Returns:The flow_id of this VersionControlInformationDTO. Return type:str

flow_name

Gets the flow_name of this VersionControlInformationDTO. The name of the flow

Returns:The flow_name of this VersionControlInformationDTO. Return type:str

group_id

Gets the group_id of this VersionControlInformationDTO. The ID of the Process Group that is under version control

Returns:The group_id of this VersionControlInformationDTO. Return type:str

registry_id

Gets the registry_id of this VersionControlInformationDTO. The ID of the registry that the flow is stored in

Returns:The registry_id of this VersionControlInformationDTO. Return type:str

registry_name

Gets the registry_name of this VersionControlInformationDTO. The name of the registry that the flow is stored in

Returns:The registry_name of this VersionControlInformationDTO. Return type:str

state

Gets the state of this VersionControlInformationDTO. The current state of the Process Group, as it relates to the Versioned Flow

Returns:The state of this VersionControlInformationDTO. Return type:str

state_explanation

Gets the state_explanation of this VersionControlInformationDTO. Explanation of why the group is in the specified state

Returns:The state_explanation of this VersionControlInformationDTO. Return type:str

swagger_types = {'bucket_id': 'str', 'bucket_name': 'str', 'flow_description': 'str', 'flow_id': 'str', 'flow_name': 'str', 'group_id': 'str', 'registry_id': 'str', 'registry_name': 'str', 'state': 'str', 'state_explanation': 'str', 'version': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version

Gets the version of this VersionControlInformationDTO. The version of the flow

Returns:The version of this VersionControlInformationDTO. Return type:int

nipyapi.nifi.models.version_control_information_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.version_control_information_entity.VersionControlInformationEntity(process_group_revision=None, disconnected_node_acknowledged=None, version_control_information=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionControlInformationEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'version_control_information': 'versionControlInformation'}

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this VersionControlInformationEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this VersionControlInformationEntity. Return type:bool

process_group_revision

Gets the process_group_revision of this VersionControlInformationEntity. The Revision for the Process Group

Returns:The process_group_revision of this VersionControlInformationEntity. Return type:RevisionDTO

swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_revision': 'RevisionDTO', 'version_control_information': 'VersionControlInformationDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version_control_information

Gets the version_control_information of this VersionControlInformationEntity. The Version Control information

Returns:The version_control_information of this VersionControlInformationEntity. Return type:VersionControlInformationDTO

nipyapi.nifi.models.version_info_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.version_info_dto.VersionInfoDTO(ni_fi_version=None, java_vendor=None, java_version=None, os_name=None, os_version=None, os_architecture=None, build_tag=None, build_revision=None, build_branch=None, build_timestamp=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionInfoDTO - a model defined in Swagger

attribute_map = {'build_branch': 'buildBranch', 'build_revision': 'buildRevision', 'build_tag': 'buildTag', 'build_timestamp': 'buildTimestamp', 'java_vendor': 'javaVendor', 'java_version': 'javaVersion', 'ni_fi_version': 'niFiVersion', 'os_architecture': 'osArchitecture', 'os_name': 'osName', 'os_version': 'osVersion'}

build_branch

Gets the build_branch of this VersionInfoDTO. Build branch

Returns:The build_branch of this VersionInfoDTO. Return type:str

build_revision

Gets the build_revision of this VersionInfoDTO. Build revision or commit hash

Returns:The build_revision of this VersionInfoDTO. Return type:str

build_tag

Gets the build_tag of this VersionInfoDTO. Build tag

Returns:The build_tag of this VersionInfoDTO. Return type:str

build_timestamp

Gets the build_timestamp of this VersionInfoDTO. Build timestamp

Returns:The build_timestamp of this VersionInfoDTO. Return type:datetime

java_vendor

Gets the java_vendor of this VersionInfoDTO. Java JVM vendor

Returns:The java_vendor of this VersionInfoDTO. Return type:str

java_version

Gets the java_version of this VersionInfoDTO. Java version

Returns:The java_version of this VersionInfoDTO. Return type:str

ni_fi_version

Gets the ni_fi_version of this VersionInfoDTO. The version of this NiFi.

Returns:The ni_fi_version of this VersionInfoDTO. Return type:str

os_architecture

Gets the os_architecture of this VersionInfoDTO. Host operating system architecture

Returns:The os_architecture of this VersionInfoDTO. Return type:str

os_name

Gets the os_name of this VersionInfoDTO. Host operating system name

Returns:The os_name of this VersionInfoDTO. Return type:str

os_version

Gets the os_version of this VersionInfoDTO. Host operating system version

Returns:The os_version of this VersionInfoDTO. Return type:str

swagger_types = {'build_branch': 'str', 'build_revision': 'str', 'build_tag': 'str', 'build_timestamp': 'datetime', 'java_vendor': 'str', 'java_version': 'str', 'ni_fi_version': 'str', 'os_architecture': 'str', 'os_name': 'str', 'os_version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.versioned_connection 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_connection.VersionedConnection(identifier=None, instance_identifier=None, name=None, comments=None, position=None, source=None, destination=None, label_index=None, z_index=None, selected_relationships=None, back_pressure_object_threshold=None, back_pressure_data_size_threshold=None, flow_file_expiration=None, prioritizers=None, bends=None, load_balance_strategy=None, partitioning_attribute=None, load_balance_compression=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedConnection - a model defined in Swagger

attribute_map = {'back_pressure_data_size_threshold': 'backPressureDataSizeThreshold', 'back_pressure_object_threshold': 'backPressureObjectThreshold', 'bends': 'bends', 'comments': 'comments', 'component_type': 'componentType', 'destination': 'destination', 'flow_file_expiration': 'flowFileExpiration', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'label_index': 'labelIndex', 'load_balance_compression': 'loadBalanceCompression', 'load_balance_strategy': 'loadBalanceStrategy', 'name': 'name', 'partitioning_attribute': 'partitioningAttribute', 'position': 'position', 'prioritizers': 'prioritizers', 'selected_relationships': 'selectedRelationships', 'source': 'source', 'z_index': 'zIndex'}

back_pressure_data_size_threshold

Gets the back_pressure_data_size_threshold of this VersionedConnection. The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won’t impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.

Returns:The back_pressure_data_size_threshold of this VersionedConnection. Return type:str

back_pressure_object_threshold

Gets the back_pressure_object_threshold of this VersionedConnection. The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won’t impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.

Returns:The back_pressure_object_threshold of this VersionedConnection. Return type:int

bends

Gets the bends of this VersionedConnection. The bend points on the connection.

Returns:The bends of this VersionedConnection. Return type:list[Position]

comments

Gets the comments of this VersionedConnection. The user-supplied comments for the component

Returns:The comments of this VersionedConnection. Return type:str

component_type

Gets the component_type of this VersionedConnection.

Returns:The component_type of this VersionedConnection. Return type:str

destination

Gets the destination of this VersionedConnection. The destination of the connection.

Returns:The destination of this VersionedConnection. Return type:ConnectableComponent

flow_file_expiration

Gets the flow_file_expiration of this VersionedConnection. The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it.

Returns:The flow_file_expiration of this VersionedConnection. Return type:str

group_identifier

Gets the group_identifier of this VersionedConnection. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedConnection. Return type:str

identifier

Gets the identifier of this VersionedConnection. The component’s unique identifier

Returns:The identifier of this VersionedConnection. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedConnection. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedConnection. Return type:str

label_index

Gets the label_index of this VersionedConnection. The index of the bend point where to place the connection label.

Returns:The label_index of this VersionedConnection. Return type:int

load_balance_compression

Gets the load_balance_compression of this VersionedConnection. Whether or not compression should be used when transferring FlowFiles between nodes

Returns:The load_balance_compression of this VersionedConnection. Return type:str

load_balance_strategy

Gets the load_balance_strategy of this VersionedConnection. The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.

Returns:The load_balance_strategy of this VersionedConnection. Return type:str

name

Gets the name of this VersionedConnection. The component’s name

Returns:The name of this VersionedConnection. Return type:str

partitioning_attribute

Gets the partitioning_attribute of this VersionedConnection. The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect.

Returns:The partitioning_attribute of this VersionedConnection. Return type:str

position

Gets the position of this VersionedConnection. The component’s position on the graph

Returns:The position of this VersionedConnection. Return type:Position

prioritizers

Gets the prioritizers of this VersionedConnection. The comparators used to prioritize the queue.

Returns:The prioritizers of this VersionedConnection. Return type:list[str]

selected_relationships

Gets the selected_relationships of this VersionedConnection. The selected relationship that comprise the connection.

Returns:The selected_relationships of this VersionedConnection. Return type:list[str]

source

Gets the source of this VersionedConnection. The source of the connection.

Returns:The source of this VersionedConnection. Return type:ConnectableComponent

swagger_types = {'back_pressure_data_size_threshold': 'str', 'back_pressure_object_threshold': 'int', 'bends': 'list[Position]', 'comments': 'str', 'component_type': 'str', 'destination': 'ConnectableComponent', 'flow_file_expiration': 'str', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'label_index': 'int', 'load_balance_compression': 'str', 'load_balance_strategy': 'str', 'name': 'str', 'partitioning_attribute': 'str', 'position': 'Position', 'prioritizers': 'list[str]', 'selected_relationships': 'list[str]', 'source': 'ConnectableComponent', 'z_index': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

z_index

Gets the z_index of this VersionedConnection. The z index of the connection.

Returns:The z_index of this VersionedConnection. Return type:int

nipyapi.nifi.models.versioned_controller_service 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_controller_service.VersionedControllerService(identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, bundle=None, properties=None, property_descriptors=None, controller_service_apis=None, annotation_data=None, scheduled_state=None, bulletin_level=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedControllerService - a model defined in Swagger

annotation_data

Gets the annotation_data of this VersionedControllerService. The annotation for the controller service. This is how the custom UI relays configuration to the controller service.

Returns:The annotation_data of this VersionedControllerService. Return type:str

attribute_map = {'annotation_data': 'annotationData', 'bulletin_level': 'bulletinLevel', 'bundle': 'bundle', 'comments': 'comments', 'component_type': 'componentType', 'controller_service_apis': 'controllerServiceApis', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position', 'properties': 'properties', 'property_descriptors': 'propertyDescriptors', 'scheduled_state': 'scheduledState', 'type': 'type'}

bulletin_level

Gets the bulletin_level of this VersionedControllerService. The level at which the controller service will report bulletins.

Returns:The bulletin_level of this VersionedControllerService. Return type:str

bundle

Gets the bundle of this VersionedControllerService. Information about the bundle from which the component came

Returns:The bundle of this VersionedControllerService. Return type:Bundle

comments

Gets the comments of this VersionedControllerService. The user-supplied comments for the component

Returns:The comments of this VersionedControllerService. Return type:str

component_type

Gets the component_type of this VersionedControllerService.

Returns:The component_type of this VersionedControllerService. Return type:str

controller_service_apis

Gets the controller_service_apis of this VersionedControllerService. Lists the APIs this Controller Service implements.

Returns:The controller_service_apis of this VersionedControllerService. Return type:list[ControllerServiceAPI]

group_identifier

Gets the group_identifier of this VersionedControllerService. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedControllerService. Return type:str

identifier

Gets the identifier of this VersionedControllerService. The component’s unique identifier

Returns:The identifier of this VersionedControllerService. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedControllerService. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedControllerService. Return type:str

name

Gets the name of this VersionedControllerService. The component’s name

Returns:The name of this VersionedControllerService. Return type:str

position

Gets the position of this VersionedControllerService. The component’s position on the graph

Returns:The position of this VersionedControllerService. Return type:Position

properties

Gets the properties of this VersionedControllerService. The properties for the component. Properties whose value is not set will only contain the property name.

Returns:The properties of this VersionedControllerService. Return type:dict(str, str)

property_descriptors

Gets the property_descriptors of this VersionedControllerService. The property descriptors for the component.

Returns:The property_descriptors of this VersionedControllerService. Return type:dict(str, VersionedPropertyDescriptor)

scheduled_state

Gets the scheduled_state of this VersionedControllerService. The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED

Returns:The scheduled_state of this VersionedControllerService. Return type:str

swagger_types = {'annotation_data': 'str', 'bulletin_level': 'str', 'bundle': 'Bundle', 'comments': 'str', 'component_type': 'str', 'controller_service_apis': 'list[ControllerServiceAPI]', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position', 'properties': 'dict(str, str)', 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', 'scheduled_state': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this VersionedControllerService. The type of the extension component

Returns:The type of this VersionedControllerService. Return type:str

nipyapi.nifi.models.versioned_flow 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow.VersionedFlow(link=None, identifier=None, name=None, description=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, modified_timestamp=None, type=None, permissions=None, version_count=None, revision=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlow - a model defined in Swagger

attribute_map = {'bucket_identifier': 'bucketIdentifier', 'bucket_name': 'bucketName', 'created_timestamp': 'createdTimestamp', 'description': 'description', 'identifier': 'identifier', 'link': 'link', 'modified_timestamp': 'modifiedTimestamp', 'name': 'name', 'permissions': 'permissions', 'revision': 'revision', 'type': 'type', 'version_count': 'versionCount'}

bucket_identifier

Gets the bucket_identifier of this VersionedFlow. The identifier of the bucket this items belongs to. This cannot be changed after the item is created.

Returns:The bucket_identifier of this VersionedFlow. Return type:str

bucket_name

Gets the bucket_name of this VersionedFlow. The name of the bucket this items belongs to.

Returns:The bucket_name of this VersionedFlow. Return type:str

created_timestamp

Gets the created_timestamp of this VersionedFlow. The timestamp of when the item was created, as milliseconds since epoch.

Returns:The created_timestamp of this VersionedFlow. Return type:int

description

Gets the description of this VersionedFlow. A description of the item.

Returns:The description of this VersionedFlow. Return type:str

identifier

Gets the identifier of this VersionedFlow. An ID to uniquely identify this object.

Returns:The identifier of this VersionedFlow. Return type:str

link

Gets the link of this VersionedFlow. An WebLink to this entity.

Returns:The link of this VersionedFlow. Return type:JaxbLink

modified_timestamp

Gets the modified_timestamp of this VersionedFlow. The timestamp of when the item was last modified, as milliseconds since epoch.

Returns:The modified_timestamp of this VersionedFlow. Return type:int

name

Gets the name of this VersionedFlow. The name of the item.

Returns:The name of this VersionedFlow. Return type:str

permissions

Gets the permissions of this VersionedFlow. The access that the current user has to the bucket containing this item.

Returns:The permissions of this VersionedFlow. Return type:Permissions

revision

Gets the revision of this VersionedFlow. The revision of this entity used for optimistic-locking during updates.

Returns:The revision of this VersionedFlow. Return type:RevisionInfo

swagger_types = {'bucket_identifier': 'str', 'bucket_name': 'str', 'created_timestamp': 'int', 'description': 'str', 'identifier': 'str', 'link': 'JaxbLink', 'modified_timestamp': 'int', 'name': 'str', 'permissions': 'Permissions', 'revision': 'RevisionInfo', 'type': 'str', 'version_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this VersionedFlow. The type of item.

Returns:The type of this VersionedFlow. Return type:str

version_count

Gets the version_count of this VersionedFlow. The number of versions of this flow.

Returns:The version_count of this VersionedFlow. Return type:int

nipyapi.nifi.models.versioned_flow_coordinates 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_coordinates.VersionedFlowCoordinates(registry_url=None, bucket_id=None, flow_id=None, version=None, latest=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlowCoordinates - a model defined in Swagger

attribute_map = {'bucket_id': 'bucketId', 'flow_id': 'flowId', 'latest': 'latest', 'registry_url': 'registryUrl', 'version': 'version'}

bucket_id

Gets the bucket_id of this VersionedFlowCoordinates. The UUID of the bucket that the flow resides in

Returns:The bucket_id of this VersionedFlowCoordinates. Return type:str

flow_id

Gets the flow_id of this VersionedFlowCoordinates. The UUID of the flow

Returns:The flow_id of this VersionedFlowCoordinates. Return type:str

latest

Gets the latest of this VersionedFlowCoordinates. Whether or not these coordinates point to the latest version of the flow

Returns:The latest of this VersionedFlowCoordinates. Return type:bool

registry_url

Gets the registry_url of this VersionedFlowCoordinates. The URL of the Flow Registry that contains the flow

Returns:The registry_url of this VersionedFlowCoordinates. Return type:str

swagger_types = {'bucket_id': 'str', 'flow_id': 'str', 'latest': 'bool', 'registry_url': 'str', 'version': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version

Gets the version of this VersionedFlowCoordinates. The version of the flow

Returns:The version of this VersionedFlowCoordinates. Return type:int

nipyapi.nifi.models.versioned_flow_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_dto.VersionedFlowDTO(registry_id=None, bucket_id=None, flow_id=None, flow_name=None, description=None, comments=None, action=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlowDTO - a model defined in Swagger

action

Gets the action of this VersionedFlowDTO. The action being performed

Returns:The action of this VersionedFlowDTO. Return type:str

attribute_map = {'action': 'action', 'bucket_id': 'bucketId', 'comments': 'comments', 'description': 'description', 'flow_id': 'flowId', 'flow_name': 'flowName', 'registry_id': 'registryId'}

bucket_id

Gets the bucket_id of this VersionedFlowDTO. The ID of the bucket where the flow is stored

Returns:The bucket_id of this VersionedFlowDTO. Return type:str

comments

Gets the comments of this VersionedFlowDTO. Comments for the changeset

Returns:The comments of this VersionedFlowDTO. Return type:str

description

Gets the description of this VersionedFlowDTO. A description of the flow

Returns:The description of this VersionedFlowDTO. Return type:str

flow_id

Gets the flow_id of this VersionedFlowDTO. The ID of the flow

Returns:The flow_id of this VersionedFlowDTO. Return type:str

flow_name

Gets the flow_name of this VersionedFlowDTO. The name of the flow

Returns:The flow_name of this VersionedFlowDTO. Return type:str

registry_id

Gets the registry_id of this VersionedFlowDTO. The ID of the registry that the flow is tracked to

Returns:The registry_id of this VersionedFlowDTO. Return type:str

swagger_types = {'action': 'str', 'bucket_id': 'str', 'comments': 'str', 'description': 'str', 'flow_id': 'str', 'flow_name': 'str', 'registry_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.versioned_flow_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_entity.VersionedFlowEntity(versioned_flow=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlowEntity - a model defined in Swagger

attribute_map = {'versioned_flow': 'versionedFlow'}

swagger_types = {'versioned_flow': 'VersionedFlowDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_flow

Gets the versioned_flow of this VersionedFlowEntity. The versioned flow

Returns:The versioned_flow of this VersionedFlowEntity. Return type:VersionedFlowDTO

nipyapi.nifi.models.versioned_flow_snapshot 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_snapshot.VersionedFlowSnapshot(snapshot_metadata=None, flow_contents=None, external_controller_services=None, parameter_contexts=None, flow_encoding_version=None, flow=None, bucket=None, latest=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlowSnapshot - a model defined in Swagger

attribute_map = {'bucket': 'bucket', 'external_controller_services': 'externalControllerServices', 'flow': 'flow', 'flow_contents': 'flowContents', 'flow_encoding_version': 'flowEncodingVersion', 'latest': 'latest', 'parameter_contexts': 'parameterContexts', 'snapshot_metadata': 'snapshotMetadata'}

bucket

Gets the bucket of this VersionedFlowSnapshot. The bucket where the flow is located

Returns:The bucket of this VersionedFlowSnapshot. Return type:Bucket

external_controller_services

Gets the external_controller_services of this VersionedFlowSnapshot. The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.

Returns:The external_controller_services of this VersionedFlowSnapshot. Return type:dict(str, ExternalControllerServiceReference)

flow

Gets the flow of this VersionedFlowSnapshot. The flow this snapshot is for

Returns:The flow of this VersionedFlowSnapshot. Return type:VersionedFlow

flow_contents

Gets the flow_contents of this VersionedFlowSnapshot. The contents of the versioned flow

Returns:The flow_contents of this VersionedFlowSnapshot. Return type:VersionedProcessGroup

flow_encoding_version

Gets the flow_encoding_version of this VersionedFlowSnapshot. The optional encoding version of the flow contents.

Returns:The flow_encoding_version of this VersionedFlowSnapshot. Return type:str

latest

Gets the latest of this VersionedFlowSnapshot.

Returns:The latest of this VersionedFlowSnapshot. Return type:bool

parameter_contexts

Gets the parameter_contexts of this VersionedFlowSnapshot. The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.

Returns:The parameter_contexts of this VersionedFlowSnapshot. Return type:dict(str, VersionedParameterContext)

snapshot_metadata

Gets the snapshot_metadata of this VersionedFlowSnapshot. The metadata for this snapshot

Returns:The snapshot_metadata of this VersionedFlowSnapshot. Return type:VersionedFlowSnapshotMetadata

swagger_types = {'bucket': 'Bucket', 'external_controller_services': 'dict(str, ExternalControllerServiceReference)', 'flow': 'VersionedFlow', 'flow_contents': 'VersionedProcessGroup', 'flow_encoding_version': 'str', 'latest': 'bool', 'parameter_contexts': 'dict(str, VersionedParameterContext)', 'snapshot_metadata': 'VersionedFlowSnapshotMetadata'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.versioned_flow_snapshot_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_snapshot_entity.VersionedFlowSnapshotEntity(versioned_flow_snapshot=None, process_group_revision=None, registry_id=None, update_descendant_versioned_flows=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlowSnapshotEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'registry_id': 'registryId', 'update_descendant_versioned_flows': 'updateDescendantVersionedFlows', 'versioned_flow_snapshot': 'versionedFlowSnapshot'}

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this VersionedFlowSnapshotEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this VersionedFlowSnapshotEntity. Return type:bool

process_group_revision

Gets the process_group_revision of this VersionedFlowSnapshotEntity. The Revision of the Process Group under Version Control

Returns:The process_group_revision of this VersionedFlowSnapshotEntity. Return type:RevisionDTO

registry_id

Gets the registry_id of this VersionedFlowSnapshotEntity. The ID of the Registry that this flow belongs to

Returns:The registry_id of this VersionedFlowSnapshotEntity. Return type:str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_revision': 'RevisionDTO', 'registry_id': 'str', 'update_descendant_versioned_flows': 'bool', 'versioned_flow_snapshot': 'VersionedFlowSnapshot'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

update_descendant_versioned_flows

Gets the update_descendant_versioned_flows of this VersionedFlowSnapshotEntity. If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated.

Returns:The update_descendant_versioned_flows of this VersionedFlowSnapshotEntity. Return type:bool

versioned_flow_snapshot

Gets the versioned_flow_snapshot of this VersionedFlowSnapshotEntity. The versioned flow snapshot

Returns:The versioned_flow_snapshot of this VersionedFlowSnapshotEntity. Return type:VersionedFlowSnapshot

nipyapi.nifi.models.versioned_flow_snapshot_metadata_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_snapshot_metadata_entity.VersionedFlowSnapshotMetadataEntity(versioned_flow_snapshot_metadata=None, registry_id=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlowSnapshotMetadataEntity - a model defined in Swagger

attribute_map = {'registry_id': 'registryId', 'versioned_flow_snapshot_metadata': 'versionedFlowSnapshotMetadata'}

registry_id

Gets the registry_id of this VersionedFlowSnapshotMetadataEntity. The ID of the Registry that this flow belongs to

Returns:The registry_id of this VersionedFlowSnapshotMetadataEntity. Return type:str

swagger_types = {'registry_id': 'str', 'versioned_flow_snapshot_metadata': 'VersionedFlowSnapshotMetadata'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_flow_snapshot_metadata

Gets the versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity. The collection of versioned flow snapshot metadata

Returns:The versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity. Return type:VersionedFlowSnapshotMetadata

nipyapi.nifi.models.versioned_flow_snapshot_metadata_set_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_snapshot_metadata_set_entity.VersionedFlowSnapshotMetadataSetEntity(versioned_flow_snapshot_metadata_set=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlowSnapshotMetadataSetEntity - a model defined in Swagger

attribute_map = {'versioned_flow_snapshot_metadata_set': 'versionedFlowSnapshotMetadataSet'}

swagger_types = {'versioned_flow_snapshot_metadata_set': 'list[VersionedFlowSnapshotMetadataEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_flow_snapshot_metadata_set

Gets the versioned_flow_snapshot_metadata_set of this VersionedFlowSnapshotMetadataSetEntity.

Returns:The versioned_flow_snapshot_metadata_set of this VersionedFlowSnapshotMetadataSetEntity. Return type:list[VersionedFlowSnapshotMetadataEntity]

nipyapi.nifi.models.versioned_flow_update_request_dto 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_update_request_dto.VersionedFlowUpdateRequestDTO(request_id=None, process_group_id=None, uri=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, version_control_information=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlowUpdateRequestDTO - a model defined in Swagger

attribute_map = {'complete': 'complete', 'failure_reason': 'failureReason', 'last_updated': 'lastUpdated', 'percent_completed': 'percentCompleted', 'process_group_id': 'processGroupId', 'request_id': 'requestId', 'state': 'state', 'uri': 'uri', 'version_control_information': 'versionControlInformation'}

complete

Gets the complete of this VersionedFlowUpdateRequestDTO. Whether or not this request has completed

Returns:The complete of this VersionedFlowUpdateRequestDTO. Return type:bool

failure_reason

Gets the failure_reason of this VersionedFlowUpdateRequestDTO. An explanation of why this request failed, or null if this request has not failed

Returns:The failure_reason of this VersionedFlowUpdateRequestDTO. Return type:str

last_updated

Gets the last_updated of this VersionedFlowUpdateRequestDTO. The last time this request was updated.

Returns:The last_updated of this VersionedFlowUpdateRequestDTO. Return type:str

percent_completed

Gets the percent_completed of this VersionedFlowUpdateRequestDTO. The percentage complete for the request, between 0 and 100

Returns:The percent_completed of this VersionedFlowUpdateRequestDTO. Return type:int

process_group_id

Gets the process_group_id of this VersionedFlowUpdateRequestDTO. The unique ID of the Process Group being updated

Returns:The process_group_id of this VersionedFlowUpdateRequestDTO. Return type:str

request_id

Gets the request_id of this VersionedFlowUpdateRequestDTO. The unique ID of this request.

Returns:The request_id of this VersionedFlowUpdateRequestDTO. Return type:str

state

Gets the state of this VersionedFlowUpdateRequestDTO. The state of the request

Returns:The state of this VersionedFlowUpdateRequestDTO. Return type:str

swagger_types = {'complete': 'bool', 'failure_reason': 'str', 'last_updated': 'str', 'percent_completed': 'int', 'process_group_id': 'str', 'request_id': 'str', 'state': 'str', 'uri': 'str', 'version_control_information': 'VersionControlInformationDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this VersionedFlowUpdateRequestDTO. The URI for future requests to this drop request.

Returns:The uri of this VersionedFlowUpdateRequestDTO. Return type:str

version_control_information

Gets the version_control_information of this VersionedFlowUpdateRequestDTO. The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.

Returns:The version_control_information of this VersionedFlowUpdateRequestDTO. Return type:VersionControlInformationDTO

nipyapi.nifi.models.versioned_flow_update_request_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_update_request_entity.VersionedFlowUpdateRequestEntity(process_group_revision=None, request=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlowUpdateRequestEntity - a model defined in Swagger

attribute_map = {'process_group_revision': 'processGroupRevision', 'request': 'request'}

process_group_revision

Gets the process_group_revision of this VersionedFlowUpdateRequestEntity. The revision for the Process Group being updated.

Returns:The process_group_revision of this VersionedFlowUpdateRequestEntity. Return type:RevisionDTO

request

Gets the request of this VersionedFlowUpdateRequestEntity. The Flow Update Request

Returns:The request of this VersionedFlowUpdateRequestEntity. Return type:VersionedFlowUpdateRequestDTO

swagger_types = {'process_group_revision': 'RevisionDTO', 'request': 'VersionedFlowUpdateRequestDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.versioned_flows_entity 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flows_entity.VersionedFlowsEntity(versioned_flows=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlowsEntity - a model defined in Swagger

attribute_map = {'versioned_flows': 'versionedFlows'}

swagger_types = {'versioned_flows': 'list[VersionedFlowEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_flows

Gets the versioned_flows of this VersionedFlowsEntity.

Returns:The versioned_flows of this VersionedFlowsEntity. Return type:list[VersionedFlowEntity]

nipyapi.nifi.models.versioned_funnel 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_funnel.VersionedFunnel(identifier=None, instance_identifier=None, name=None, comments=None, position=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFunnel - a model defined in Swagger

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position'}

comments

Gets the comments of this VersionedFunnel. The user-supplied comments for the component

Returns:The comments of this VersionedFunnel. Return type:str

component_type

Gets the component_type of this VersionedFunnel.

Returns:The component_type of this VersionedFunnel. Return type:str

group_identifier

Gets the group_identifier of this VersionedFunnel. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedFunnel. Return type:str

identifier

Gets the identifier of this VersionedFunnel. The component’s unique identifier

Returns:The identifier of this VersionedFunnel. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedFunnel. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedFunnel. Return type:str

name

Gets the name of this VersionedFunnel. The component’s name

Returns:The name of this VersionedFunnel. Return type:str

position

Gets the position of this VersionedFunnel. The component’s position on the graph

Returns:The position of this VersionedFunnel. Return type:Position

swagger_types = {'comments': 'str', 'component_type': 'str', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.versioned_label 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_label.VersionedLabel(identifier=None, instance_identifier=None, name=None, comments=None, position=None, label=None, z_index=None, width=None, height=None, style=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedLabel - a model defined in Swagger

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'height': 'height', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'label': 'label', 'name': 'name', 'position': 'position', 'style': 'style', 'width': 'width', 'z_index': 'zIndex'}

comments

Gets the comments of this VersionedLabel. The user-supplied comments for the component

Returns:The comments of this VersionedLabel. Return type:str

component_type

Gets the component_type of this VersionedLabel.

Returns:The component_type of this VersionedLabel. Return type:str

group_identifier

Gets the group_identifier of this VersionedLabel. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedLabel. Return type:str

height

Gets the height of this VersionedLabel. The height of the label in pixels when at a 1:1 scale.

Returns:The height of this VersionedLabel. Return type:float

identifier

Gets the identifier of this VersionedLabel. The component’s unique identifier

Returns:The identifier of this VersionedLabel. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedLabel. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedLabel. Return type:str

label

Gets the label of this VersionedLabel. The text that appears in the label.

Returns:The label of this VersionedLabel. Return type:str

name

Gets the name of this VersionedLabel. The component’s name

Returns:The name of this VersionedLabel. Return type:str

position

Gets the position of this VersionedLabel. The component’s position on the graph

Returns:The position of this VersionedLabel. Return type:Position

style

Gets the style of this VersionedLabel. The styles for this label (font-size : 12px, background-color : #eee, etc).

Returns:The style of this VersionedLabel. Return type:dict(str, str)

swagger_types = {'comments': 'str', 'component_type': 'str', 'group_identifier': 'str', 'height': 'float', 'identifier': 'str', 'instance_identifier': 'str', 'label': 'str', 'name': 'str', 'position': 'Position', 'style': 'dict(str, str)', 'width': 'float', 'z_index': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

width

Gets the width of this VersionedLabel. The width of the label in pixels when at a 1:1 scale.

Returns:The width of this VersionedLabel. Return type:float

z_index

Gets the z_index of this VersionedLabel. The z index of the connection.

Returns:The z_index of this VersionedLabel. Return type:int

nipyapi.nifi.models.versioned_port 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_port.VersionedPort(identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, concurrently_schedulable_task_count=None, scheduled_state=None, allow_remote_access=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedPort - a model defined in Swagger

allow_remote_access

Gets the allow_remote_access of this VersionedPort. Whether or not this port allows remote access for site-to-site

Returns:The allow_remote_access of this VersionedPort. Return type:bool

attribute_map = {'allow_remote_access': 'allowRemoteAccess', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position', 'scheduled_state': 'scheduledState', 'type': 'type'}

comments

Gets the comments of this VersionedPort. The user-supplied comments for the component

Returns:The comments of this VersionedPort. Return type:str

component_type

Gets the component_type of this VersionedPort.

Returns:The component_type of this VersionedPort. Return type:str

concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this VersionedPort. The number of tasks that should be concurrently scheduled for the port.

Returns:The concurrently_schedulable_task_count of this VersionedPort. Return type:int

group_identifier

Gets the group_identifier of this VersionedPort. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedPort. Return type:str

identifier

Gets the identifier of this VersionedPort. The component’s unique identifier

Returns:The identifier of this VersionedPort. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedPort. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedPort. Return type:str

name

Gets the name of this VersionedPort. The component’s name

Returns:The name of this VersionedPort. Return type:str

position

Gets the position of this VersionedPort. The component’s position on the graph

Returns:The position of this VersionedPort. Return type:Position

scheduled_state

Gets the scheduled_state of this VersionedPort. The scheduled state of the component

Returns:The scheduled_state of this VersionedPort. Return type:str

swagger_types = {'allow_remote_access': 'bool', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position', 'scheduled_state': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this VersionedPort. The type of port.

Returns:The type of this VersionedPort. Return type:str

nipyapi.nifi.models.versioned_process_group 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_process_group.VersionedProcessGroup(identifier=None, instance_identifier=None, name=None, comments=None, position=None, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None, controller_services=None, versioned_flow_coordinates=None, variables=None, parameter_context_name=None, default_flow_file_expiration=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None, component_type=None, flow_file_concurrency=None, flow_file_outbound_policy=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedProcessGroup - a model defined in Swagger

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'connections': 'connections', 'controller_services': 'controllerServices', 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', 'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', 'default_flow_file_expiration': 'defaultFlowFileExpiration', 'flow_file_concurrency': 'flowFileConcurrency', 'flow_file_outbound_policy': 'flowFileOutboundPolicy', 'funnels': 'funnels', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'input_ports': 'inputPorts', 'instance_identifier': 'instanceIdentifier', 'labels': 'labels', 'name': 'name', 'output_ports': 'outputPorts', 'parameter_context_name': 'parameterContextName', 'position': 'position', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups', 'variables': 'variables', 'versioned_flow_coordinates': 'versionedFlowCoordinates'}

comments

Gets the comments of this VersionedProcessGroup. The user-supplied comments for the component

Returns:The comments of this VersionedProcessGroup. Return type:str

component_type

Gets the component_type of this VersionedProcessGroup.

Returns:The component_type of this VersionedProcessGroup. Return type:str

connections

Gets the connections of this VersionedProcessGroup. The Connections

Returns:The connections of this VersionedProcessGroup. Return type:list[VersionedConnection]

controller_services

Gets the controller_services of this VersionedProcessGroup. The Controller Services

Returns:The controller_services of this VersionedProcessGroup. Return type:list[VersionedControllerService]

default_back_pressure_data_size_threshold

Gets the default_back_pressure_data_size_threshold of this VersionedProcessGroup. Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied.

Returns:The default_back_pressure_data_size_threshold of this VersionedProcessGroup. Return type:str

default_back_pressure_object_threshold

Gets the default_back_pressure_object_threshold of this VersionedProcessGroup. Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied.

Returns:The default_back_pressure_object_threshold of this VersionedProcessGroup. Return type:int

default_flow_file_expiration

Gets the default_flow_file_expiration of this VersionedProcessGroup. The default FlowFile Expiration for this Process Group.

Returns:The default_flow_file_expiration of this VersionedProcessGroup. Return type:str

flow_file_concurrency

Gets the flow_file_concurrency of this VersionedProcessGroup. The configured FlowFile Concurrency for the Process Group

Returns:The flow_file_concurrency of this VersionedProcessGroup. Return type:str

flow_file_outbound_policy

Gets the flow_file_outbound_policy of this VersionedProcessGroup. The FlowFile Outbound Policy for the Process Group

Returns:The flow_file_outbound_policy of this VersionedProcessGroup. Return type:str

funnels

Gets the funnels of this VersionedProcessGroup. The Funnels

Returns:The funnels of this VersionedProcessGroup. Return type:list[VersionedFunnel]

group_identifier

Gets the group_identifier of this VersionedProcessGroup. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedProcessGroup. Return type:str

identifier

Gets the identifier of this VersionedProcessGroup. The component’s unique identifier

Returns:The identifier of this VersionedProcessGroup. Return type:str

input_ports

Gets the input_ports of this VersionedProcessGroup. The Input Ports

Returns:The input_ports of this VersionedProcessGroup. Return type:list[VersionedPort]

instance_identifier

Gets the instance_identifier of this VersionedProcessGroup. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedProcessGroup. Return type:str

labels

Gets the labels of this VersionedProcessGroup. The Labels

Returns:The labels of this VersionedProcessGroup. Return type:list[VersionedLabel]

name

Gets the name of this VersionedProcessGroup. The component’s name

Returns:The name of this VersionedProcessGroup. Return type:str

output_ports

Gets the output_ports of this VersionedProcessGroup. The Output Ports

Returns:The output_ports of this VersionedProcessGroup. Return type:list[VersionedPort]

parameter_context_name

Gets the parameter_context_name of this VersionedProcessGroup. The name of the parameter context used by this process group

Returns:The parameter_context_name of this VersionedProcessGroup. Return type:str

position

Gets the position of this VersionedProcessGroup. The component’s position on the graph

Returns:The position of this VersionedProcessGroup. Return type:Position

process_groups

Gets the process_groups of this VersionedProcessGroup. The child Process Groups

Returns:The process_groups of this VersionedProcessGroup. Return type:list[VersionedProcessGroup]

processors

Gets the processors of this VersionedProcessGroup. The Processors

Returns:The processors of this VersionedProcessGroup. Return type:list[VersionedProcessor]

remote_process_groups

Gets the remote_process_groups of this VersionedProcessGroup. The Remote Process Groups

Returns:The remote_process_groups of this VersionedProcessGroup. Return type:list[VersionedRemoteProcessGroup]

swagger_types = {'comments': 'str', 'component_type': 'str', 'connections': 'list[VersionedConnection]', 'controller_services': 'list[VersionedControllerService]', 'default_back_pressure_data_size_threshold': 'str', 'default_back_pressure_object_threshold': 'int', 'default_flow_file_expiration': 'str', 'flow_file_concurrency': 'str', 'flow_file_outbound_policy': 'str', 'funnels': 'list[VersionedFunnel]', 'group_identifier': 'str', 'identifier': 'str', 'input_ports': 'list[VersionedPort]', 'instance_identifier': 'str', 'labels': 'list[VersionedLabel]', 'name': 'str', 'output_ports': 'list[VersionedPort]', 'parameter_context_name': 'str', 'position': 'Position', 'process_groups': 'list[VersionedProcessGroup]', 'processors': 'list[VersionedProcessor]', 'remote_process_groups': 'list[VersionedRemoteProcessGroup]', 'variables': 'dict(str, str)', 'versioned_flow_coordinates': 'VersionedFlowCoordinates'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variables

Gets the variables of this VersionedProcessGroup. The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)

Returns:The variables of this VersionedProcessGroup. Return type:dict(str, str)

versioned_flow_coordinates

Gets the versioned_flow_coordinates of this VersionedProcessGroup. The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control

Returns:The versioned_flow_coordinates of this VersionedProcessGroup. Return type:VersionedFlowCoordinates

nipyapi.nifi.models.versioned_processor 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_processor.VersionedProcessor(identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, bundle=None, properties=None, property_descriptors=None, style=None, annotation_data=None, scheduling_period=None, scheduling_strategy=None, execution_node=None, penalty_duration=None, yield_duration=None, bulletin_level=None, run_duration_millis=None, concurrently_schedulable_task_count=None, auto_terminated_relationships=None, scheduled_state=None, retry_count=None, retried_relationships=None, backoff_mechanism=None, max_backoff_period=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedProcessor - a model defined in Swagger

annotation_data

Gets the annotation_data of this VersionedProcessor. The annotation data for the processor used to relay configuration between a custom UI and the procesosr.

Returns:The annotation_data of this VersionedProcessor. Return type:str

attribute_map = {'annotation_data': 'annotationData', 'auto_terminated_relationships': 'autoTerminatedRelationships', 'backoff_mechanism': 'backoffMechanism', 'bulletin_level': 'bulletinLevel', 'bundle': 'bundle', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'execution_node': 'executionNode', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'max_backoff_period': 'maxBackoffPeriod', 'name': 'name', 'penalty_duration': 'penaltyDuration', 'position': 'position', 'properties': 'properties', 'property_descriptors': 'propertyDescriptors', 'retried_relationships': 'retriedRelationships', 'retry_count': 'retryCount', 'run_duration_millis': 'runDurationMillis', 'scheduled_state': 'scheduledState', 'scheduling_period': 'schedulingPeriod', 'scheduling_strategy': 'schedulingStrategy', 'style': 'style', 'type': 'type', 'yield_duration': 'yieldDuration'}

auto_terminated_relationships

Gets the auto_terminated_relationships of this VersionedProcessor. The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the ‘isAutoTerminate’ property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.

Returns:The auto_terminated_relationships of this VersionedProcessor. Return type:list[str]

backoff_mechanism

Gets the backoff_mechanism of this VersionedProcessor. Determines whether the FlowFile should be penalized or the processor should be yielded between retries.

Returns:The backoff_mechanism of this VersionedProcessor. Return type:str

bulletin_level

Gets the bulletin_level of this VersionedProcessor. The level at which the processor will report bulletins.

Returns:The bulletin_level of this VersionedProcessor. Return type:str

bundle

Gets the bundle of this VersionedProcessor. Information about the bundle from which the component came

Returns:The bundle of this VersionedProcessor. Return type:Bundle

comments

Gets the comments of this VersionedProcessor. The user-supplied comments for the component

Returns:The comments of this VersionedProcessor. Return type:str

component_type

Gets the component_type of this VersionedProcessor.

Returns:The component_type of this VersionedProcessor. Return type:str

concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this VersionedProcessor. The number of tasks that should be concurrently schedule for the processor. If the processor doesn’t allow parallol processing then any positive input will be ignored.

Returns:The concurrently_schedulable_task_count of this VersionedProcessor. Return type:int

execution_node

Gets the execution_node of this VersionedProcessor. Indicates the node where the process will execute.

Returns:The execution_node of this VersionedProcessor. Return type:str

group_identifier

Gets the group_identifier of this VersionedProcessor. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedProcessor. Return type:str

identifier

Gets the identifier of this VersionedProcessor. The component’s unique identifier

Returns:The identifier of this VersionedProcessor. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedProcessor. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedProcessor. Return type:str

max_backoff_period

Gets the max_backoff_period of this VersionedProcessor. Maximum amount of time to be waited during a retry period.

Returns:The max_backoff_period of this VersionedProcessor. Return type:str

name

Gets the name of this VersionedProcessor. The component’s name

Returns:The name of this VersionedProcessor. Return type:str

penalty_duration

Gets the penalty_duration of this VersionedProcessor. The amout of time that is used when the process penalizes a flowfile.

Returns:The penalty_duration of this VersionedProcessor. Return type:str

position

Gets the position of this VersionedProcessor. The component’s position on the graph

Returns:The position of this VersionedProcessor. Return type:Position

properties

Gets the properties of this VersionedProcessor. The properties for the component. Properties whose value is not set will only contain the property name.

Returns:The properties of this VersionedProcessor. Return type:dict(str, str)

property_descriptors

Gets the property_descriptors of this VersionedProcessor. The property descriptors for the component.

Returns:The property_descriptors of this VersionedProcessor. Return type:dict(str, VersionedPropertyDescriptor)

retried_relationships

Gets the retried_relationships of this VersionedProcessor. All the relationships should be retried.

Returns:The retried_relationships of this VersionedProcessor. Return type:list[str]

retry_count

Gets the retry_count of this VersionedProcessor. Overall number of retries.

Returns:The retry_count of this VersionedProcessor. Return type:int

run_duration_millis

Gets the run_duration_millis of this VersionedProcessor. The run duration for the processor in milliseconds.

Returns:The run_duration_millis of this VersionedProcessor. Return type:int

scheduled_state

Gets the scheduled_state of this VersionedProcessor. The scheduled state of the component

Returns:The scheduled_state of this VersionedProcessor. Return type:str

scheduling_period

Gets the scheduling_period of this VersionedProcessor. The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy.

Returns:The scheduling_period of this VersionedProcessor. Return type:str

scheduling_strategy

Gets the scheduling_strategy of this VersionedProcessor. Indicates whether the processor should be scheduled to run in event or timer driven mode.

Returns:The scheduling_strategy of this VersionedProcessor. Return type:str

style

Gets the style of this VersionedProcessor. Stylistic data for rendering in a UI

Returns:The style of this VersionedProcessor. Return type:dict(str, str)

swagger_types = {'annotation_data': 'str', 'auto_terminated_relationships': 'list[str]', 'backoff_mechanism': 'str', 'bulletin_level': 'str', 'bundle': 'Bundle', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'execution_node': 'str', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'max_backoff_period': 'str', 'name': 'str', 'penalty_duration': 'str', 'position': 'Position', 'properties': 'dict(str, str)', 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', 'retried_relationships': 'list[str]', 'retry_count': 'int', 'run_duration_millis': 'int', 'scheduled_state': 'str', 'scheduling_period': 'str', 'scheduling_strategy': 'str', 'style': 'dict(str, str)', 'type': 'str', 'yield_duration': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this VersionedProcessor. The type of the extension component

Returns:The type of this VersionedProcessor. Return type:str

yield_duration

Gets the yield_duration of this VersionedProcessor. The amount of time that must elapse before this processor is scheduled again after yielding.

Returns:The yield_duration of this VersionedProcessor. Return type:str

nipyapi.nifi.models.versioned_property_descriptor 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_property_descriptor.VersionedPropertyDescriptor(name=None, display_name=None, identifies_controller_service=None, sensitive=None, resource_definition=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedPropertyDescriptor - a model defined in Swagger

attribute_map = {'display_name': 'displayName', 'identifies_controller_service': 'identifiesControllerService', 'name': 'name', 'resource_definition': 'resourceDefinition', 'sensitive': 'sensitive'}

display_name

Gets the display_name of this VersionedPropertyDescriptor. The display name of the property

Returns:The display_name of this VersionedPropertyDescriptor. Return type:str

identifies_controller_service

Gets the identifies_controller_service of this VersionedPropertyDescriptor. Whether or not the property provides the identifier of a Controller Service

Returns:The identifies_controller_service of this VersionedPropertyDescriptor. Return type:bool

name

Gets the name of this VersionedPropertyDescriptor. The name of the property

Returns:The name of this VersionedPropertyDescriptor. Return type:str

resource_definition

Gets the resource_definition of this VersionedPropertyDescriptor. Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any

Returns:The resource_definition of this VersionedPropertyDescriptor. Return type:VersionedResourceDefinition

sensitive

Gets the sensitive of this VersionedPropertyDescriptor. Whether or not the property is considered sensitive

Returns:The sensitive of this VersionedPropertyDescriptor. Return type:bool

swagger_types = {'display_name': 'str', 'identifies_controller_service': 'bool', 'name': 'str', 'resource_definition': 'VersionedResourceDefinition', 'sensitive': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.versioned_remote_group_port 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_remote_group_port.VersionedRemoteGroupPort(identifier=None, instance_identifier=None, name=None, comments=None, position=None, remote_group_id=None, concurrently_schedulable_task_count=None, use_compression=None, batch_size=None, component_type=None, target_id=None, scheduled_state=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedRemoteGroupPort - a model defined in Swagger

attribute_map = {'batch_size': 'batchSize', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position', 'remote_group_id': 'remoteGroupId', 'scheduled_state': 'scheduledState', 'target_id': 'targetId', 'use_compression': 'useCompression'}

batch_size

Gets the batch_size of this VersionedRemoteGroupPort. The batch settings for data transmission.

Returns:The batch_size of this VersionedRemoteGroupPort. Return type:BatchSize

comments

Gets the comments of this VersionedRemoteGroupPort. The user-supplied comments for the component

Returns:The comments of this VersionedRemoteGroupPort. Return type:str

component_type

Gets the component_type of this VersionedRemoteGroupPort.

Returns:The component_type of this VersionedRemoteGroupPort. Return type:str

concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this VersionedRemoteGroupPort. The number of task that may transmit flowfiles to the target port concurrently.

Returns:The concurrently_schedulable_task_count of this VersionedRemoteGroupPort. Return type:int

group_identifier

Gets the group_identifier of this VersionedRemoteGroupPort. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedRemoteGroupPort. Return type:str

identifier

Gets the identifier of this VersionedRemoteGroupPort. The component’s unique identifier

Returns:The identifier of this VersionedRemoteGroupPort. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedRemoteGroupPort. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedRemoteGroupPort. Return type:str

name

Gets the name of this VersionedRemoteGroupPort. The component’s name

Returns:The name of this VersionedRemoteGroupPort. Return type:str

position

Gets the position of this VersionedRemoteGroupPort. The component’s position on the graph

Returns:The position of this VersionedRemoteGroupPort. Return type:Position

remote_group_id

Gets the remote_group_id of this VersionedRemoteGroupPort. The id of the remote process group that the port resides in.

Returns:The remote_group_id of this VersionedRemoteGroupPort. Return type:str

scheduled_state

Gets the scheduled_state of this VersionedRemoteGroupPort. The scheduled state of the component

Returns:The scheduled_state of this VersionedRemoteGroupPort. Return type:str

swagger_types = {'batch_size': 'BatchSize', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position', 'remote_group_id': 'str', 'scheduled_state': 'str', 'target_id': 'str', 'use_compression': 'bool'}

target_id

Gets the target_id of this VersionedRemoteGroupPort. The ID of the port on the target NiFi instance

Returns:The target_id of this VersionedRemoteGroupPort. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

use_compression

Gets the use_compression of this VersionedRemoteGroupPort. Whether the flowfiles are compressed when sent to the target port.

Returns:The use_compression of this VersionedRemoteGroupPort. Return type:bool

nipyapi.nifi.models.versioned_remote_process_group 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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_remote_process_group.VersionedRemoteProcessGroup(identifier=None, instance_identifier=None, name=None, comments=None, position=None, target_uri=None, target_uris=None, communications_timeout=None, yield_duration=None, transport_protocol=None, local_network_interface=None, proxy_host=None, proxy_port=None, proxy_user=None, input_ports=None, output_ports=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedRemoteProcessGroup - a model defined in Swagger

attribute_map = {'comments': 'comments', 'communications_timeout': 'communicationsTimeout', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'input_ports': 'inputPorts', 'instance_identifier': 'instanceIdentifier', 'local_network_interface': 'localNetworkInterface', 'name': 'name', 'output_ports': 'outputPorts', 'position': 'position', 'proxy_host': 'proxyHost', 'proxy_port': 'proxyPort', 'proxy_user': 'proxyUser', 'target_uri': 'targetUri', 'target_uris': 'targetUris', 'transport_protocol': 'transportProtocol', 'yield_duration': 'yieldDuration'}

comments

Gets the comments of this VersionedRemoteProcessGroup. The user-supplied comments for the component

Returns:The comments of this VersionedRemoteProcessGroup. Return type:str

communications_timeout

Gets the communications_timeout of this VersionedRemoteProcessGroup. The time period used for the timeout when communicating with the target.

Returns:The communications_timeout of this VersionedRemoteProcessGroup. Return type:str

component_type

Gets the component_type of this VersionedRemoteProcessGroup.

Returns:The component_type of this VersionedRemoteProcessGroup. Return type:str

group_identifier

Gets the group_identifier of this VersionedRemoteProcessGroup. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedRemoteProcessGroup. Return type:str

identifier

Gets the identifier of this VersionedRemoteProcessGroup. The component’s unique identifier

Returns:The identifier of this VersionedRemoteProcessGroup. Return type:str

input_ports

Gets the input_ports of this VersionedRemoteProcessGroup. A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance

Returns:The input_ports of this VersionedRemoteProcessGroup. Return type:list[VersionedRemoteGroupPort]

instance_identifier

Gets the instance_identifier of this VersionedRemoteProcessGroup. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedRemoteProcessGroup. Return type:str

local_network_interface

Gets the local_network_interface of this VersionedRemoteProcessGroup. The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier.

Returns:The local_network_interface of this VersionedRemoteProcessGroup. Return type:str

name

Gets the name of this VersionedRemoteProcessGroup. The component’s name

Returns:The name of this VersionedRemoteProcessGroup. Return type:str

output_ports

Gets the output_ports of this VersionedRemoteProcessGroup. A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance

Returns:The output_ports of this VersionedRemoteProcessGroup. Return type:list[VersionedRemoteGroupPort]

position

Gets the position of this VersionedRemoteProcessGroup. The component’s position on the graph

Returns:The position of this VersionedRemoteProcessGroup. Return type:Position

proxy_host

Gets the proxy_host of this VersionedRemoteProcessGroup.

Returns:The proxy_host of this VersionedRemoteProcessGroup. Return type:str

proxy_port

Gets the proxy_port of this VersionedRemoteProcessGroup.

Returns:The proxy_port of this VersionedRemoteProcessGroup. Return type:int

proxy_user

Gets the proxy_user of this VersionedRemoteProcessGroup.

Returns:The proxy_user of this VersionedRemoteProcessGroup. Return type:str

swagger_types = {'comments': 'str', 'communications_timeout': 'str', 'component_type': 'str', 'group_identifier': 'str', 'identifier': 'str', 'input_ports': 'list[VersionedRemoteGroupPort]', 'instance_identifier': 'str', 'local_network_interface': 'str', 'name': 'str', 'output_ports': 'list[VersionedRemoteGroupPort]', 'position': 'Position', 'proxy_host': 'str', 'proxy_port': 'int', 'proxy_user': 'str', 'target_uri': 'str', 'target_uris': 'str', 'transport_protocol': 'str', 'yield_duration': 'str'}

target_uri

Gets the target_uri of this VersionedRemoteProcessGroup. [DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null.

Returns:The target_uri of this VersionedRemoteProcessGroup. Return type:str

target_uris

Gets the target_uris of this VersionedRemoteProcessGroup. The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null.

Returns:The target_uris of this VersionedRemoteProcessGroup. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transport_protocol

Gets the transport_protocol of this VersionedRemoteProcessGroup. The Transport Protocol that is used for Site-to-Site communications

Returns:The transport_protocol of this VersionedRemoteProcessGroup. Return type:str

yield_duration

Gets the yield_duration of this VersionedRemoteProcessGroup. When yielding, this amount of time must elapse before the remote process group is scheduled again.

Returns:The yield_duration of this VersionedRemoteProcessGroup. Return type:str

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.17.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)

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)

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)

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)

Deserializes list or dict to model.

Parameters:

• data – dict, list.
• klass – class literal.

Returns:

model object.

parameters_to_tuples(params, collection_formats)

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)

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)

Makes the HTTP request using RESTClient.

sanitize_for_serialization(obj)

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)

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)

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).

set_default_header(header_name, header_value)

update_params_for_auth(headers, querys, auth_settings)

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.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

nipyapi.nifi.configuration.Configuration()

nipyapi.nifi.configuration.singleton(cls, *args, **kw)

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.17.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)

Bases: Exception

class nipyapi.nifi.rest.RESTClientObject(pools_size=4, maxsize=4)

Bases: object

DELETE(url, headers=None, query_params=None, body=None, _preload_content=True, _request_timeout=None)

GET(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)

HEAD(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)

OPTIONS(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

PATCH(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

POST(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

PUT(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

request(method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None)

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.

class nipyapi.nifi.rest.RESTResponse(resp)

Bases: io.IOBase

getheader(name, default=None)

Returns a given response header.

getheaders()

Returns a dictionary of the response headers.

NiFi-Registry Swagger Client

Subpackages

nipyapi.registry.apis package

Submodules

nipyapi.registry.apis.access_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.apis.access_api.AccessApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

create_access_token_by_trying_all_providers(**kwargs)

Create token trying all providers Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_by_trying_all_providers(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

create_access_token_by_trying_all_providers_with_http_info(**kwargs)

Create token trying all providers Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_by_trying_all_providers_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

create_access_token_using_basic_auth_credentials(**kwargs)

Create token using basic auth Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: ‘Authorization: Basic <credentials>’, where <credentials> is the base64 encoded value of ‘<username>:<password>’. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_using_basic_auth_credentials(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

create_access_token_using_basic_auth_credentials_with_http_info(**kwargs)

Create token using basic auth Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: ‘Authorization: Basic <credentials>’, where <credentials> is the base64 encoded value of ‘<username>:<password>’. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_using_basic_auth_credentials_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

create_access_token_using_identity_provider_credentials(**kwargs)

Create token using identity provider Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by ‘GET /access/token/identity-provider/usage’. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_using_identity_provider_credentials(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

create_access_token_using_identity_provider_credentials_with_http_info(**kwargs)

Create token using identity provider Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by ‘GET /access/token/identity-provider/usage’. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_using_identity_provider_credentials_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

create_access_token_using_kerberos_ticket(**kwargs)

Create token using kerberos Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_using_kerberos_ticket(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

create_access_token_using_kerberos_ticket_with_http_info(**kwargs)

Create token using kerberos Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_using_kerberos_ticket_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

get_access_status(**kwargs)

Get access status Returns the current client’s authenticated identity and permissions to top-level resources This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_status(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:CurrentUser If the method is called asynchronously, returns the request thread.

get_access_status_with_http_info(**kwargs)

Get access status Returns the current client’s authenticated identity and permissions to top-level resources This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_status_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:CurrentUser If the method is called asynchronously, returns the request thread.

get_identity_provider_usage_instructions(**kwargs)

Get identity provider usage Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_identity_provider_usage_instructions(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

get_identity_provider_usage_instructions_with_http_info(**kwargs)

Get identity provider usage Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_identity_provider_usage_instructions_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

log_out(**kwargs)

Performs a logout for other providers that have been issued a JWT.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.log_out(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

log_out_with_http_info(**kwargs)

Performs a logout for other providers that have been issued a JWT.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.log_out_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

oidc_callback(**kwargs)

Redirect/callback URI for processing the result of the OpenId Connect login sequence.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_callback(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

oidc_callback_with_http_info(**kwargs)

Redirect/callback URI for processing the result of the OpenId Connect login sequence.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_callback_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

oidc_exchange(**kwargs)

Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_exchange(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

oidc_exchange_with_http_info(**kwargs)

Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_exchange_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

oidc_logout(**kwargs)

Performs a logout in the OpenId Provider.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_logout(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

oidc_logout_with_http_info(**kwargs)

Performs a logout in the OpenId Provider.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_logout_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

oidc_request(**kwargs)

Initiates a request to authenticate through the configured OpenId Connect provider.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_request(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

oidc_request_with_http_info(**kwargs)

Initiates a request to authenticate through the configured OpenId Connect provider.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.oidc_request_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:None If the method is called asynchronously, returns the request thread.

test_identity_provider_recognizes_credentials_format(**kwargs)

Test identity provider Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by ‘GET /access/token/identity-provider/usage’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.test_identity_provider_recognizes_credentials_format(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

test_identity_provider_recognizes_credentials_format_with_http_info(**kwargs)

Test identity provider Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by ‘GET /access/token/identity-provider/usage’. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.test_identity_provider_recognizes_credentials_format_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:str If the method is called asynchronously, returns the request thread.

nipyapi.registry.apis.bucket_flows_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.apis.bucket_flows_api.BucketFlowsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

create_flow(bucket_id, body, **kwargs)

Create flow Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow(bucket_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• body (VersionedFlow) – The details of the flow to create. (required)

Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

create_flow_version(bucket_id, flow_id, body, **kwargs)

Create flow version Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow_version(bucket_id, flow_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• body (VersionedFlowSnapshot) – The new versioned flow snapshot. (required)

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

create_flow_version_with_http_info(bucket_id, flow_id, body, **kwargs)

Create flow version Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow_version_with_http_info(bucket_id, flow_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• body (VersionedFlowSnapshot) – The new versioned flow snapshot. (required)

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

create_flow_with_http_info(bucket_id, body, **kwargs)

Create flow Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow_with_http_info(bucket_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• body (VersionedFlow) – The details of the flow to create. (required)

Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

delete_flow(version, bucket_id, flow_id, **kwargs)

Delete bucket flow Deletes a flow, including all saved versions of that flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_flow(version, bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

delete_flow_with_http_info(version, bucket_id, flow_id, **kwargs)

Delete bucket flow Deletes a flow, including all saved versions of that flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_flow_with_http_info(version, bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

export_versioned_flow(bucket_id, flow_id, version_number, **kwargs)

Exports specified bucket flow version content Exports the specified version of a flow, including the metadata and content of the flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.export_versioned_flow(bucket_id, flow_id, version_number, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• version_number (int) – The version number (required)

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

export_versioned_flow_with_http_info(bucket_id, flow_id, version_number, **kwargs)

Exports specified bucket flow version content Exports the specified version of a flow, including the metadata and content of the flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.export_versioned_flow_with_http_info(bucket_id, flow_id, version_number, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• version_number (int) – The version number (required)

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

get_flow(bucket_id, flow_id, **kwargs)

Get bucket flow Retrieves the flow with the given id in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow(bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)

Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

get_flow_diff(bucket_id, flow_id, version_a, version_b, **kwargs)

Get bucket flow diff Computes the differences between two given versions of a flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_diff(bucket_id, flow_id, version_a, version_b, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• version_a (int) – The first version number (required)
• version_b (int) – The second version number (required)

Returns:

VersionedFlowDifference If the method is called asynchronously, returns the request thread.

get_flow_diff_with_http_info(bucket_id, flow_id, version_a, version_b, **kwargs)

Get bucket flow diff Computes the differences between two given versions of a flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_diff_with_http_info(bucket_id, flow_id, version_a, version_b, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• version_a (int) – The first version number (required)
• version_b (int) – The second version number (required)

Returns:

VersionedFlowDifference If the method is called asynchronously, returns the request thread.

get_flow_version(bucket_id, flow_id, version_number, **kwargs)

Get bucket flow version Gets the given version of a flow, including the metadata and content for the version. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_version(bucket_id, flow_id, version_number, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• version_number (int) – The version number (required)

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

get_flow_version_with_http_info(bucket_id, flow_id, version_number, **kwargs)

Get bucket flow version Gets the given version of a flow, including the metadata and content for the version. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_version_with_http_info(bucket_id, flow_id, version_number, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• version_number (int) – The version number (required)

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

get_flow_versions(bucket_id, flow_id, **kwargs)

Get bucket flow versions Gets summary information for all versions of a flow. Versions are ordered newest->oldest. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_versions(bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)

Returns:

list[VersionedFlowSnapshotMetadata] If the method is called asynchronously, returns the request thread.

get_flow_versions_with_http_info(bucket_id, flow_id, **kwargs)

Get bucket flow versions Gets summary information for all versions of a flow. Versions are ordered newest->oldest. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_versions_with_http_info(bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)

Returns:

list[VersionedFlowSnapshotMetadata] If the method is called asynchronously, returns the request thread.

get_flow_with_http_info(bucket_id, flow_id, **kwargs)

Get bucket flow Retrieves the flow with the given id in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_with_http_info(bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)

Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

get_flows(bucket_id, **kwargs)

Get bucket flows Retrieves all flows in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flows(bucket_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)

Returns:

list[VersionedFlow] If the method is called asynchronously, returns the request thread.

get_flows_with_http_info(bucket_id, **kwargs)

Get bucket flows Retrieves all flows in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flows_with_http_info(bucket_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)

Returns:

list[VersionedFlow] If the method is called asynchronously, returns the request thread.

get_latest_flow_version(bucket_id, flow_id, **kwargs)

Get latest bucket flow version content Gets the latest version of a flow, including the metadata and content of the flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_latest_flow_version(bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

get_latest_flow_version_metadata(bucket_id, flow_id, **kwargs)

Get latest bucket flow version metadata Gets the metadata for the latest version of a flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_latest_flow_version_metadata(bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)

Returns:

VersionedFlowSnapshotMetadata If the method is called asynchronously, returns the request thread.

get_latest_flow_version_metadata_with_http_info(bucket_id, flow_id, **kwargs)

Get latest bucket flow version metadata Gets the metadata for the latest version of a flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_latest_flow_version_metadata_with_http_info(bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)

Returns:

VersionedFlowSnapshotMetadata If the method is called asynchronously, returns the request thread.

get_latest_flow_version_with_http_info(bucket_id, flow_id, **kwargs)

Get latest bucket flow version content Gets the latest version of a flow, including the metadata and content of the flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_latest_flow_version_with_http_info(bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

import_versioned_flow(bucket_id, flow_id, **kwargs)

Import flow version Import the next version of a flow. The version number of the object being created will be the next available version integer. Flow versions are immutable after they are created. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.import_versioned_flow(bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• body (VersionedFlowSnapshot) – file
• comments (str) –

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

import_versioned_flow_with_http_info(bucket_id, flow_id, **kwargs)

Import flow version Import the next version of a flow. The version number of the object being created will be the next available version integer. Flow versions are immutable after they are created. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.import_versioned_flow_with_http_info(bucket_id, flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• body (VersionedFlowSnapshot) – file
• comments (str) –

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

update_flow(bucket_id, flow_id, body, **kwargs)

Update bucket flow Updates the flow with the given id in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_flow(bucket_id, flow_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• body (VersionedFlow) – The updated flow (required)

Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

update_flow_with_http_info(bucket_id, flow_id, body, **kwargs)

Update bucket flow Updates the flow with the given id in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_flow_with_http_info(bucket_id, flow_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• flow_id (str) – The flow identifier (required)
• body (VersionedFlow) – The updated flow (required)

Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

nipyapi.registry.apis.buckets_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.apis.buckets_api.BucketsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

create_bucket(body, **kwargs)

Create bucket

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_bucket(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (Bucket) – The bucket to create (required)

Returns:

Bucket If the method is called asynchronously, returns the request thread.

create_bucket_with_http_info(body, **kwargs)

Create bucket

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_bucket_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (Bucket) – The bucket to create (required)

Returns:

Bucket If the method is called asynchronously, returns the request thread.

delete_bucket(version, bucket_id, **kwargs)

Delete bucket Deletes the bucket with the given id, along with all objects stored in the bucket This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_bucket(version, bucket_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
• bucket_id (str) – The bucket identifier (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Returns:

Bucket If the method is called asynchronously, returns the request thread.

delete_bucket_with_http_info(version, bucket_id, **kwargs)

Delete bucket Deletes the bucket with the given id, along with all objects stored in the bucket This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_bucket_with_http_info(version, bucket_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
• bucket_id (str) – The bucket identifier (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Returns:

Bucket If the method is called asynchronously, returns the request thread.

get_available_bucket_fields(**kwargs)

Get bucket fields Retrieves bucket field names for searching or sorting on buckets. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_available_bucket_fields(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:Fields If the method is called asynchronously, returns the request thread.

get_available_bucket_fields_with_http_info(**kwargs)

Get bucket fields Retrieves bucket field names for searching or sorting on buckets. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_available_bucket_fields_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:Fields If the method is called asynchronously, returns the request thread.

get_bucket(bucket_id, **kwargs)

Get bucket Gets the bucket with the given id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_bucket(bucket_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)

Returns:

Bucket If the method is called asynchronously, returns the request thread.

get_bucket_with_http_info(bucket_id, **kwargs)

Get bucket Gets the bucket with the given id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_bucket_with_http_info(bucket_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)

Returns:

Bucket If the method is called asynchronously, returns the request thread.

get_buckets(**kwargs)

Get all buckets The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_buckets(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:list[Bucket] If the method is called asynchronously, returns the request thread.

get_buckets_with_http_info(**kwargs)

Get all buckets The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_buckets_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:list[Bucket] If the method is called asynchronously, returns the request thread.

update_bucket(bucket_id, body, **kwargs)

Update bucket Updates the bucket with the given id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_bucket(bucket_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• body (Bucket) – The updated bucket (required)

Returns:

Bucket If the method is called asynchronously, returns the request thread.

update_bucket_with_http_info(bucket_id, body, **kwargs)

Update bucket Updates the bucket with the given id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_bucket_with_http_info(bucket_id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)
• body (Bucket) – The updated bucket (required)

Returns:

Bucket If the method is called asynchronously, returns the request thread.

nipyapi.registry.apis.flows_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.apis.flows_api.FlowsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

get_available_flow_fields(**kwargs)

Get flow fields Retrieves the flow field names that can be used for searching or sorting on flows. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_available_flow_fields(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:Fields If the method is called asynchronously, returns the request thread.

get_available_flow_fields_with_http_info(**kwargs)

Get flow fields Retrieves the flow field names that can be used for searching or sorting on flows. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_available_flow_fields_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:Fields If the method is called asynchronously, returns the request thread.

global_get_flow(flow_id, **kwargs)

Get flow Gets a flow by id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_flow(flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• flow_id (str) – The flow identifier (required)

Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

global_get_flow_version(flow_id, version_number, **kwargs)

Get flow version Gets the given version of a flow, including metadata and flow content. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_flow_version(flow_id, version_number, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• flow_id (str) – The flow identifier (required)
• version_number (int) – The version number (required)

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

global_get_flow_version_with_http_info(flow_id, version_number, **kwargs)

Get flow version Gets the given version of a flow, including metadata and flow content. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_flow_version_with_http_info(flow_id, version_number, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• flow_id (str) – The flow identifier (required)
• version_number (int) – The version number (required)

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

global_get_flow_versions(flow_id, **kwargs)

Get flow versions Gets summary information for all versions of a given flow. Versions are ordered newest->oldest. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_flow_versions(flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• flow_id (str) – The flow identifier (required)

Returns:

list[VersionedFlowSnapshotMetadata] If the method is called asynchronously, returns the request thread.

global_get_flow_versions_with_http_info(flow_id, **kwargs)

Get flow versions Gets summary information for all versions of a given flow. Versions are ordered newest->oldest. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_flow_versions_with_http_info(flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• flow_id (str) – The flow identifier (required)

Returns:

list[VersionedFlowSnapshotMetadata] If the method is called asynchronously, returns the request thread.

global_get_flow_with_http_info(flow_id, **kwargs)

Get flow Gets a flow by id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_flow_with_http_info(flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• flow_id (str) – The flow identifier (required)

Returns:

VersionedFlow If the method is called asynchronously, returns the request thread.

global_get_latest_flow_version(flow_id, **kwargs)

Get latest flow version Gets the latest version of a flow, including metadata and flow content. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_latest_flow_version(flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• flow_id (str) – The flow identifier (required)

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

global_get_latest_flow_version_metadata(flow_id, **kwargs)

Get latest flow version metadata Gets the metadata for the latest version of a flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_latest_flow_version_metadata(flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• flow_id (str) – The flow identifier (required)

Returns:

VersionedFlowSnapshotMetadata If the method is called asynchronously, returns the request thread.

global_get_latest_flow_version_metadata_with_http_info(flow_id, **kwargs)

Get latest flow version metadata Gets the metadata for the latest version of a flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_latest_flow_version_metadata_with_http_info(flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• flow_id (str) – The flow identifier (required)

Returns:

VersionedFlowSnapshotMetadata If the method is called asynchronously, returns the request thread.

global_get_latest_flow_version_with_http_info(flow_id, **kwargs)

Get latest flow version Gets the latest version of a flow, including metadata and flow content. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.global_get_latest_flow_version_with_http_info(flow_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• flow_id (str) – The flow identifier (required)

Returns:

VersionedFlowSnapshot If the method is called asynchronously, returns the request thread.

nipyapi.registry.apis.items_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.apis.items_api.ItemsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

get_available_bucket_item_fields(**kwargs)

Get item fields Retrieves the item field names for searching or sorting on bucket items. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_available_bucket_item_fields(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:Fields If the method is called asynchronously, returns the request thread.

get_available_bucket_item_fields_with_http_info(**kwargs)

Get item fields Retrieves the item field names for searching or sorting on bucket items. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_available_bucket_item_fields_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:Fields If the method is called asynchronously, returns the request thread.

get_items(**kwargs)

Get all items Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_items(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:list[BucketItem] If the method is called asynchronously, returns the request thread.

get_items_in_bucket(bucket_id, **kwargs)

Get bucket items Gets the items located in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_items_in_bucket(bucket_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)

Returns:

list[BucketItem] If the method is called asynchronously, returns the request thread.

get_items_in_bucket_with_http_info(bucket_id, **kwargs)

Get bucket items Gets the items located in the given bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_items_in_bucket_with_http_info(bucket_id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• bucket_id (str) – The bucket identifier (required)

Returns:

list[BucketItem] If the method is called asynchronously, returns the request thread.

get_items_with_http_info(**kwargs)

Get all items Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_items_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:list[BucketItem] If the method is called asynchronously, returns the request thread.

nipyapi.registry.apis.policies_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.apis.policies_api.PoliciesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

create_access_policy(body, **kwargs)

Create access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_policy(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (AccessPolicy) – The access policy configuration details. (required)

Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

create_access_policy_with_http_info(body, **kwargs)

Create access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_policy_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (AccessPolicy) – The access policy configuration details. (required)

Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

get_access_policies(**kwargs)

Get all access policies

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policies(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:list[AccessPolicy] If the method is called asynchronously, returns the request thread.

get_access_policies_with_http_info(**kwargs)

Get all access policies

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policies_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:list[AccessPolicy] If the method is called asynchronously, returns the request thread.

get_access_policy(id, **kwargs)

Get access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The access policy id. (required)

Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

get_access_policy_for_resource(action, resource, **kwargs)

Get access policy for resource Gets an access policy for the specified action and resource This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy_for_resource(action, resource, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• action (str) – The request action. (required)
• resource (str) – The resource of the policy. (required)

Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

get_access_policy_for_resource_with_http_info(action, resource, **kwargs)

Get access policy for resource Gets an access policy for the specified action and resource This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy_for_resource_with_http_info(action, resource, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• action (str) – The request action. (required)
• resource (str) – The resource of the policy. (required)

Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

get_access_policy_with_http_info(id, **kwargs)

Get access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The access policy id. (required)

Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

get_resources(**kwargs)

Get available resources Gets the available resources that support access/authorization policies This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_resources(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:list[Resource] If the method is called asynchronously, returns the request thread.

get_resources_with_http_info(**kwargs)

Get available resources Gets the available resources that support access/authorization policies This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_resources_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:list[Resource] If the method is called asynchronously, returns the request thread.

remove_access_policy(version, id, **kwargs)

Delete access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_access_policy(version, id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
• id (str) – The access policy id. (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

remove_access_policy_with_http_info(version, id, **kwargs)

Delete access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_access_policy_with_http_info(version, id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
• id (str) – The access policy id. (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

update_access_policy(id, body, **kwargs)

Update access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_access_policy(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The access policy id. (required)
• body (AccessPolicy) – The access policy configuration details. (required)

Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

update_access_policy_with_http_info(id, body, **kwargs)

Update access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_access_policy_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The access policy id. (required)
• body (AccessPolicy) – The access policy configuration details. (required)

Returns:

AccessPolicy If the method is called asynchronously, returns the request thread.

nipyapi.registry.apis.tenants_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.apis.tenants_api.TenantsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

create_user(body, **kwargs)

Create user

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_user(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (User) – The user configuration details. (required)

Returns:

User If the method is called asynchronously, returns the request thread.

create_user_group(body, **kwargs)

Create user group

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_user_group(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (UserGroup) – The user group configuration details. (required)

Returns:

UserGroup If the method is called asynchronously, returns the request thread.

create_user_group_with_http_info(body, **kwargs)

Create user group

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_user_group_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (UserGroup) – The user group configuration details. (required)

Returns:

UserGroup If the method is called asynchronously, returns the request thread.

create_user_with_http_info(body, **kwargs)

Create user

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_user_with_http_info(body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• body (User) – The user configuration details. (required)

Returns:

User If the method is called asynchronously, returns the request thread.

get_user(id, **kwargs)

Get user

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user id. (required)

Returns:

User If the method is called asynchronously, returns the request thread.

get_user_group(id, **kwargs)

Get user group

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_group(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user group id. (required)

Returns:

UserGroup If the method is called asynchronously, returns the request thread.

get_user_group_with_http_info(id, **kwargs)

Get user group

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_group_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user group id. (required)

Returns:

UserGroup If the method is called asynchronously, returns the request thread.

get_user_groups(**kwargs)

Get user groups

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_groups(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:list[UserGroup] If the method is called asynchronously, returns the request thread.

get_user_groups_with_http_info(**kwargs)

Get user groups

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_groups_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:list[UserGroup] If the method is called asynchronously, returns the request thread.

get_user_with_http_info(id, **kwargs)

Get user

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_user_with_http_info(id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user id. (required)

Returns:

User If the method is called asynchronously, returns the request thread.

get_users(**kwargs)

Get all users

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_users(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:list[User] If the method is called asynchronously, returns the request thread.

get_users_with_http_info(**kwargs)

Get all users

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_users_with_http_info(callback=callback_function)

Parameters:function (callback) – The callback function for asynchronous request. (optional) Returns:list[User] If the method is called asynchronously, returns the request thread.

remove_user(version, id, **kwargs)

Delete user

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_user(version, id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
• id (str) – The user id. (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Returns:

User If the method is called asynchronously, returns the request thread.

remove_user_group(version, id, **kwargs)

Delete user group

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_user_group(version, id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
• id (str) – The user group id. (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Returns:

UserGroup If the method is called asynchronously, returns the request thread.

remove_user_group_with_http_info(version, id, **kwargs)

Delete user group

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_user_group_with_http_info(version, id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
• id (str) – The user group id. (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Returns:

UserGroup If the method is called asynchronously, returns the request thread.

remove_user_with_http_info(version, id, **kwargs)

Delete user

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_user_with_http_info(version, id, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• version (str) – The version is used to verify the client is working with the latest version of the entity. (required)
• id (str) – The user id. (required)
• client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Returns:

User If the method is called asynchronously, returns the request thread.

update_user(id, body, **kwargs)

Update user

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_user(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user id. (required)
• body (User) – The user configuration details. (required)

Returns:

User If the method is called asynchronously, returns the request thread.

update_user_group(id, body, **kwargs)

Update user group

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_user_group(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user group id. (required)
• body (UserGroup) – The user group configuration details. (required)

Returns:

UserGroup If the method is called asynchronously, returns the request thread.

update_user_group_with_http_info(id, body, **kwargs)

Update user group

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_user_group_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user group id. (required)
• body (UserGroup) – The user group configuration details. (required)

Returns:

UserGroup If the method is called asynchronously, returns the request thread.

update_user_with_http_info(id, body, **kwargs)

Update user

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_user_with_http_info(id, body, callback=callback_function)

Parameters:

• function (callback) – The callback function for asynchronous request. (optional)
• id (str) – The user id. (required)
• body (User) – The user configuration details. (required)

Returns:

User If the method is called asynchronously, returns the request thread.

nipyapi.registry.models package

Submodules

nipyapi.registry.models.access_policy module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.access_policy.AccessPolicy(identifier=None, resource=None, action=None, configurable=None, revision=None, users=None, user_groups=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessPolicy - a model defined in Swagger

action

Gets the action of this AccessPolicy. The action associated with this access policy.

Returns:The action of this AccessPolicy. Return type:str

attribute_map = {'action': 'action', 'configurable': 'configurable', 'identifier': 'identifier', 'resource': 'resource', 'revision': 'revision', 'user_groups': 'userGroups', 'users': 'users'}

configurable

Gets the configurable of this AccessPolicy. Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.

Returns:The configurable of this AccessPolicy. Return type:bool

identifier

Gets the identifier of this AccessPolicy. The id of the policy. Set by server at creation time.

Returns:The identifier of this AccessPolicy. Return type:str

resource

Gets the resource of this AccessPolicy. The resource for this access policy.

Returns:The resource of this AccessPolicy. Return type:str

revision

Gets the revision of this AccessPolicy. The revision of this entity used for optimistic-locking during updates.

Returns:The revision of this AccessPolicy. Return type:RevisionInfo

swagger_types = {'action': 'str', 'configurable': 'bool', 'identifier': 'str', 'resource': 'str', 'revision': 'RevisionInfo', 'user_groups': 'list[Tenant]', 'users': 'list[Tenant]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

user_groups

Gets the user_groups of this AccessPolicy. The set of user group IDs associated with this access policy.

Returns:The user_groups of this AccessPolicy. Return type:list[Tenant]

users

Gets the users of this AccessPolicy. The set of user IDs associated with this access policy.

Returns:The users of this AccessPolicy. Return type:list[Tenant]

nipyapi.registry.models.access_policy_summary module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.access_policy_summary.AccessPolicySummary(identifier=None, resource=None, action=None, configurable=None, revision=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessPolicySummary - a model defined in Swagger

action

Gets the action of this AccessPolicySummary. The action associated with this access policy.

Returns:The action of this AccessPolicySummary. Return type:str

attribute_map = {'action': 'action', 'configurable': 'configurable', 'identifier': 'identifier', 'resource': 'resource', 'revision': 'revision'}

configurable

Gets the configurable of this AccessPolicySummary. Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.

Returns:The configurable of this AccessPolicySummary. Return type:bool

identifier

Gets the identifier of this AccessPolicySummary. The id of the policy. Set by server at creation time.

Returns:The identifier of this AccessPolicySummary. Return type:str

resource

Gets the resource of this AccessPolicySummary. The resource for this access policy.

Returns:The resource of this AccessPolicySummary. Return type:str

revision

Gets the revision of this AccessPolicySummary. The revision of this entity used for optimistic-locking during updates.

Returns:The revision of this AccessPolicySummary. Return type:RevisionInfo

swagger_types = {'action': 'str', 'configurable': 'bool', 'identifier': 'str', 'resource': 'str', 'revision': 'RevisionInfo'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.batch_size module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.batch_size.BatchSize(count=None, size=None, duration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BatchSize - a model defined in Swagger

attribute_map = {'count': 'count', 'duration': 'duration', 'size': 'size'}

count

Gets the count of this BatchSize. Preferred number of flow files to include in a transaction.

Returns:The count of this BatchSize. Return type:int

duration

Gets the duration of this BatchSize. Preferred amount of time that a transaction should span.

Returns:The duration of this BatchSize. Return type:str

size

Gets the size of this BatchSize. Preferred number of bytes to include in a transaction.

Returns:The size of this BatchSize. Return type:str

swagger_types = {'count': 'int', 'duration': 'str', 'size': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.bucket module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.bucket.Bucket(link=None, identifier=None, name=None, created_timestamp=None, description=None, allow_bundle_redeploy=None, allow_public_read=None, permissions=None, revision=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

Bucket - a model defined in Swagger

allow_bundle_redeploy

Gets the allow_bundle_redeploy of this Bucket. Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false.

Returns:The allow_bundle_redeploy of this Bucket. Return type:bool

allow_public_read

Gets the allow_public_read of this Bucket. Indicates if this bucket allows read access to unauthenticated anonymous users

Returns:The allow_public_read of this Bucket. Return type:bool

attribute_map = {'allow_bundle_redeploy': 'allowBundleRedeploy', 'allow_public_read': 'allowPublicRead', 'created_timestamp': 'createdTimestamp', 'description': 'description', 'identifier': 'identifier', 'link': 'link', 'name': 'name', 'permissions': 'permissions', 'revision': 'revision'}

created_timestamp

Gets the created_timestamp of this Bucket. The timestamp of when the bucket was first created. This is set by the server at creation time.

Returns:The created_timestamp of this Bucket. Return type:int

description

Gets the description of this Bucket. A description of the bucket.

Returns:The description of this Bucket. Return type:str

identifier

Gets the identifier of this Bucket. An ID to uniquely identify this object.

Returns:The identifier of this Bucket. Return type:str

link

Gets the link of this Bucket. An WebLink to this entity.

Returns:The link of this Bucket. Return type:JaxbLink

name

Gets the name of this Bucket. The name of the bucket.

Returns:The name of this Bucket. Return type:str

permissions

Gets the permissions of this Bucket. The access that the current user has to this bucket.

Returns:The permissions of this Bucket. Return type:Permissions

revision

Gets the revision of this Bucket. The revision of this entity used for optimistic-locking during updates.

Returns:The revision of this Bucket. Return type:RevisionInfo

swagger_types = {'allow_bundle_redeploy': 'bool', 'allow_public_read': 'bool', 'created_timestamp': 'int', 'description': 'str', 'identifier': 'str', 'link': 'JaxbLink', 'name': 'str', 'permissions': 'Permissions', 'revision': 'RevisionInfo'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.bucket_item module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.bucket_item.BucketItem(link=None, identifier=None, name=None, description=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, modified_timestamp=None, type=None, permissions=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BucketItem - a model defined in Swagger

attribute_map = {'bucket_identifier': 'bucketIdentifier', 'bucket_name': 'bucketName', 'created_timestamp': 'createdTimestamp', 'description': 'description', 'identifier': 'identifier', 'link': 'link', 'modified_timestamp': 'modifiedTimestamp', 'name': 'name', 'permissions': 'permissions', 'type': 'type'}

bucket_identifier

Gets the bucket_identifier of this BucketItem. The identifier of the bucket this items belongs to. This cannot be changed after the item is created.

Returns:The bucket_identifier of this BucketItem. Return type:str

bucket_name

Gets the bucket_name of this BucketItem. The name of the bucket this items belongs to.

Returns:The bucket_name of this BucketItem. Return type:str

created_timestamp

Gets the created_timestamp of this BucketItem. The timestamp of when the item was created, as milliseconds since epoch.

Returns:The created_timestamp of this BucketItem. Return type:int

description

Gets the description of this BucketItem. A description of the item.

Returns:The description of this BucketItem. Return type:str

identifier

Gets the identifier of this BucketItem. An ID to uniquely identify this object.

Returns:The identifier of this BucketItem. Return type:str

link

Gets the link of this BucketItem. An WebLink to this entity.

Returns:The link of this BucketItem. Return type:JaxbLink

modified_timestamp

Gets the modified_timestamp of this BucketItem. The timestamp of when the item was last modified, as milliseconds since epoch.

Returns:The modified_timestamp of this BucketItem. Return type:int

name

Gets the name of this BucketItem. The name of the item.

Returns:The name of this BucketItem. Return type:str

permissions

Gets the permissions of this BucketItem. The access that the current user has to the bucket containing this item.

Returns:The permissions of this BucketItem. Return type:Permissions

swagger_types = {'bucket_identifier': 'str', 'bucket_name': 'str', 'created_timestamp': 'int', 'description': 'str', 'identifier': 'str', 'link': 'JaxbLink', 'modified_timestamp': 'int', 'name': 'str', 'permissions': 'Permissions', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this BucketItem. The type of item.

Returns:The type of this BucketItem. Return type:str

nipyapi.registry.models.bundle module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.bundle.Bundle(group=None, artifact=None, version=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

Bundle - a model defined in Swagger

artifact

Gets the artifact of this Bundle. The artifact of the bundle

Returns:The artifact of this Bundle. Return type:str

attribute_map = {'artifact': 'artifact', 'group': 'group', 'version': 'version'}

group

Gets the group of this Bundle. The group of the bundle

Returns:The group of this Bundle. Return type:str

swagger_types = {'artifact': 'str', 'group': 'str', 'version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version

Gets the version of this Bundle. The version of the bundle

Returns:The version of this Bundle. Return type:str

nipyapi.registry.models.connectable_component module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.connectable_component.ConnectableComponent(id=None, type=None, group_id=None, name=None, comments=None, instance_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectableComponent - a model defined in Swagger

attribute_map = {'comments': 'comments', 'group_id': 'groupId', 'id': 'id', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'type': 'type'}

comments

Gets the comments of this ConnectableComponent. The comments for the connectable component.

Returns:The comments of this ConnectableComponent. Return type:str

group_id

Gets the group_id of this ConnectableComponent. The id of the group that the connectable component resides in

Returns:The group_id of this ConnectableComponent. Return type:str

id

Gets the id of this ConnectableComponent. The id of the connectable component.

Returns:The id of this ConnectableComponent. Return type:str

instance_identifier

Gets the instance_identifier of this ConnectableComponent. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this ConnectableComponent. Return type:str

name

Gets the name of this ConnectableComponent. The name of the connectable component

Returns:The name of this ConnectableComponent. Return type:str

swagger_types = {'comments': 'str', 'group_id': 'str', 'id': 'str', 'instance_identifier': 'str', 'name': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ConnectableComponent. The type of component the connectable is.

Returns:The type of this ConnectableComponent. Return type:str

nipyapi.registry.models.controller_service_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.controller_service_api.ControllerServiceAPI(type=None, bundle=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceAPI - a model defined in Swagger

attribute_map = {'bundle': 'bundle', 'type': 'type'}

bundle

Gets the bundle of this ControllerServiceAPI. The details of the artifact that bundled this service interface.

Returns:The bundle of this ControllerServiceAPI. Return type:Bundle

swagger_types = {'bundle': 'Bundle', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ControllerServiceAPI. The fully qualified name of the service interface.

Returns:The type of this ControllerServiceAPI. Return type:str

nipyapi.registry.models.current_user module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.current_user.CurrentUser(identity=None, anonymous=None, login_supported=None, resource_permissions=None, oidclogin_supported=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CurrentUser - a model defined in Swagger

anonymous

Gets the anonymous of this CurrentUser. Indicates if the current user is anonymous

Returns:The anonymous of this CurrentUser. Return type:bool

attribute_map = {'anonymous': 'anonymous', 'identity': 'identity', 'login_supported': 'loginSupported', 'oidclogin_supported': 'oidcloginSupported', 'resource_permissions': 'resourcePermissions'}

identity

Gets the identity of this CurrentUser. The identity of the current user

Returns:The identity of this CurrentUser. Return type:str

login_supported

Gets the login_supported of this CurrentUser. Indicates if the NiFi Registry instance supports logging in

Returns:The login_supported of this CurrentUser. Return type:bool

oidclogin_supported

Gets the oidclogin_supported of this CurrentUser. Indicates if the NiFi Registry instance supports logging in with an OIDC provider

Returns:The oidclogin_supported of this CurrentUser. Return type:bool

resource_permissions

Gets the resource_permissions of this CurrentUser. The access that the current user has to top level resources

Returns:The resource_permissions of this CurrentUser. Return type:ResourcePermissions

swagger_types = {'anonymous': 'bool', 'identity': 'str', 'login_supported': 'bool', 'oidclogin_supported': 'bool', 'resource_permissions': 'ResourcePermissions'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.fields module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.fields.Fields(fields=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

Fields - a model defined in Swagger

attribute_map = {'fields': 'fields'}

fields

Gets the fields of this Fields.

Returns:The fields of this Fields. Return type:list[str]

swagger_types = {'fields': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.permissions module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.permissions.Permissions(can_read=None, can_write=None, can_delete=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

Permissions - a model defined in Swagger

attribute_map = {'can_delete': 'canDelete', 'can_read': 'canRead', 'can_write': 'canWrite'}

can_delete

Gets the can_delete of this Permissions. Indicates whether the user can delete a given resource.

Returns:The can_delete of this Permissions. Return type:bool

can_read

Gets the can_read of this Permissions. Indicates whether the user can read a given resource.

Returns:The can_read of this Permissions. Return type:bool

can_write

Gets the can_write of this Permissions. Indicates whether the user can write a given resource.

Returns:The can_write of this Permissions. Return type:bool

swagger_types = {'can_delete': 'bool', 'can_read': 'bool', 'can_write': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.resource module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.resource.Resource(identifier=None, name=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

Resource - a model defined in Swagger

attribute_map = {'identifier': 'identifier', 'name': 'name'}

identifier

Gets the identifier of this Resource. The identifier of the resource.

Returns:The identifier of this Resource. Return type:str

name

Gets the name of this Resource. The name of the resource.

Returns:The name of this Resource. Return type:str

swagger_types = {'identifier': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.resource_permissions module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.resource_permissions.ResourcePermissions(buckets=None, tenants=None, policies=None, proxy=None, any_top_level_resource=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ResourcePermissions - a model defined in Swagger

any_top_level_resource

Gets the any_top_level_resource of this ResourcePermissions. The access that the current user has to any top level resources (a logical ‘OR’ of all other values)

Returns:The any_top_level_resource of this ResourcePermissions. Return type:Permissions

attribute_map = {'any_top_level_resource': 'anyTopLevelResource', 'buckets': 'buckets', 'policies': 'policies', 'proxy': 'proxy', 'tenants': 'tenants'}

buckets

Gets the buckets of this ResourcePermissions. The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)

Returns:The buckets of this ResourcePermissions. Return type:Permissions

policies

Gets the policies of this ResourcePermissions. The access that the current user has to the top level /policies resource of this NiFi Registry

Returns:The policies of this ResourcePermissions. Return type:Permissions

proxy

Gets the proxy of this ResourcePermissions. The access that the current user has to the top level /proxy resource of this NiFi Registry

Returns:The proxy of this ResourcePermissions. Return type:Permissions

swagger_types = {'any_top_level_resource': 'Permissions', 'buckets': 'Permissions', 'policies': 'Permissions', 'proxy': 'Permissions', 'tenants': 'Permissions'}

tenants

Gets the tenants of this ResourcePermissions. The access that the current user has to the top level /tenants resource of this NiFi Registry

Returns:The tenants of this ResourcePermissions. Return type:Permissions

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.tenant module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.tenant.Tenant(identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, revision=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

Tenant - a model defined in Swagger

access_policies

Gets the access_policies of this Tenant. The access policies granted to this tenant.

Returns:The access_policies of this Tenant. Return type:list[AccessPolicySummary]

attribute_map = {'access_policies': 'accessPolicies', 'configurable': 'configurable', 'identifier': 'identifier', 'identity': 'identity', 'resource_permissions': 'resourcePermissions', 'revision': 'revision'}

configurable

Gets the configurable of this Tenant. Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.

Returns:The configurable of this Tenant. Return type:bool

identifier

Gets the identifier of this Tenant. The computer-generated identifier of the tenant.

Returns:The identifier of this Tenant. Return type:str

identity

Gets the identity of this Tenant. The human-facing identity of the tenant. This can only be changed if the tenant is configurable.

Returns:The identity of this Tenant. Return type:str

resource_permissions

Gets the resource_permissions of this Tenant. A summary top-level resource access policies granted to this tenant.

Returns:The resource_permissions of this Tenant. Return type:ResourcePermissions

revision

Gets the revision of this Tenant. The revision of this entity used for optimistic-locking during updates.

Returns:The revision of this Tenant. Return type:RevisionInfo

swagger_types = {'access_policies': 'list[AccessPolicySummary]', 'configurable': 'bool', 'identifier': 'str', 'identity': 'str', 'resource_permissions': 'ResourcePermissions', 'revision': 'RevisionInfo'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.user module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.user.User(identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, revision=None, user_groups=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

User - a model defined in Swagger

access_policies

Gets the access_policies of this User. The access policies granted to this tenant.

Returns:The access_policies of this User. Return type:list[AccessPolicySummary]

attribute_map = {'access_policies': 'accessPolicies', 'configurable': 'configurable', 'identifier': 'identifier', 'identity': 'identity', 'resource_permissions': 'resourcePermissions', 'revision': 'revision', 'user_groups': 'userGroups'}

configurable

Gets the configurable of this User. Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.

Returns:The configurable of this User. Return type:bool

identifier

Gets the identifier of this User. The computer-generated identifier of the tenant.

Returns:The identifier of this User. Return type:str

identity

Gets the identity of this User. The human-facing identity of the tenant. This can only be changed if the tenant is configurable.

Returns:The identity of this User. Return type:str

resource_permissions

Gets the resource_permissions of this User. A summary top-level resource access policies granted to this tenant.

Returns:The resource_permissions of this User. Return type:ResourcePermissions

revision

Gets the revision of this User. The revision of this entity used for optimistic-locking during updates.

Returns:The revision of this User. Return type:RevisionInfo

swagger_types = {'access_policies': 'list[AccessPolicySummary]', 'configurable': 'bool', 'identifier': 'str', 'identity': 'str', 'resource_permissions': 'ResourcePermissions', 'revision': 'RevisionInfo', 'user_groups': 'list[Tenant]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

user_groups

Gets the user_groups of this User. The groups to which the user belongs.

Returns:The user_groups of this User. Return type:list[Tenant]

nipyapi.registry.models.user_group module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.user_group.UserGroup(identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, revision=None, users=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

UserGroup - a model defined in Swagger

access_policies

Gets the access_policies of this UserGroup. The access policies granted to this tenant.

Returns:The access_policies of this UserGroup. Return type:list[AccessPolicySummary]

attribute_map = {'access_policies': 'accessPolicies', 'configurable': 'configurable', 'identifier': 'identifier', 'identity': 'identity', 'resource_permissions': 'resourcePermissions', 'revision': 'revision', 'users': 'users'}

configurable

Gets the configurable of this UserGroup. Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.

Returns:The configurable of this UserGroup. Return type:bool

identifier

Gets the identifier of this UserGroup. The computer-generated identifier of the tenant.

Returns:The identifier of this UserGroup. Return type:str

identity

Gets the identity of this UserGroup. The human-facing identity of the tenant. This can only be changed if the tenant is configurable.

Returns:The identity of this UserGroup. Return type:str

resource_permissions

Gets the resource_permissions of this UserGroup. A summary top-level resource access policies granted to this tenant.

Returns:The resource_permissions of this UserGroup. Return type:ResourcePermissions

revision

Gets the revision of this UserGroup. The revision of this entity used for optimistic-locking during updates.

Returns:The revision of this UserGroup. Return type:RevisionInfo

swagger_types = {'access_policies': 'list[AccessPolicySummary]', 'configurable': 'bool', 'identifier': 'str', 'identity': 'str', 'resource_permissions': 'ResourcePermissions', 'revision': 'RevisionInfo', 'users': 'list[Tenant]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

users

Gets the users of this UserGroup. The users that belong to this user group. This can only be changed if this group is configurable.

Returns:The users of this UserGroup. Return type:list[Tenant]

nipyapi.registry.models.versioned_connection module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_connection.VersionedConnection(identifier=None, instance_identifier=None, name=None, comments=None, position=None, source=None, destination=None, label_index=None, z_index=None, selected_relationships=None, back_pressure_object_threshold=None, back_pressure_data_size_threshold=None, flow_file_expiration=None, prioritizers=None, bends=None, load_balance_strategy=None, partitioning_attribute=None, load_balance_compression=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedConnection - a model defined in Swagger

attribute_map = {'back_pressure_data_size_threshold': 'backPressureDataSizeThreshold', 'back_pressure_object_threshold': 'backPressureObjectThreshold', 'bends': 'bends', 'comments': 'comments', 'component_type': 'componentType', 'destination': 'destination', 'flow_file_expiration': 'flowFileExpiration', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'label_index': 'labelIndex', 'load_balance_compression': 'loadBalanceCompression', 'load_balance_strategy': 'loadBalanceStrategy', 'name': 'name', 'partitioning_attribute': 'partitioningAttribute', 'position': 'position', 'prioritizers': 'prioritizers', 'selected_relationships': 'selectedRelationships', 'source': 'source', 'z_index': 'zIndex'}

back_pressure_data_size_threshold

Gets the back_pressure_data_size_threshold of this VersionedConnection. The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won’t impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.

Returns:The back_pressure_data_size_threshold of this VersionedConnection. Return type:str

back_pressure_object_threshold

Gets the back_pressure_object_threshold of this VersionedConnection. The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won’t impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.

Returns:The back_pressure_object_threshold of this VersionedConnection. Return type:int

bends

Gets the bends of this VersionedConnection. The bend points on the connection.

Returns:The bends of this VersionedConnection. Return type:list[Position]

comments

Gets the comments of this VersionedConnection. The user-supplied comments for the component

Returns:The comments of this VersionedConnection. Return type:str

component_type

Gets the component_type of this VersionedConnection.

Returns:The component_type of this VersionedConnection. Return type:str

destination

Gets the destination of this VersionedConnection. The destination of the connection.

Returns:The destination of this VersionedConnection. Return type:ConnectableComponent

flow_file_expiration

Gets the flow_file_expiration of this VersionedConnection. The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it.

Returns:The flow_file_expiration of this VersionedConnection. Return type:str

group_identifier

Gets the group_identifier of this VersionedConnection. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedConnection. Return type:str

identifier

Gets the identifier of this VersionedConnection. The component’s unique identifier

Returns:The identifier of this VersionedConnection. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedConnection. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedConnection. Return type:str

label_index

Gets the label_index of this VersionedConnection. The index of the bend point where to place the connection label.

Returns:The label_index of this VersionedConnection. Return type:int

load_balance_compression

Gets the load_balance_compression of this VersionedConnection. Whether or not compression should be used when transferring FlowFiles between nodes

Returns:The load_balance_compression of this VersionedConnection. Return type:str

load_balance_strategy

Gets the load_balance_strategy of this VersionedConnection. The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.

Returns:The load_balance_strategy of this VersionedConnection. Return type:str

name

Gets the name of this VersionedConnection. The component’s name

Returns:The name of this VersionedConnection. Return type:str

partitioning_attribute

Gets the partitioning_attribute of this VersionedConnection. The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect.

Returns:The partitioning_attribute of this VersionedConnection. Return type:str

position

Gets the position of this VersionedConnection. The component’s position on the graph

Returns:The position of this VersionedConnection. Return type:Position

prioritizers

Gets the prioritizers of this VersionedConnection. The comparators used to prioritize the queue.

Returns:The prioritizers of this VersionedConnection. Return type:list[str]

selected_relationships

Gets the selected_relationships of this VersionedConnection. The selected relationship that comprise the connection.

Returns:The selected_relationships of this VersionedConnection. Return type:list[str]

source

Gets the source of this VersionedConnection. The source of the connection.

Returns:The source of this VersionedConnection. Return type:ConnectableComponent

swagger_types = {'back_pressure_data_size_threshold': 'str', 'back_pressure_object_threshold': 'int', 'bends': 'list[Position]', 'comments': 'str', 'component_type': 'str', 'destination': 'ConnectableComponent', 'flow_file_expiration': 'str', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'label_index': 'int', 'load_balance_compression': 'str', 'load_balance_strategy': 'str', 'name': 'str', 'partitioning_attribute': 'str', 'position': 'Position', 'prioritizers': 'list[str]', 'selected_relationships': 'list[str]', 'source': 'ConnectableComponent', 'z_index': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

z_index

Gets the z_index of this VersionedConnection. The z index of the connection.

Returns:The z_index of this VersionedConnection. Return type:int

nipyapi.registry.models.versioned_controller_service module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_controller_service.VersionedControllerService(identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, bundle=None, properties=None, property_descriptors=None, controller_service_apis=None, annotation_data=None, scheduled_state=None, bulletin_level=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedControllerService - a model defined in Swagger

annotation_data

Gets the annotation_data of this VersionedControllerService. The annotation for the controller service. This is how the custom UI relays configuration to the controller service.

Returns:The annotation_data of this VersionedControllerService. Return type:str

attribute_map = {'annotation_data': 'annotationData', 'bulletin_level': 'bulletinLevel', 'bundle': 'bundle', 'comments': 'comments', 'component_type': 'componentType', 'controller_service_apis': 'controllerServiceApis', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position', 'properties': 'properties', 'property_descriptors': 'propertyDescriptors', 'scheduled_state': 'scheduledState', 'type': 'type'}

bulletin_level

Gets the bulletin_level of this VersionedControllerService. The level at which the controller service will report bulletins.

Returns:The bulletin_level of this VersionedControllerService. Return type:str

bundle

Gets the bundle of this VersionedControllerService. Information about the bundle from which the component came

Returns:The bundle of this VersionedControllerService. Return type:Bundle

comments

Gets the comments of this VersionedControllerService. The user-supplied comments for the component

Returns:The comments of this VersionedControllerService. Return type:str

component_type

Gets the component_type of this VersionedControllerService.

Returns:The component_type of this VersionedControllerService. Return type:str

controller_service_apis

Gets the controller_service_apis of this VersionedControllerService. Lists the APIs this Controller Service implements.

Returns:The controller_service_apis of this VersionedControllerService. Return type:list[ControllerServiceAPI]

group_identifier

Gets the group_identifier of this VersionedControllerService. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedControllerService. Return type:str

identifier

Gets the identifier of this VersionedControllerService. The component’s unique identifier

Returns:The identifier of this VersionedControllerService. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedControllerService. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedControllerService. Return type:str

name

Gets the name of this VersionedControllerService. The component’s name

Returns:The name of this VersionedControllerService. Return type:str

position

Gets the position of this VersionedControllerService. The component’s position on the graph

Returns:The position of this VersionedControllerService. Return type:Position

properties

Gets the properties of this VersionedControllerService. The properties for the component. Properties whose value is not set will only contain the property name.

Returns:The properties of this VersionedControllerService. Return type:dict(str, str)

property_descriptors

Gets the property_descriptors of this VersionedControllerService. The property descriptors for the component.

Returns:The property_descriptors of this VersionedControllerService. Return type:dict(str, VersionedPropertyDescriptor)

scheduled_state

Gets the scheduled_state of this VersionedControllerService. The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED

Returns:The scheduled_state of this VersionedControllerService. Return type:str

swagger_types = {'annotation_data': 'str', 'bulletin_level': 'str', 'bundle': 'Bundle', 'comments': 'str', 'component_type': 'str', 'controller_service_apis': 'list[ControllerServiceAPI]', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position', 'properties': 'dict(str, str)', 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', 'scheduled_state': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this VersionedControllerService. The type of the extension component

Returns:The type of this VersionedControllerService. Return type:str

nipyapi.registry.models.versioned_flow module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_flow.VersionedFlow(link=None, identifier=None, name=None, description=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, modified_timestamp=None, type=None, permissions=None, version_count=None, revision=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlow - a model defined in Swagger

attribute_map = {'bucket_identifier': 'bucketIdentifier', 'bucket_name': 'bucketName', 'created_timestamp': 'createdTimestamp', 'description': 'description', 'identifier': 'identifier', 'link': 'link', 'modified_timestamp': 'modifiedTimestamp', 'name': 'name', 'permissions': 'permissions', 'revision': 'revision', 'type': 'type', 'version_count': 'versionCount'}

bucket_identifier

Gets the bucket_identifier of this VersionedFlow. The identifier of the bucket this items belongs to. This cannot be changed after the item is created.

Returns:The bucket_identifier of this VersionedFlow. Return type:str

bucket_name

Gets the bucket_name of this VersionedFlow. The name of the bucket this items belongs to.

Returns:The bucket_name of this VersionedFlow. Return type:str

created_timestamp

Gets the created_timestamp of this VersionedFlow. The timestamp of when the item was created, as milliseconds since epoch.

Returns:The created_timestamp of this VersionedFlow. Return type:int

description

Gets the description of this VersionedFlow. A description of the item.

Returns:The description of this VersionedFlow. Return type:str

identifier

Gets the identifier of this VersionedFlow. An ID to uniquely identify this object.

Returns:The identifier of this VersionedFlow. Return type:str

link

Gets the link of this VersionedFlow. An WebLink to this entity.

Returns:The link of this VersionedFlow. Return type:JaxbLink

modified_timestamp

Gets the modified_timestamp of this VersionedFlow. The timestamp of when the item was last modified, as milliseconds since epoch.

Returns:The modified_timestamp of this VersionedFlow. Return type:int

name

Gets the name of this VersionedFlow. The name of the item.

Returns:The name of this VersionedFlow. Return type:str

permissions

Gets the permissions of this VersionedFlow. The access that the current user has to the bucket containing this item.

Returns:The permissions of this VersionedFlow. Return type:Permissions

revision

Gets the revision of this VersionedFlow. The revision of this entity used for optimistic-locking during updates.

Returns:The revision of this VersionedFlow. Return type:RevisionInfo

swagger_types = {'bucket_identifier': 'str', 'bucket_name': 'str', 'created_timestamp': 'int', 'description': 'str', 'identifier': 'str', 'link': 'JaxbLink', 'modified_timestamp': 'int', 'name': 'str', 'permissions': 'Permissions', 'revision': 'RevisionInfo', 'type': 'str', 'version_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this VersionedFlow. The type of item.

Returns:The type of this VersionedFlow. Return type:str

version_count

Gets the version_count of this VersionedFlow. The number of versions of this flow.

Returns:The version_count of this VersionedFlow. Return type:int

nipyapi.registry.models.versioned_flow_coordinates module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_flow_coordinates.VersionedFlowCoordinates(registry_url=None, bucket_id=None, flow_id=None, version=None, latest=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlowCoordinates - a model defined in Swagger

attribute_map = {'bucket_id': 'bucketId', 'flow_id': 'flowId', 'latest': 'latest', 'registry_url': 'registryUrl', 'version': 'version'}

bucket_id

Gets the bucket_id of this VersionedFlowCoordinates. The UUID of the bucket that the flow resides in

Returns:The bucket_id of this VersionedFlowCoordinates. Return type:str

flow_id

Gets the flow_id of this VersionedFlowCoordinates. The UUID of the flow

Returns:The flow_id of this VersionedFlowCoordinates. Return type:str

latest

Gets the latest of this VersionedFlowCoordinates. Whether or not these coordinates point to the latest version of the flow

Returns:The latest of this VersionedFlowCoordinates. Return type:bool

registry_url

Gets the registry_url of this VersionedFlowCoordinates. The URL of the Flow Registry that contains the flow

Returns:The registry_url of this VersionedFlowCoordinates. Return type:str

swagger_types = {'bucket_id': 'str', 'flow_id': 'str', 'latest': 'bool', 'registry_url': 'str', 'version': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version

Gets the version of this VersionedFlowCoordinates. The version of the flow

Returns:The version of this VersionedFlowCoordinates. Return type:int

nipyapi.registry.models.versioned_flow_snapshot module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_flow_snapshot.VersionedFlowSnapshot(snapshot_metadata=None, flow_contents=None, external_controller_services=None, parameter_contexts=None, flow_encoding_version=None, flow=None, bucket=None, latest=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlowSnapshot - a model defined in Swagger

attribute_map = {'bucket': 'bucket', 'external_controller_services': 'externalControllerServices', 'flow': 'flow', 'flow_contents': 'flowContents', 'flow_encoding_version': 'flowEncodingVersion', 'latest': 'latest', 'parameter_contexts': 'parameterContexts', 'snapshot_metadata': 'snapshotMetadata'}

bucket

Gets the bucket of this VersionedFlowSnapshot. The bucket where the flow is located

Returns:The bucket of this VersionedFlowSnapshot. Return type:Bucket

external_controller_services

Gets the external_controller_services of this VersionedFlowSnapshot. The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.

Returns:The external_controller_services of this VersionedFlowSnapshot. Return type:dict(str, ExternalControllerServiceReference)

flow

Gets the flow of this VersionedFlowSnapshot. The flow this snapshot is for

Returns:The flow of this VersionedFlowSnapshot. Return type:VersionedFlow

flow_contents

Gets the flow_contents of this VersionedFlowSnapshot. The contents of the versioned flow

Returns:The flow_contents of this VersionedFlowSnapshot. Return type:VersionedProcessGroup

flow_encoding_version

Gets the flow_encoding_version of this VersionedFlowSnapshot. The optional encoding version of the flow contents.

Returns:The flow_encoding_version of this VersionedFlowSnapshot. Return type:str

latest

Gets the latest of this VersionedFlowSnapshot.

Returns:The latest of this VersionedFlowSnapshot. Return type:bool

parameter_contexts

Gets the parameter_contexts of this VersionedFlowSnapshot. The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.

Returns:The parameter_contexts of this VersionedFlowSnapshot. Return type:dict(str, VersionedParameterContext)

snapshot_metadata

Gets the snapshot_metadata of this VersionedFlowSnapshot. The metadata for this snapshot

Returns:The snapshot_metadata of this VersionedFlowSnapshot. Return type:VersionedFlowSnapshotMetadata

swagger_types = {'bucket': 'Bucket', 'external_controller_services': 'dict(str, ExternalControllerServiceReference)', 'flow': 'VersionedFlow', 'flow_contents': 'VersionedProcessGroup', 'flow_encoding_version': 'str', 'latest': 'bool', 'parameter_contexts': 'dict(str, VersionedParameterContext)', 'snapshot_metadata': 'VersionedFlowSnapshotMetadata'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.versioned_flow_snapshot_metadata module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_flow_snapshot_metadata.VersionedFlowSnapshotMetadata(link=None, bucket_identifier=None, flow_identifier=None, version=None, timestamp=None, author=None, comments=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFlowSnapshotMetadata - a model defined in Swagger

attribute_map = {'author': 'author', 'bucket_identifier': 'bucketIdentifier', 'comments': 'comments', 'flow_identifier': 'flowIdentifier', 'link': 'link', 'timestamp': 'timestamp', 'version': 'version'}

author

Gets the author of this VersionedFlowSnapshotMetadata. The user that created this snapshot of the flow.

Returns:The author of this VersionedFlowSnapshotMetadata. Return type:str

bucket_identifier

Gets the bucket_identifier of this VersionedFlowSnapshotMetadata. The identifier of the bucket this snapshot belongs to.

Returns:The bucket_identifier of this VersionedFlowSnapshotMetadata. Return type:str

comments

Gets the comments of this VersionedFlowSnapshotMetadata. The comments provided by the user when creating the snapshot.

Returns:The comments of this VersionedFlowSnapshotMetadata. Return type:str

flow_identifier

Gets the flow_identifier of this VersionedFlowSnapshotMetadata. The identifier of the flow this snapshot belongs to.

Returns:The flow_identifier of this VersionedFlowSnapshotMetadata. Return type:str

link

Gets the link of this VersionedFlowSnapshotMetadata. An WebLink to this entity.

Returns:The link of this VersionedFlowSnapshotMetadata. Return type:JaxbLink

swagger_types = {'author': 'str', 'bucket_identifier': 'str', 'comments': 'str', 'flow_identifier': 'str', 'link': 'JaxbLink', 'timestamp': 'int', 'version': 'int'}

timestamp

Gets the timestamp of this VersionedFlowSnapshotMetadata. The timestamp when the flow was saved, as milliseconds since epoch.

Returns:The timestamp of this VersionedFlowSnapshotMetadata. Return type:int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version

Gets the version of this VersionedFlowSnapshotMetadata. The version of this snapshot of the flow.

Returns:The version of this VersionedFlowSnapshotMetadata. Return type:int

nipyapi.registry.models.versioned_funnel module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_funnel.VersionedFunnel(identifier=None, instance_identifier=None, name=None, comments=None, position=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedFunnel - a model defined in Swagger

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position'}

comments

Gets the comments of this VersionedFunnel. The user-supplied comments for the component

Returns:The comments of this VersionedFunnel. Return type:str

component_type

Gets the component_type of this VersionedFunnel.

Returns:The component_type of this VersionedFunnel. Return type:str

group_identifier

Gets the group_identifier of this VersionedFunnel. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedFunnel. Return type:str

identifier

Gets the identifier of this VersionedFunnel. The component’s unique identifier

Returns:The identifier of this VersionedFunnel. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedFunnel. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedFunnel. Return type:str

name

Gets the name of this VersionedFunnel. The component’s name

Returns:The name of this VersionedFunnel. Return type:str

position

Gets the position of this VersionedFunnel. The component’s position on the graph

Returns:The position of this VersionedFunnel. Return type:Position

swagger_types = {'comments': 'str', 'component_type': 'str', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.versioned_label module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_label.VersionedLabel(identifier=None, instance_identifier=None, name=None, comments=None, position=None, label=None, z_index=None, width=None, height=None, style=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedLabel - a model defined in Swagger

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'height': 'height', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'label': 'label', 'name': 'name', 'position': 'position', 'style': 'style', 'width': 'width', 'z_index': 'zIndex'}

comments

Gets the comments of this VersionedLabel. The user-supplied comments for the component

Returns:The comments of this VersionedLabel. Return type:str

component_type

Gets the component_type of this VersionedLabel.

Returns:The component_type of this VersionedLabel. Return type:str

group_identifier

Gets the group_identifier of this VersionedLabel. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedLabel. Return type:str

height

Gets the height of this VersionedLabel. The height of the label in pixels when at a 1:1 scale.

Returns:The height of this VersionedLabel. Return type:float

identifier

Gets the identifier of this VersionedLabel. The component’s unique identifier

Returns:The identifier of this VersionedLabel. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedLabel. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedLabel. Return type:str

label

Gets the label of this VersionedLabel. The text that appears in the label.

Returns:The label of this VersionedLabel. Return type:str

name

Gets the name of this VersionedLabel. The component’s name

Returns:The name of this VersionedLabel. Return type:str

position

Gets the position of this VersionedLabel. The component’s position on the graph

Returns:The position of this VersionedLabel. Return type:Position

style

Gets the style of this VersionedLabel. The styles for this label (font-size : 12px, background-color : #eee, etc).

Returns:The style of this VersionedLabel. Return type:dict(str, str)

swagger_types = {'comments': 'str', 'component_type': 'str', 'group_identifier': 'str', 'height': 'float', 'identifier': 'str', 'instance_identifier': 'str', 'label': 'str', 'name': 'str', 'position': 'Position', 'style': 'dict(str, str)', 'width': 'float', 'z_index': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

width

Gets the width of this VersionedLabel. The width of the label in pixels when at a 1:1 scale.

Returns:The width of this VersionedLabel. Return type:float

z_index

Gets the z_index of this VersionedLabel. The z index of the connection.

Returns:The z_index of this VersionedLabel. Return type:int

nipyapi.registry.models.versioned_port module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_port.VersionedPort(identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, concurrently_schedulable_task_count=None, scheduled_state=None, allow_remote_access=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedPort - a model defined in Swagger

allow_remote_access

Gets the allow_remote_access of this VersionedPort. Whether or not this port allows remote access for site-to-site

Returns:The allow_remote_access of this VersionedPort. Return type:bool

attribute_map = {'allow_remote_access': 'allowRemoteAccess', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position', 'scheduled_state': 'scheduledState', 'type': 'type'}

comments

Gets the comments of this VersionedPort. The user-supplied comments for the component

Returns:The comments of this VersionedPort. Return type:str

component_type

Gets the component_type of this VersionedPort.

Returns:The component_type of this VersionedPort. Return type:str

concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this VersionedPort. The number of tasks that should be concurrently scheduled for the port.

Returns:The concurrently_schedulable_task_count of this VersionedPort. Return type:int

group_identifier

Gets the group_identifier of this VersionedPort. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedPort. Return type:str

identifier

Gets the identifier of this VersionedPort. The component’s unique identifier

Returns:The identifier of this VersionedPort. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedPort. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedPort. Return type:str

name

Gets the name of this VersionedPort. The component’s name

Returns:The name of this VersionedPort. Return type:str

position

Gets the position of this VersionedPort. The component’s position on the graph

Returns:The position of this VersionedPort. Return type:Position

scheduled_state

Gets the scheduled_state of this VersionedPort. The scheduled state of the component

Returns:The scheduled_state of this VersionedPort. Return type:str

swagger_types = {'allow_remote_access': 'bool', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position', 'scheduled_state': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this VersionedPort. The type of port.

Returns:The type of this VersionedPort. Return type:str

nipyapi.registry.models.versioned_process_group module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_process_group.VersionedProcessGroup(identifier=None, instance_identifier=None, name=None, comments=None, position=None, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None, controller_services=None, versioned_flow_coordinates=None, variables=None, parameter_context_name=None, default_flow_file_expiration=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None, component_type=None, flow_file_concurrency=None, flow_file_outbound_policy=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedProcessGroup - a model defined in Swagger

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'connections': 'connections', 'controller_services': 'controllerServices', 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', 'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', 'default_flow_file_expiration': 'defaultFlowFileExpiration', 'flow_file_concurrency': 'flowFileConcurrency', 'flow_file_outbound_policy': 'flowFileOutboundPolicy', 'funnels': 'funnels', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'input_ports': 'inputPorts', 'instance_identifier': 'instanceIdentifier', 'labels': 'labels', 'name': 'name', 'output_ports': 'outputPorts', 'parameter_context_name': 'parameterContextName', 'position': 'position', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups', 'variables': 'variables', 'versioned_flow_coordinates': 'versionedFlowCoordinates'}

comments

Gets the comments of this VersionedProcessGroup. The user-supplied comments for the component

Returns:The comments of this VersionedProcessGroup. Return type:str

component_type

Gets the component_type of this VersionedProcessGroup.

Returns:The component_type of this VersionedProcessGroup. Return type:str

connections

Gets the connections of this VersionedProcessGroup. The Connections

Returns:The connections of this VersionedProcessGroup. Return type:list[VersionedConnection]

controller_services

Gets the controller_services of this VersionedProcessGroup. The Controller Services

Returns:The controller_services of this VersionedProcessGroup. Return type:list[VersionedControllerService]

default_back_pressure_data_size_threshold

Gets the default_back_pressure_data_size_threshold of this VersionedProcessGroup. Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied.

Returns:The default_back_pressure_data_size_threshold of this VersionedProcessGroup. Return type:str

default_back_pressure_object_threshold

Gets the default_back_pressure_object_threshold of this VersionedProcessGroup. Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied.

Returns:The default_back_pressure_object_threshold of this VersionedProcessGroup. Return type:int

default_flow_file_expiration

Gets the default_flow_file_expiration of this VersionedProcessGroup. The default FlowFile Expiration for this Process Group.

Returns:The default_flow_file_expiration of this VersionedProcessGroup. Return type:str

flow_file_concurrency

Gets the flow_file_concurrency of this VersionedProcessGroup. The configured FlowFile Concurrency for the Process Group

Returns:The flow_file_concurrency of this VersionedProcessGroup. Return type:str

flow_file_outbound_policy

Gets the flow_file_outbound_policy of this VersionedProcessGroup. The FlowFile Outbound Policy for the Process Group

Returns:The flow_file_outbound_policy of this VersionedProcessGroup. Return type:str

funnels

Gets the funnels of this VersionedProcessGroup. The Funnels

Returns:The funnels of this VersionedProcessGroup. Return type:list[VersionedFunnel]

group_identifier

Gets the group_identifier of this VersionedProcessGroup. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedProcessGroup. Return type:str

identifier

Gets the identifier of this VersionedProcessGroup. The component’s unique identifier

Returns:The identifier of this VersionedProcessGroup. Return type:str

input_ports

Gets the input_ports of this VersionedProcessGroup. The Input Ports

Returns:The input_ports of this VersionedProcessGroup. Return type:list[VersionedPort]

instance_identifier

Gets the instance_identifier of this VersionedProcessGroup. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedProcessGroup. Return type:str

labels

Gets the labels of this VersionedProcessGroup. The Labels

Returns:The labels of this VersionedProcessGroup. Return type:list[VersionedLabel]

name

Gets the name of this VersionedProcessGroup. The component’s name

Returns:The name of this VersionedProcessGroup. Return type:str

output_ports

Gets the output_ports of this VersionedProcessGroup. The Output Ports

Returns:The output_ports of this VersionedProcessGroup. Return type:list[VersionedPort]

parameter_context_name

Gets the parameter_context_name of this VersionedProcessGroup. The name of the parameter context used by this process group

Returns:The parameter_context_name of this VersionedProcessGroup. Return type:str

position

Gets the position of this VersionedProcessGroup. The component’s position on the graph

Returns:The position of this VersionedProcessGroup. Return type:Position

process_groups

Gets the process_groups of this VersionedProcessGroup. The child Process Groups

Returns:The process_groups of this VersionedProcessGroup. Return type:list[VersionedProcessGroup]

processors

Gets the processors of this VersionedProcessGroup. The Processors

Returns:The processors of this VersionedProcessGroup. Return type:list[VersionedProcessor]

remote_process_groups

Gets the remote_process_groups of this VersionedProcessGroup. The Remote Process Groups

Returns:The remote_process_groups of this VersionedProcessGroup. Return type:list[VersionedRemoteProcessGroup]

swagger_types = {'comments': 'str', 'component_type': 'str', 'connections': 'list[VersionedConnection]', 'controller_services': 'list[VersionedControllerService]', 'default_back_pressure_data_size_threshold': 'str', 'default_back_pressure_object_threshold': 'int', 'default_flow_file_expiration': 'str', 'flow_file_concurrency': 'str', 'flow_file_outbound_policy': 'str', 'funnels': 'list[VersionedFunnel]', 'group_identifier': 'str', 'identifier': 'str', 'input_ports': 'list[VersionedPort]', 'instance_identifier': 'str', 'labels': 'list[VersionedLabel]', 'name': 'str', 'output_ports': 'list[VersionedPort]', 'parameter_context_name': 'str', 'position': 'Position', 'process_groups': 'list[VersionedProcessGroup]', 'processors': 'list[VersionedProcessor]', 'remote_process_groups': 'list[VersionedRemoteProcessGroup]', 'variables': 'dict(str, str)', 'versioned_flow_coordinates': 'VersionedFlowCoordinates'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variables

Gets the variables of this VersionedProcessGroup. The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)

Returns:The variables of this VersionedProcessGroup. Return type:dict(str, str)

versioned_flow_coordinates

Gets the versioned_flow_coordinates of this VersionedProcessGroup. The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control

Returns:The versioned_flow_coordinates of this VersionedProcessGroup. Return type:VersionedFlowCoordinates

nipyapi.registry.models.versioned_processor module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_processor.VersionedProcessor(identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, bundle=None, properties=None, property_descriptors=None, style=None, annotation_data=None, scheduling_period=None, scheduling_strategy=None, execution_node=None, penalty_duration=None, yield_duration=None, bulletin_level=None, run_duration_millis=None, concurrently_schedulable_task_count=None, auto_terminated_relationships=None, scheduled_state=None, retry_count=None, retried_relationships=None, backoff_mechanism=None, max_backoff_period=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedProcessor - a model defined in Swagger

annotation_data

Gets the annotation_data of this VersionedProcessor. The annotation data for the processor used to relay configuration between a custom UI and the procesosr.

Returns:The annotation_data of this VersionedProcessor. Return type:str

attribute_map = {'annotation_data': 'annotationData', 'auto_terminated_relationships': 'autoTerminatedRelationships', 'backoff_mechanism': 'backoffMechanism', 'bulletin_level': 'bulletinLevel', 'bundle': 'bundle', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'execution_node': 'executionNode', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'max_backoff_period': 'maxBackoffPeriod', 'name': 'name', 'penalty_duration': 'penaltyDuration', 'position': 'position', 'properties': 'properties', 'property_descriptors': 'propertyDescriptors', 'retried_relationships': 'retriedRelationships', 'retry_count': 'retryCount', 'run_duration_millis': 'runDurationMillis', 'scheduled_state': 'scheduledState', 'scheduling_period': 'schedulingPeriod', 'scheduling_strategy': 'schedulingStrategy', 'style': 'style', 'type': 'type', 'yield_duration': 'yieldDuration'}

auto_terminated_relationships

Gets the auto_terminated_relationships of this VersionedProcessor. The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the ‘isAutoTerminate’ property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.

Returns:The auto_terminated_relationships of this VersionedProcessor. Return type:list[str]

backoff_mechanism

Gets the backoff_mechanism of this VersionedProcessor. Determines whether the FlowFile should be penalized or the processor should be yielded between retries.

Returns:The backoff_mechanism of this VersionedProcessor. Return type:str

bulletin_level

Gets the bulletin_level of this VersionedProcessor. The level at which the processor will report bulletins.

Returns:The bulletin_level of this VersionedProcessor. Return type:str

bundle

Gets the bundle of this VersionedProcessor. Information about the bundle from which the component came

Returns:The bundle of this VersionedProcessor. Return type:Bundle

comments

Gets the comments of this VersionedProcessor. The user-supplied comments for the component

Returns:The comments of this VersionedProcessor. Return type:str

component_type

Gets the component_type of this VersionedProcessor.

Returns:The component_type of this VersionedProcessor. Return type:str

concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this VersionedProcessor. The number of tasks that should be concurrently schedule for the processor. If the processor doesn’t allow parallol processing then any positive input will be ignored.

Returns:The concurrently_schedulable_task_count of this VersionedProcessor. Return type:int

execution_node

Gets the execution_node of this VersionedProcessor. Indicates the node where the process will execute.

Returns:The execution_node of this VersionedProcessor. Return type:str

group_identifier

Gets the group_identifier of this VersionedProcessor. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedProcessor. Return type:str

identifier

Gets the identifier of this VersionedProcessor. The component’s unique identifier

Returns:The identifier of this VersionedProcessor. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedProcessor. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedProcessor. Return type:str

max_backoff_period

Gets the max_backoff_period of this VersionedProcessor. Maximum amount of time to be waited during a retry period.

Returns:The max_backoff_period of this VersionedProcessor. Return type:str

name

Gets the name of this VersionedProcessor. The component’s name

Returns:The name of this VersionedProcessor. Return type:str

penalty_duration

Gets the penalty_duration of this VersionedProcessor. The amout of time that is used when the process penalizes a flowfile.

Returns:The penalty_duration of this VersionedProcessor. Return type:str

position

Gets the position of this VersionedProcessor. The component’s position on the graph

Returns:The position of this VersionedProcessor. Return type:Position

properties

Gets the properties of this VersionedProcessor. The properties for the component. Properties whose value is not set will only contain the property name.

Returns:The properties of this VersionedProcessor. Return type:dict(str, str)

property_descriptors

Gets the property_descriptors of this VersionedProcessor. The property descriptors for the component.

Returns:The property_descriptors of this VersionedProcessor. Return type:dict(str, VersionedPropertyDescriptor)

retried_relationships

Gets the retried_relationships of this VersionedProcessor. All the relationships should be retried.

Returns:The retried_relationships of this VersionedProcessor. Return type:list[str]

retry_count

Gets the retry_count of this VersionedProcessor. Overall number of retries.

Returns:The retry_count of this VersionedProcessor. Return type:int

run_duration_millis

Gets the run_duration_millis of this VersionedProcessor. The run duration for the processor in milliseconds.

Returns:The run_duration_millis of this VersionedProcessor. Return type:int

scheduled_state

Gets the scheduled_state of this VersionedProcessor. The scheduled state of the component

Returns:The scheduled_state of this VersionedProcessor. Return type:str

scheduling_period

Gets the scheduling_period of this VersionedProcessor. The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy.

Returns:The scheduling_period of this VersionedProcessor. Return type:str

scheduling_strategy

Gets the scheduling_strategy of this VersionedProcessor. Indicates whether the processor should be scheduled to run in event or timer driven mode.

Returns:The scheduling_strategy of this VersionedProcessor. Return type:str

style

Gets the style of this VersionedProcessor. Stylistic data for rendering in a UI

Returns:The style of this VersionedProcessor. Return type:dict(str, str)

swagger_types = {'annotation_data': 'str', 'auto_terminated_relationships': 'list[str]', 'backoff_mechanism': 'str', 'bulletin_level': 'str', 'bundle': 'Bundle', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'execution_node': 'str', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'max_backoff_period': 'str', 'name': 'str', 'penalty_duration': 'str', 'position': 'Position', 'properties': 'dict(str, str)', 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', 'retried_relationships': 'list[str]', 'retry_count': 'int', 'run_duration_millis': 'int', 'scheduled_state': 'str', 'scheduling_period': 'str', 'scheduling_strategy': 'str', 'style': 'dict(str, str)', 'type': 'str', 'yield_duration': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this VersionedProcessor. The type of the extension component

Returns:The type of this VersionedProcessor. Return type:str

yield_duration

Gets the yield_duration of this VersionedProcessor. The amount of time that must elapse before this processor is scheduled again after yielding.

Returns:The yield_duration of this VersionedProcessor. Return type:str

nipyapi.registry.models.versioned_property_descriptor module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_property_descriptor.VersionedPropertyDescriptor(name=None, display_name=None, identifies_controller_service=None, sensitive=None, resource_definition=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedPropertyDescriptor - a model defined in Swagger

attribute_map = {'display_name': 'displayName', 'identifies_controller_service': 'identifiesControllerService', 'name': 'name', 'resource_definition': 'resourceDefinition', 'sensitive': 'sensitive'}

display_name

Gets the display_name of this VersionedPropertyDescriptor. The display name of the property

Returns:The display_name of this VersionedPropertyDescriptor. Return type:str

identifies_controller_service

Gets the identifies_controller_service of this VersionedPropertyDescriptor. Whether or not the property provides the identifier of a Controller Service

Returns:The identifies_controller_service of this VersionedPropertyDescriptor. Return type:bool

name

Gets the name of this VersionedPropertyDescriptor. The name of the property

Returns:The name of this VersionedPropertyDescriptor. Return type:str

resource_definition

Gets the resource_definition of this VersionedPropertyDescriptor. Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any

Returns:The resource_definition of this VersionedPropertyDescriptor. Return type:VersionedResourceDefinition

sensitive

Gets the sensitive of this VersionedPropertyDescriptor. Whether or not the property is considered sensitive

Returns:The sensitive of this VersionedPropertyDescriptor. Return type:bool

swagger_types = {'display_name': 'str', 'identifies_controller_service': 'bool', 'name': 'str', 'resource_definition': 'VersionedResourceDefinition', 'sensitive': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.versioned_remote_group_port module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_remote_group_port.VersionedRemoteGroupPort(identifier=None, instance_identifier=None, name=None, comments=None, position=None, remote_group_id=None, concurrently_schedulable_task_count=None, use_compression=None, batch_size=None, component_type=None, target_id=None, scheduled_state=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedRemoteGroupPort - a model defined in Swagger

attribute_map = {'batch_size': 'batchSize', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position', 'remote_group_id': 'remoteGroupId', 'scheduled_state': 'scheduledState', 'target_id': 'targetId', 'use_compression': 'useCompression'}

batch_size

Gets the batch_size of this VersionedRemoteGroupPort. The batch settings for data transmission.

Returns:The batch_size of this VersionedRemoteGroupPort. Return type:BatchSize

comments

Gets the comments of this VersionedRemoteGroupPort. The user-supplied comments for the component

Returns:The comments of this VersionedRemoteGroupPort. Return type:str

component_type

Gets the component_type of this VersionedRemoteGroupPort.

Returns:The component_type of this VersionedRemoteGroupPort. Return type:str

concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this VersionedRemoteGroupPort. The number of task that may transmit flowfiles to the target port concurrently.

Returns:The concurrently_schedulable_task_count of this VersionedRemoteGroupPort. Return type:int

group_identifier

Gets the group_identifier of this VersionedRemoteGroupPort. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedRemoteGroupPort. Return type:str

identifier

Gets the identifier of this VersionedRemoteGroupPort. The component’s unique identifier

Returns:The identifier of this VersionedRemoteGroupPort. Return type:str

instance_identifier

Gets the instance_identifier of this VersionedRemoteGroupPort. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedRemoteGroupPort. Return type:str

name

Gets the name of this VersionedRemoteGroupPort. The component’s name

Returns:The name of this VersionedRemoteGroupPort. Return type:str

position

Gets the position of this VersionedRemoteGroupPort. The component’s position on the graph

Returns:The position of this VersionedRemoteGroupPort. Return type:Position

remote_group_id

Gets the remote_group_id of this VersionedRemoteGroupPort. The id of the remote process group that the port resides in.

Returns:The remote_group_id of this VersionedRemoteGroupPort. Return type:str

scheduled_state

Gets the scheduled_state of this VersionedRemoteGroupPort. The scheduled state of the component

Returns:The scheduled_state of this VersionedRemoteGroupPort. Return type:str

swagger_types = {'batch_size': 'BatchSize', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position', 'remote_group_id': 'str', 'scheduled_state': 'str', 'target_id': 'str', 'use_compression': 'bool'}

target_id

Gets the target_id of this VersionedRemoteGroupPort. The ID of the port on the target NiFi instance

Returns:The target_id of this VersionedRemoteGroupPort. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

use_compression

Gets the use_compression of this VersionedRemoteGroupPort. Whether the flowfiles are compressed when sent to the target port.

Returns:The use_compression of this VersionedRemoteGroupPort. Return type:bool

nipyapi.registry.models.versioned_remote_process_group module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.models.versioned_remote_process_group.VersionedRemoteProcessGroup(identifier=None, instance_identifier=None, name=None, comments=None, position=None, target_uri=None, target_uris=None, communications_timeout=None, yield_duration=None, transport_protocol=None, local_network_interface=None, proxy_host=None, proxy_port=None, proxy_user=None, input_ports=None, output_ports=None, component_type=None, group_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

VersionedRemoteProcessGroup - a model defined in Swagger

attribute_map = {'comments': 'comments', 'communications_timeout': 'communicationsTimeout', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'input_ports': 'inputPorts', 'instance_identifier': 'instanceIdentifier', 'local_network_interface': 'localNetworkInterface', 'name': 'name', 'output_ports': 'outputPorts', 'position': 'position', 'proxy_host': 'proxyHost', 'proxy_port': 'proxyPort', 'proxy_user': 'proxyUser', 'target_uri': 'targetUri', 'target_uris': 'targetUris', 'transport_protocol': 'transportProtocol', 'yield_duration': 'yieldDuration'}

comments

Gets the comments of this VersionedRemoteProcessGroup. The user-supplied comments for the component

Returns:The comments of this VersionedRemoteProcessGroup. Return type:str

communications_timeout

Gets the communications_timeout of this VersionedRemoteProcessGroup. The time period used for the timeout when communicating with the target.

Returns:The communications_timeout of this VersionedRemoteProcessGroup. Return type:str

component_type

Gets the component_type of this VersionedRemoteProcessGroup.

Returns:The component_type of this VersionedRemoteProcessGroup. Return type:str

group_identifier

Gets the group_identifier of this VersionedRemoteProcessGroup. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedRemoteProcessGroup. Return type:str

identifier

Gets the identifier of this VersionedRemoteProcessGroup. The component’s unique identifier

Returns:The identifier of this VersionedRemoteProcessGroup. Return type:str

input_ports

Gets the input_ports of this VersionedRemoteProcessGroup. A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance

Returns:The input_ports of this VersionedRemoteProcessGroup. Return type:list[VersionedRemoteGroupPort]

instance_identifier

Gets the instance_identifier of this VersionedRemoteProcessGroup. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this VersionedRemoteProcessGroup. Return type:str

local_network_interface

Gets the local_network_interface of this VersionedRemoteProcessGroup. The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier.

Returns:The local_network_interface of this VersionedRemoteProcessGroup. Return type:str

name

Gets the name of this VersionedRemoteProcessGroup. The component’s name

Returns:The name of this VersionedRemoteProcessGroup. Return type:str

output_ports

Gets the output_ports of this VersionedRemoteProcessGroup. A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance

Returns:The output_ports of this VersionedRemoteProcessGroup. Return type:list[VersionedRemoteGroupPort]

position

Gets the position of this VersionedRemoteProcessGroup. The component’s position on the graph

Returns:The position of this VersionedRemoteProcessGroup. Return type:Position

proxy_host

Gets the proxy_host of this VersionedRemoteProcessGroup.

Returns:The proxy_host of this VersionedRemoteProcessGroup. Return type:str

proxy_port

Gets the proxy_port of this VersionedRemoteProcessGroup.

Returns:The proxy_port of this VersionedRemoteProcessGroup. Return type:int

proxy_user

Gets the proxy_user of this VersionedRemoteProcessGroup.

Returns:The proxy_user of this VersionedRemoteProcessGroup. Return type:str

swagger_types = {'comments': 'str', 'communications_timeout': 'str', 'component_type': 'str', 'group_identifier': 'str', 'identifier': 'str', 'input_ports': 'list[VersionedRemoteGroupPort]', 'instance_identifier': 'str', 'local_network_interface': 'str', 'name': 'str', 'output_ports': 'list[VersionedRemoteGroupPort]', 'position': 'Position', 'proxy_host': 'str', 'proxy_port': 'int', 'proxy_user': 'str', 'target_uri': 'str', 'target_uris': 'str', 'transport_protocol': 'str', 'yield_duration': 'str'}

target_uri

Gets the target_uri of this VersionedRemoteProcessGroup. [DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null.

Returns:The target_uri of this VersionedRemoteProcessGroup. Return type:str

target_uris

Gets the target_uris of this VersionedRemoteProcessGroup. The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null.

Returns:The target_uris of this VersionedRemoteProcessGroup. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transport_protocol

Gets the transport_protocol of this VersionedRemoteProcessGroup. The Transport Protocol that is used for Site-to-Site communications

Returns:The transport_protocol of this VersionedRemoteProcessGroup. Return type:str

yield_duration

Gets the yield_duration of this VersionedRemoteProcessGroup. When yielding, this amount of time must elapse before the remote process group is scheduled again.

Returns:The yield_duration of this VersionedRemoteProcessGroup. Return type:str

Submodules

nipyapi.registry.api_client module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.api_client.ApiClient(host=None, header_name=None, header_value=None, cookie=None)

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)

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)

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)

Deserializes list or dict to model.

Parameters:

• data – dict, list.
• klass – class literal.

Returns:

model object.

parameters_to_tuples(params, collection_formats)

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)

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)

Makes the HTTP request using RESTClient.

sanitize_for_serialization(obj)

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)

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)

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).

set_default_header(header_name, header_value)

update_params_for_auth(headers, querys, auth_settings)

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.registry.configuration module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

nipyapi.registry.configuration.Configuration()

nipyapi.registry.configuration.singleton(cls, *args, **kw)

nipyapi.registry.rest module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

OpenAPI spec version: 1.17.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

exception nipyapi.registry.rest.ApiException(status=None, reason=None, http_resp=None)

Bases: Exception

class nipyapi.registry.rest.RESTClientObject(pools_size=4, maxsize=4)

Bases: object

DELETE(url, headers=None, query_params=None, body=None, _preload_content=True, _request_timeout=None)

GET(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)

HEAD(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)

OPTIONS(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

PATCH(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

POST(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

PUT(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

request(method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None)

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.

class nipyapi.registry.rest.RESTResponse(resp)

Bases: io.IOBase

getheader(name, default=None)

Returns a given response header.

getheaders()

Returns a dictionary of the response headers.

ToDo

• Bring accross features from https://github.com/pvillard31/nifi-api-client-python
• Bring across features from https://github.com/jdye64/nifi-shell
• Look into how sensitive properties are handled on template import
• Add a depth limit to the recursion on the canvas flow fetcher
• Add specific ‘secure mode’ switch which allows commands to run with simple defaults
• https://community.hortonworks.com/articles/56849/automate-deployment-of-hdf-20-clusters-using-ambar.html
• https://github.com/hayanige/docker-nifi-cluster
• Set enforcement of ProcessGroup best practice like unique template names
• Create Ansible wrappers for executing against Yaml
• Create more deterministic deploy/reset/kill controls for Demo/Test fixtures
• Setup regression testing to handle forward version logic

Please see the issue register for more information on current development.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/Chaffelson/nipyapi/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

Nipyapi could always use more documentation, whether as part of the official Nipyapi docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/Chaffelson/nipyapi/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up nipyapi for local development.

1. Fork the nipyapi repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:Chaffelson/nipyapi.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv nipyapi
   $ cd nipyapi/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. You may want to leverage the provided Docker configuration for testing and development

• Install the latest version of Docker

• Use the provided Docker Compose configuration in ./resources/docker/latest and run the tests:

  $ cd resources/docker/latest
  $ docker-compose up -d
  $ cd ../../../
  $ tox
  $ cd resources/docker/latest
  $ docker-compose stop
  

6. You may also want to interactively test your code leveraging the convenience console in the demo package:

   $ python
   > from nipyapi.demo.console import *
   

7. When you’re done making changes, check that your changes pass the tests, including testing other Python versions, with tox:

   $ tox
   

8. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

9. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.7 and 3.6, and for PyPy. Check https://travis-ci.org/Chaffelson/nipyapi/pull_requests and make sure that the tests pass for all supported Python versions.
4. Pull requests should be created against the ‘next’ branch for new features, or ‘master’ for critical patches to current functionality.

Development Notes

A collection point for information about the development process for future collaborators

Decision Points

• Using Swagger 2.0 instead of OpenAPI3.0 as it (currently as of Aug2017) has wider adoption and completed codegen tools
• We use Google style Docstrings to better enable Sphinx to produce nicely readable documentation

Testing Notes

When running tests on new code, you are advised to run ‘test_default’ first, then ‘test_regression’, then finally ‘test_security’. Because of the way errors are propagated you may have code failures which cause a teardown which then fails because of security controls, which can then obscure the original error.

Docker Test Environment

There is an Apache NiFi image available on Dockerhub:

docker pull apache/nifi:latest

There are a couple of configuration files for launching various Docker environment configurations in ./test_env_config for convenience.

Remote Testing on Centos7

Deploy a 4x16 or better on EC2 running Centos 7.5 or better, ssh in as root:

yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
yum update -y
yum install -y centos-release-scl yum-utils device-mapper-persistent-data lvm2
yum install -y rh-python36 docker-ce docker-ce-cli containerd.io
systemctl start docker
scl enable rh-python36 bash
sudo curl -L "https://github.com/docker/compose/releases/download/1.25.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

Set up remote execution environment to this server from your IDE, such as PyCharm. Python3 will be in a path like /opt/rh/rh-python36/root/usr/bin/python These commands are conveniently presented in /resources/test_setup/setup_centos7.sh

You will then want to open up /home/centos/tmp/<pycharmprojectname>/resources/docker/tox-full and run:

docker-compose pull
docker-compose up -d

Testing on OSX

There is a known issue with testing newer versions of Python on OSX. You may receive an error reporting [SSL: CERTIFICATE_VERIFY_FAILED] when trying to install packages from Pypi

You can fix this by running the following commands:

export PIP_REQUIRE_VIRTUALENV=false
/Applications/Python\ 3.6/Install\ Certificates.command

Generate Swagger Client

The NiFi and NiFi Registry REST API clients are generated using swagger-codegen, which is available via a variety of methods:

• the package manager for your OS
• github: https://github.com/swagger-api/swagger-codegen
• maven: http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.3.1/swagger-codegen-cli-2.3.1.jar
• pre-built Docker images on DockerHub (https://hub.docker.com/r/swaggerapi/swagger-codegen-cli/)

In the examples below, we’ll use Homebrew for macOS:

brew install swagger-codegen

NiFi Swagger Client

1. build relevant version of NiFi from source

2. use swagger-codegen to generate the Python client:

   mkdir -p ~/tmp && \
   echo '{ "packageName": "nifi" }' > ~/tmp/swagger-nifi-python-config.json && \
   rm -rf ~/tmp/nifi-python-client && \
   swagger-codegen generate \
       --lang python \
       --config swagger-nifi-python-config.json \
       --api-package apis \
       --model-package models \
       --template-dir /path/to/nipyapi/swagger_templates \
       --input-spec /path/to/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/target/swagger-ui/swagger.json \
       --output ~/tmp/nifi-python-client
   

3. replace the embedded clients:

   rm -rf /path/to/nipyapi/nipyapi/nifi && cp -rf ~/tmp/nifi-python-client/nifi /path/to/nipyapi/nipyapi/nifi
   

4. review the changes and submit a PR!

NiFi Registry Swagger Client

1. Fetch the definition from a running Registry instance at URI: /nifi-registry-api/swagger/swagger.json

2. use swagger-codegen to generate the Python client:

   mkdir -p ~/tmp && \
   echo '{ "packageName": "registry" }' > ~/tmp/swagger-registry-python-config.json && \
   rm -rf ~/tmp/nifi-registry-python-client && \
   swagger-codegen generate \
       --lang python \
       --config swagger-registry-python-config.json \
       --api-package apis \
       --model-package models \
       --template-dir /path/to/nipyapi/swagger_templates \
       --input-spec /path/to/nifi-registry/nifi-registry-web-api/target/swagger-ui/swagger.json \
       --output ~/tmp/nifi-registry-python-client
   

3. replace the embedded clients:

   rm -r /path/to/nipyapi/nipyapi/registry && cp -rf /tmp/nifi-registry-python-client/swagger_client /path/to/nipyapi/nipyapi/registry
   

4. review the changes and submit a PR!

Release Process

This assumes you have virtualenvwrapper, git, and appropriate python versions installed, as well as the necessary test environment:

• update History.rst

• check setup.py

• check requirements.txt and requirements_dev.txt

• Commit all changes

• in bash:

  cd ProjectDir
  source ./my_virtualenv/bin/activate
  bumpversion patch|minor|major
  python setup.py develop
  tox
  python setup.py test
  python setup.py build_sphinx
  # check docs in build/sphinx/html/index.html
  python setup.py sdist bdist_wheel
  mktmpenv  # or pyenv virtualenvwrapper mktmpenv if using pyenv
  pip install path/to/nipyapi-0.3.1-py2.py3-none-any.whl  # for example
  # Run appropriate tests, such as usage tests etc.
  deactivate
  Push changes to Github
  Check build on TravisCI
  Check dockerhub automated build
  # You may have to reactivate your original virtualenv
  twine upload dist/*
  # You may get a file exists error, check you're not trying to reupload an existing version
  git push --tags
  

• check build in TravisCI

• check docs on ReadTheDocs

• check release published on Github and PyPi

Credits

Development Lead

• Daniel Chaffelson <chaffelson@gmail.com>

Contributors

Kevin Doran <kdoran@apache.org>

Shout Outs

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template

Inspired by the equivalent Java client maintained over at hermannpencole/nifi-config

The swagger 2.0 compliant client auto-generated using the Swagger Codegen project, and then cleaned / bugfixed by the authors

Props to the NiFi-dev and NiFi-user mailing list members over at Apache for all the assistance and kindnesses.

History

0.19.1 (2022-08-08)

Updated client for NiFi & Registry 1.17.0 release

• Update docker resources to the latest 1.17 container image
• Fix issue in docker volume mounts where certificates were not readable in new versions of Docker
• Fix issue in test_get_processor_type where new Twitter processor broke existing logic assumptions
• Update readme to note issues with Python 3.10 and removing reference to python 3.5 testing

0.19.0 (2022-05-13)

Updated client for NiFi & Registry 1.16.0 release

• Modify utils.check_version to accept a default version to check against, and remove nested error when version check fails as it is overzealous
• Update test file paths in test_utils in case someone runs tests as root which actually can write to fake devices and therefore break the tests
• Added pylint exclusions for known but unimportant complaints
• Added workaround for NiFi 9470 by providing default inherited_parameter_contexts per advice from Chris Sampson in NiPyAPI Issue #305
• Updated NiFi and Registry versions in Docker compose configs to use latest 1.16.1 builds

0.18.0 (2021-11-29)

Updated client for NiFi & Registry 1.15.0 release

• Moved testing to secured single user by default for NiFi
• Consolidated clients to the 1.15.0 release version for both NiFi and Registry
• Updated logic to support changed working modes in tests
• Corrected minor functional issues for 1.15 in login handling, SSL certs, Parameter Updates and Testing
• Backwards compatibility and Regression tested as requiring no breaking changes

0.17.1 (2021-10-21)

Added gzip as default request header (PR from rsaggino)

Update ruamel.yaml to 0.17.16

Update file read/write to explicitly handle encoding, default to UTF8, configurable in nipyapi.config

Linting and style changes to update to Python 3.9 standards, except where it would break backwards compatibility to Python 2.7

Test support for Amazon Linux 2, mostly better error handling for filesystem responses

0.17.0 (2021-10-13)

Updated NiFi version and client to 1.13.2

Updated NiFi-Registry version and client to 0.8.0

• Note that these are the last versions where NiFi and NiFi-Registry are separate codebases

0.16.3 (2021-10-11)

Removed force reset of configuration.password and configuration.username to empty string. This was not increasing security, and was causing unexpected errors for users connecting to multiple services in a single script.

Add greedy control to versioning.get_registry_bucket and versioning.get_flow_in_bucket to avoid undesirable partial string match.

• Update readme to reflect switch from ‘master’ branch naming to ‘main’.
• Update tox to pin testing to Python 3.8, as Python 3.9 is producing unexpected and unrelated SSL failures
• Minor lint formatting improvements

0.16.2 (2021-02-10)

NOTE: If you are using secured Registry, this release will enforce access controls for the swagger interface which is used to determine which version of Registry is connected in order to correctly provide features - you may have to update your authorizations

• Update requirements.txt to unpin future and lxml
• Update lxml to 4.6.2 or newer to resolve vulnerability
• Pin watchdog to <1.0.0 per their docs to maintain Python2.7 compatibility
• Revert 0.14.3 changes to Authentication handling which introduced basicAuth support but resulted in some NiFi connections appearing incorrectly as Anonymous
• Added simpler basicAuth control to force it via a config switch without changing tokenAuth and other Authorization header behavior during normal usage
• nipyapi.config.global_force_basic_auth is now available for use for this purpose
• Secured Registry users will now require the authorization policy to retrieve the swagger so we may use it to validate which version of
• Registry is in use for feature enablement
• Moved all Security controls in config.py to a common area at the foot of the file
• Removed auth_type from security.service_login as it is now redundant
• Added controls to handle certificate checking behavior which has become more strict in recently versions of Python3, ssl_verify and check_hostname are now handled
• security.set_service_auth_token now has an explicit flag for ssl host checking as well
• Fix oversight where improved model serialisation logic was not correctly applied to Registry
• Removed unusused parameter refresh from parameters.update_parameter_context
• Reduced unecessary complexity in utils.dump with no change in functionality
• Updated client gen mustache templates to reflect refactored security and api client code
• Minor linting and docstring and codestyle improvements
• Set pyUp to ignore Watchdog as it must stay between versions to statisfy py2 and py3 compatibility
• If Client is not instantiated, optimistically instantiate for version checking
• add socks proxy support

0.16.3 (2021-10-11)

Removed force reset of configuration.password and configuration.username to empty string. This was not increasing security, and was causing unexpected errors for users connecting to multiple services in a single script.

Add greedy control to versioning.get_registry_bucket and versioning.get_flow_in_bucket to avoid undesirable partial string match.

• Update readme to reflect switch from ‘master’ branch naming to ‘main’.
• Update tox to pin testing to Python 3.8, as Python 3.9 is producing unexpected and unrelated SSL failures
• Minor lint formatting improvements

0.16.2 (2021-02-10)

NOTE: If you are using secured Registry, this release will enforce access controls for the swagger interface which is used to determine which version of Registry is connected in order to correctly provide features - you may have to update your authorizations

• Update requirements.txt to unpin future and lxml
• Update lxml to 4.6.2 or newer to resolve vulnerability
• Pin watchdog to <1.0.0 per their docs to maintain Python2.7 compatibility
• Revert 0.14.3 changes to Authentication handling which introduced basicAuth support but resulted in some NiFi connections appearing incorrectly as Anonymous
• Added simpler basicAuth control to force it via a config switch without changing tokenAuth and other Authorization header behavior during normal usage
• nipyapi.config.global_force_basic_auth is now available for use for this purpose
• Secured Registry users will now require the authorization policy to retrieve the swagger so we may use it to validate which version of
• Registry is in use for feature enablement
• Moved all Security controls in config.py to a common area at the foot of the file
• Removed auth_type from security.service_login as it is now redundant
• Added controls to handle certificate checking behavior which has become more strict in recently versions of Python3, ssl_verify and check_hostname are now handled
• security.set_service_auth_token now has an explicit flag for ssl host checking as well
• Fix oversight where improved model serialisation logic was not correctly applied to Registry
• Removed unusused parameter refresh from parameters.update_parameter_context
• Reduced unecessary complexity in utils.dump with no change in functionality
• Updated client gen mustache templates to reflect refactored security and api client code
• Minor linting and docstring and codestyle improvements
• Set pyUp to ignore Watchdog as it must stay between versions to statisfy py2 and py3 compatibility
• If Client is not instantiated, optimistically instantiate for version checking
• add socks proxy support

0.15.0 (2020-11-06)

Updated NiFi client and helpers to 1.12.1, Registry client to 0.7.0

Release to include new fixes and features in baseline, work continues on improving different Authentication methods

• Added new Parameter contexts API to docs
• Resolved bug where funnel position did not honour requested location (thanks @geocali)
• Fixed issue where users expected exact search by default but some functions were silently using greedy search (thanks @razdob15)
• Change deploy_template to use floats for deployment instead of int (thanks @bgeisberger)
• Fixed creation of empty user groups (thanks @razdob15)

0.14.0 (2019-11-06)

Updated NiFi client and helpers to 1.10.0

0.13.3 (2019-10-09)

Updated NiFi-Registry client for 0.5.0

Several Issues closed as bugfixes

Many canvas operations sped-up through refactoring of recursive code to fast iterators

0.13.0 (2019-04-22)

Updated NiFi client for 1.9.1

Major rework of security.py to handle TLS and BasicAuth scenarios

Major rework for test_security.py to cover Issues and common use cases

Update ‘set_endpoint’ to easily handle TLS and BasicAuth scenarios if https is set

• Add default BasicAuth params to config
• Add default ‘safe chars’ to config for URL encoding bypass where ‘/’ is in a string
• Add ‘bypass_slash_encoding’ to utils.py to simplify conditionally allowing ‘/’ in a string
• Update Docker compose files for Secure and tox-full environments to latest NiFi versions
• Add global test controls to top of conftest for default, security, and regression test modes
• Add fixtures to conftest for user and usergroup testing in secure scenarios
• Update fixtures to better handle mixed secure and insecure test environments

0.12.0 (2018-12-20)

Updated NiFi client for 1.8.0

Updated NiFi-Registry client for 0.3.0

Added Controller Service Management (experimental)

Added Connections Management (experimental)

New Project Logo! Kindly provided by KDoran

Fixed several bugs around how the special root Process Group is handled when listing all Project Groups for various methods

• Various backwards compatibility improvements for handling calls going back to NiFi-1.1.2
• Various speedups for NiFi-1.7+ using descendants functionality to recurse the canvas
• Ability for various methods to specify a Process Group to use as the parent instead of always using root
• Better username/password handling in security.py and config.py
• Support for global ssl_verify squashing in config.py
• Added swagger for 1.8.0 to project resources against potential future validation requirements
• Added versioned deployment convenience functions for finding sensitive and invalid processors, should make it easier to update properties when importing to a new canvas
• Added summary options to several calls to return simple objects suitable for quick processing rather than full objects that need to be parsed
• Added utils.infer_object_label_from_class to make it easier to create connections between objects
• Updated compound methods like delete_process_group to also handle connections and controllers elegantly if requested
• Various codestyle and testing improvements

0.11.0 (2018-10-12)

Added steps to fdlc demo to show sensitive and invalid processor testing and behavior during deployment

Added list_sensitive_processors and list_invalid_processors to nipyapi.canvas

Added simple caching capability for certain calls to nipyapi.config

Added placeholder tests for new functionality against next refactoring and integration run

Missing assertion test in get_process_group_status

deprecated use of tests_require setup.py as current best-practice

Update ruamel.yaml to support Python 3.7 with passing tests

Added test for docker image already present to avoid excessive downloading

Added option to recurse from a given pg_id, rather than always from root, to several canvas functions

Added default verify_ssl and ssl error squashing to config for user convenience

Added filter option to specify whether exact or greedy matching should be used, still greedy by default

Added hard logout when changing endpoint to ensure tokens are refreshed

Updated tests

updating travis to build all branches

Fix travis for Python 3.7 testing support

Fix edge case in delete process group where templates stop the revision from being refreshed

Fixed test case to decode string correctly in old python versions

Fixed race condition in test where not all processors started before test executes

bugfix for missing status value in Processor DTO

Updating pylint to ignore import errors on standard packages

added logging to docker image control

Bump version: 0.10.3 → 0.11.0

Install requirements reset

0.10.3 (2018-08-28)

Minor bugfix for versioning/deploy_flow_version to resolve additional edge case for version number type

0.10.2 (2018-08-27)

BugFix for Issue #66 in security/get_access_policy_for_resource where NiFi Api is not expecting a resource_id to be submitted

0.10.1 (2018-08-21)

Minor bugfix for versioning/deploy_flow_version where version number should be a str instead of int

0.10.0 (2018-08-03)

Updated NiFi client for 1.7.1 release

Updated NiFi-Registry client for 0.2.0 release

Key Changes

• Reworked NiFi-Registry pytest setup to support multiple versions
• Changed schedule_processor to use component. rather than status. tests as they are more reliable
• Swtiched Docker configs to use explicit versions instead of latest for more consistent behavior across environents

Version Changes

• Deprecated testing against NiFi-1.5.0 due to host headers issue - recommend users to upgrade to at least NiFi-1.6.0
• Deprecated testing against NiFi-1.4.0 as superfluous
• Added testing for NiFi-1.7.1 and NiFi-Registry-0.2.0

0.9.1 (2018-05-18)

Updated Demos for 0.9 release

New Features

• Added a new demo for Flow Development LifeCycle which illustrates the steps a user might automate to promote Versioned Flows between NiFi environments
• Check out nipyapi.demo.fdlc to see more details

0.9.0 (2018-05-16)

Updated NiFi client to 1.6.0 release

Potentially Breaking Changes

Users should check the updated documentation and ensure their tests pass as expected

• Several NiFi client API calls were inconsistently CamelCase’d and have been renamed in the upstream NiFi release, I have honoured those changes in this release. If you use them please check your function names if you get an error

New Features

• Added functionality to Deploy a versioned flow to the canvas. This was an oversight from the 0.8.0 release. Function is creatively named ./versioning/deploy_flow_version

Other Notes

• Updated the Issue Template to also ask how urgent the problem is so we can priortise work
• Where possible we have switched to using the Apache maintained Docker containers rather than our own, there should be no impact to this unless you were relying on some edge part of our test compose files

0.8.0 (2018-03-06)

Introducing Secured environment support, vastly expanded Versioning support including import/export.

Fixed Templates, better documentation, more demos, and NiFi version backtesting.

Potentially Breaking Changes

Users should check the updated documentation and ensure their tests pass as expected

• Import/Export of Flow Versions was reworked significantly and renamed to correct bugs and remove coding complications and be generally more obvious in its behavior
• Template upload/download reworked significantly to remove direct reliance on requests and correct bugs in some environments
• Reworked many list/get functions to be more standardised as we stabilise the approaches to certain tasks. This should not change again in future
• Standardised bad user submission on AssertionError, bad API submission errors on ValueError, and general API errors on ApiException. This standard should flow forwards
• Switched ruamel.yaml from >15 to <15 as advised in the project documentation, as >15 is not considered production ready

Known Issues

• Python2 environments with older versions of openssl may run into errors like ‘SSLV3_ALERT_HANDSHAKE_FAILURE’ when working in secured environments. This is not a NiPyApi bug, it’s a problem with py2/openssl which is fixed by either upgrading openssl or moving to Python3 like you know you should

New Features

• Added support for working with secured NiFi environments, contributed by KevDoran

  • Added demo compatibility between secured_connection and console to produce a rich secured and version-controlled demo environment
  • Added many secured environment convenience functions to security.py
  • Integrated tokenAuth support throughout the low-level clients

• Added simple Docker deployment support in utils module for test, demo, and development
• Standardised all documentation on more readable docstrings and rst templates across the entire codebase
• Significantly expanded versioning support, users should consult the refreshed documentation
• Added experimental support for cleaning queues, process_groups, and setting scheduling of various components
• Many calls now have an auto-refresh before action option to simplify applying changes
• Implemented short and long wait controls for relevant functions to allow more deterministic changes
• Implemented generic object-list-filtering-for-a-string-in-a-field for many response get/list types
• Standardised many responses to conform to a common response contract: None for none, object for single, and list-of-objects for many
• Implemented import/export to json/yaml in versioning
• Added regression/backtesting for many functions going back through major release versions to NiFi-1.1.2. More details will be obvious from reading tests/conftest.py
• Test suites now more reliably clean up after themselves when executed on long-running environments
• Apparently logging is popular, so standard Python logging is now included

Other notes

• Various low-level SDK bugfixes corrected in the swagger spec and updated in the provided client
• Enhanced Template and Flow Versioning to handle significantly more complex flows
• Significantly enhanced testing fixtures
• Refactored several common functions to utils.py, and moved several common configurations to config.py
• versioning.get_flow will now export the raw Registry object for convenience when serialising flows
• Significantly improved Py2/Py3 compatibility handling, and import management within the package
• Removed docs dependency on M2R by converting everything over to reStructuredText

0.7.0 (2018-01-30)

• Updated project to support NiFi-1.5.0 and NiFi-Registry-0.1.0
• Merged api clients into main codebase, deprecated external client requirement
• Created centralised project configuration and test configuration
• Updated automated test environment to consistent docker for local and Travis
• Removed procedurally generated boilerplate stub tests to improve readability
• Moved pytest fixtures into conftest and expanded dramatically
• Added limited support for processor and process group scheduling
• Added support for all common Nifi-Registry calls
• Added a demo package to provide an interactive test and demo console
• Significant readme, contribution, and other documentation refresh
• Expanded CRUD support for most processor, process group and related tasks

0.6.1 (2018-01-04)

• Added requested functions to find and list Processors on the canvas
• Fixed list all process groups to include the root special case properly

0.6.0 (2017-12-31)

• Refactored many functions to use native NiFi datatypes instead of generics
• Standardised several call names for consistency
• Updated examples
• Created additional tests and enhanced existing to capture several exceptions

0.5.1 (2017-12-07)

• Added template import/export with working xml parsing and tests
• Added a ton of testing and validation steps
• Cleared many todos out of code by either implementing or moving to todo doc

0.5.0 (2017-12-06)

• migrated swagger_client to separate repo to allow independent versions
• refactored wrapper Classes to simpler functions instead
• cleaned up documentation and project administrivia to support the split

0.4.0 (2017-10-29)

• Added wrapper functions for many common Template commands (templates.py)
• Added new functions for common Process Groups commands (canvas.py)
• Significant test framework enhancements for wrapper functions
• Many coding style cleanups in preparation for filling out test suite
• Added linting
• Cleaned up docs layout and placement within project
• Integrated with TravisCI
• Dropped Python2.6 testing (wasn’t listed as supported anyway)
• Updated examples and Readme to be more informative

0.3.2 (2017-09-04)

• Fixed bug where tox failing locally due to coveralls expecting travis
• Fixed bug where TravisCI failing due to incorrectly set install requirements
• Fixed bug where swagger_client not importing as expected

0.3.1 (2017-09-04)

• Fixed imports and requirements for wheel install from PyPi

0.3.0 (2017-09-04)

• Created basic wrapper structure for future development
• Added simple usage functions to complete todo task
• Added devnotes, updated usage, and various sundry other documentation cleanups
• Split tests into subfolders for better management and clarity
• Added Coveralls and License Badge
• Removed broken venv that ended up in project directory, added similar to ignore file
• Changed default URL in the configuration to default docker url and port on localhost

0.2.1 (2017-08-26)

• Fixed up removal of leftover swagger client dependencies

0.2.0 (2017-08-25)

• Merge the nifi swagger client into this repo as a sub package

  • Restructured tests into package subfolders
  • Consolidate package configuration
  • Setup package import structure
  • Updated usage instructions
  • Integrate documentation

0.1.2 (2017-08-24)

• Created basic integration with nifi-python-swagger-client

0.1.1 (2017-08-24)

• Cleaned up base project and integrations ready for code migration

0.1.0 (2017-08-24)

• First release on PyPI.

Indices and tables

• Index
• Search Page